add scaffolding

Signed-off-by: Jonny Galloway <[email protected]>

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.0.0] - 2023-01-19
+
+### Added:
+
+- folder stubs, \Gems, \Projects
+
+- LICENSE-CC-BY-4.0.txt
+
+### Changed:
+
+- CONTRIBUTING.md
+
+- CHANGELOG.md

CODE_OF_CONDUCT.md

@@ -2,15 +2,9 @@
 
 ## Our Pledge
 
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
 
 ## Our Standards
 
@@ -38,47 +32,34 @@ Examples of unacceptable behavior include:
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
 
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
 [email protected].
+
 All complaints will be reviewed and investigated promptly and fairly.
 
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
 
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
@@ -88,8 +69,7 @@ of actions.
 **Consequence**: A warning with consequences for continued behavior. No
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
+includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or
 permanent ban.
 
 ### 3. Temporary Ban
@@ -98,10 +78,7 @@ permanent ban.
 sustained inappropriate behavior.
 
 **Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
+communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
 
 ### 4. Permanent Ban
 
@@ -114,15 +91,11 @@ the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+This Code of Conduct is adapted from the [Contributor Covenant Homepage](https://www.contributor-covenant.org), version 2.0, available at [Contributor Covenant.](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html)
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
 
-[homepage]: https://www.contributor-covenant.org
+For answers to common questions about this code of conduct, see the FAQ at: [Contributor Covenant: Frequently Asked Questions about Contributor Covenant](https://www.contributor-covenant.org/faq)
 
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+Translations are available at: [Contributor Covenant: Contributor Covenant Translations](https://www.contributor-covenant.org/translations)

CONTRIBUTING.md

@@ -1,14 +1,62 @@
-# Contributing
+## Contribution Guidelines
 
-Welcome to the Open 3D Engine! To learn more about contributing to the [O3DE code repo](README.md), check out the [Contributor's Guide](https://github.com/o3de/community/blob/main/CONTRIBUTING.md).
+https://www.o3de.org/contribute/#contribution-guidelines
 
-The [O3DE community repo](https://github.com/o3de/community) contains information about how to get started, how the community organizes, and more.
+Before you start participating in and contributing to O3DE code such as this Gem, review our [code of conduct](https://o3de.org/docs/contributing/code-of-conduct/) . Contributing guidelines for our projects are hosted in their GitHub repositories, within the root directory in a `CONTRIBUTING.md` file.
 
-To contribute, please review our [Code of Conduct](https://github.com/o3de/o3de/blob/development/CODE_OF_CONDUCT.md) first. 
+## Contributions:
 
-## Making contributions with the Developer Certificate of Origin (DCO)
+Contributions are more than just welcome. Fork this repo and create a new branch, then submit a pull request:
 
-When contributing, your pull requests will require that you have agreed to our DCO found here: [Developer Certificate of Origin](https://developercertificate.org/).  All commits require the --signoff flag to show DCO compliance.
+1. Fork it: https://github.com/o3de/o3de-technicalart
 
-You can do this by using the -s option in git. 
-Example: ```git commit -s -m 'my commit message'```
+2. Create your feature branch `git checkout -b my-new-feature`
+
+3. Commit your changes `git commit -am 'Add some feature'`
+
+4. Push to the branch `git push origin my-new-feature`
+
+5. Create new Pull Request
+
+## Guide:
+
+### **Development branches:**
+
+- **main**: will be used for release cadence
+
+- **development**: feature development for supported release work
+
+- **prototypes**: PoCs, experimental and prototype work that is not officially supported
+
+### O3DE Modularity
+
+The o3de-technicalart repo is similar to the o3de-extras, which is another engine related collection. Gems (are reusable pieces of an o3de project, which other engines might call a plugin) can have other gems as children, and so on. Please refer to the [o3de-extras README](https://github.com/o3de/o3de-extras#readme) for more detailed information.
+
+### **Folder structure:**
+
+1 Gem per-tool.  The gist is that we want a modular structure to support teams enabling the tool integration gems for the DCC tools they specifically use.  Please adhere to an organization such as this:
+
+```
+o3de-TechlArt (repo)/
+├── Gems/
+│   ├── O3DE/
+│   │   └── StudioTools
+│   ├── DCC/
+│   │   ├── Blender
+│   │   ├── Autodesk/
+│   │   │   ├── Maya
+│   │   │   └── ...
+│   │   ├── Adobe/
+│   │   │   └── Substance3D/
+│   │   │       ├── Designer
+│   │   │       ├── Painter
+│   │   │       └── ...
+│   │   └── ...
+│   └── IDE/
+│       ├── VScode
+│       ├── WingPro
+│       └── ...
+└── Projects/
+    ├── DCC_Test_Project
+    └── ...
+```

LICENSE-CC-BY-4.0.txt

@@ -0,0 +1,4 @@
+Copyright 2022 Amazon.com, Inc. or its affiliates, all rights reserved.
+
+Documentation content excluding code, and including images, is licensed under a Creative Commons Attribution 4.0 International License, available at https://creativecommons.org/licenses/by/4.0/.
+

Projects/deleteme.txt

@@ -0,0 +1 @@
+This is meant to be deleted

README.md

@@ -1,3 +1,76 @@
 # o3de-technicalart
 
-Stub
+As the name implies, o3de-technicalart repo (TechArt) is for "Technical Art" related O3DE objects that are considered "Non-Canonical" extensions to O3DE and not "Core" to the engine.  Mainly DCC tool and workflow integrations, and python development environments for technical artists.  We refer to the extensibility of custom content tools and curated workflows as 'Studio Tools'.
+
+## O3DE Modularity
+
+The o3de-technicalart repo is similar to the o3de-extras, which is another engine related repo.  Gems (are reusable pieces of an o3de project, which other engines might call a plugin) can have other gems as children, and so on.  The TechArt repo is a collection of Gems. Please refer to the [o3de-extras README](https://github.com/o3de/o3de-extras#readme) for more detailed information.
+
+## Core, Extras TechArt or somewhere else?
+
+How do we know where to put a new object? If an object's functionality is optional (such as DCC tool integrations), this is a good indication it may not be suitable for the engine core, and more likely should be in the extras or possibly in this repo.
+
+Large objects, such as a large project with binary asset data (3D models, textures, etc) which can be many gigabytes in size, definitely are not in the core. This repo contains one or more such objects in the `\Projects` folder, and each DCC Gem may also contain it's own example and/or test assets.
+
+Extras should be the default place for new development of canonical engine features.  TechArt is suitable for work related to custom tools and workflow development that caters to technical artists and content creation.
+
+## Testing
+
+TechArt is not currently Canonical, and does not require Automated Review (AR), although it will head in that direction over time.  Merging into development at minimum currently requires multiple maintainers approving code reviews in order to accept the PR, along with some amount of robust manual test plan; some kind of local automated tests are preferred.  Merging up into main will additionally require some unit testing and automated test script (in the future the repo will evolve to use AR similar to other O3DE repos.)
+
+## Branches
+
+Just like other O3DE repos, the `main` branch is the stable release branch and is tagged for release, while the `development` branch is the cutting edge. When working on the code make a branch of development, make your changes, create your PR, run and pass AR, merge into development.
+
+Additionally, there is another branch called `prototypes`  is where experimental work like research on workflow studies or 'proof of concept' (PoC) work occurs; it is less restrictive but will still require at least one maintainer approving code reviews in order to accept the PR into this branch (this is intended to promote legitimate peer review and collaboration.)
+
+## Contribute
+
+For more general information about contributing to O3DE, visit [https://o3de.org/docs/contributing/](https://o3de.org/docs/contributing/).  There is also a CONTRIBUTING guide specific to this repo with additional guidance.
+
+## Download and Register o3de-technicalart
+
+### Clone the repository
+
+```shell
+git clone https://github.com/o3de/o3de-technicalart.git
+```
+
+For more details on setting up the engine, refer to [Setting up O3DE from GitHub](https://o3de.org/docs/welcome-guide/setup/setup-from-github/) in the documentation.
+
+### Setting up o3de-technicalart
+
+Since the TechArt repo can be cloned anywhere on your local computer, we just need to tell O3DE where to find the extra objects in this repo by registering them.  From the O3DE engine repo folder, you can register some or all extra objects using the `o3de register` command.  Since these are all optional objects, we may not need or want all the objects.
+
+
+If we want to register a particular individual object such *as a single gem* we would issue the following command:
+
+```
+scripts\o3de.bat register --gem-path <techart>/Gems/path/<gem name>
+```
+
+Or you may want to *register all the Gems*.  Since this repo follows the [standard O3DE compound repo format](https://github.com/o3de/o3de/wiki/O3DE-Standard-repo-formats) all the o3de-technicalart gems will be in the `<techart>/Gems` path. We can therefore register all the gems in the extras gems path with one command:
+
+```
+scripts\o3de.bat register --all-gems-path <techart>/Gems
+```
+
+This can be repeated for any object type (if they exist):
+
+```
+scripts\o3de.bat register --all-projects-path <techart>/Projects
+scripts\o3de.bat register --all-gems-path <techart>/Gems
+scripts\o3de.bat register --all-templates-path <techart>/Templates
+```
+
+If we registered a gem, which is a piece of a project like a plugin, and we want to use that gem in our project we would only have to tell O3DE to enable that gem for our project by using the `o3de enable-gem` command:
+
+```
+scripts\o3de.bat enable-gem --gem-name <gem name> --project-name <project name>
+```
+
+For a complete tutorial on project configuration, see [Creating Projects Using the Command Line Interface](https://o3de.org/docs/welcome-guide/create/creating-projects-using-cli/) in the documentation.
+
+## License
+
+For terms please see the LICENSE*.TXT files at the root of this distribution.

Templates/deleteme.txt

@@ -0,0 +1 @@
+This is meant to be deleted