{"id":18985096,"url":"https://github.com/o3de/o3de-samples-project-gems","last_synced_at":"2025-10-04T20:18:31.719Z","repository":{"id":155086248,"uuid":"580598037","full_name":"o3de/o3de-samples-project-gems","owner":"o3de","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-25T23:38:15.000Z","size":563,"stargazers_count":2,"open_issues_count":2,"forks_count":3,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-02-21T09:48:36.690Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CMake","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/o3de.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-CC-BY-4.0.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-21T00:36:47.000Z","updated_at":"2024-03-06T17:56:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"d66ffe5f-04cd-4eea-9cea-53d5adf52e12","html_url":"https://github.com/o3de/o3de-samples-project-gems","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/o3de/o3de-samples-project-gems","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/o3de%2Fo3de-samples-project-gems","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/o3de%2Fo3de-samples-project-gems/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/o3de%2Fo3de-samples-project-gems/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/o3de%2Fo3de-samples-project-gems/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/o3de","download_url":"https://codeload.github.com/o3de/o3de-samples-project-gems/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/o3de%2Fo3de-samples-project-gems/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278366713,"owners_count":25975105,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T16:24:40.168Z","updated_at":"2025-10-04T20:18:31.704Z","avatar_url":"https://github.com/o3de.png","language":"CMake","funding_links":[],"categories":[],"sub_categories":[],"readme":"# O3DE Samples Project Gems\n\n\nThis repository contains:\n\n1. A collection of O3DE Asset Gems (portable asset packages)\n2. Asset test projects in: o3de-samples-project-gems/tree/main/Projects/*\n3. (Future) A `repo.json` file containing information about this O3DE Remote Gem Repository\n4. (Future) A GitHub release folder\n   1. The gem .zip containing the gem and associated gem.json for each gem\n\n## O3DE Modularity\n\nO3DE is highly modular engine and is essentially a collection of O3DE objects. O3DE objects are things like projects and gems, this repository contains both sample asset Gems (asset collections) and sample projects for contributing and validating sample assets (generally not fully featured interactive game projects.)\n\n### Core, Canonical and Non-Canonical repos and objects\n\nThis repository is considered Non-Canonical which means unofficial, untested and not part of an official O3DE release.  Canonical means officially supported, tested and part of an official O3DE release. For more detailed information about optional non-canonical versus canonical O3DE repositories see https://github.com/o3de/o3de-extras\n\n## If you want to use these Gems in your own o3de game project\n\n### (Future) Option #1. Remote Repository, use packaged Gems with the Project Manager\n\n**!!! Skip to Option #2 !!!**\n\n**\u003cu\u003eUse of this as a remote gem repository is not yet implemented!\u003c/u\u003e**\n\nAdd this remote repository in the Project Manager using this URL:\n\n```\nhttps://raw.githubusercontent.com/AMZN-temp-user-replace-me/o3de-remote-gem-repo-demo/main\n```\n\nYou can then browse the gems in the Project Manager and add them to your Project.\n\n### Option #2.  Download and use source Gems\n\nYou can clone this repo to download the repository source, then register the local gem source folders with the engine to make available for use in a Project. This entails the same steps as a developer contributing content creation or performing other maintenance of the gem data. (see the next section below.)\n\n## If you are a developer contributing to these asset gems\n\n### Download and Install\n\nThis repository uses Git LFS for storing large binary files. You will need to create a Github personal access token to authenticate with the LFS service.\n\n#### Create a Git Personal Access Token\n\nYou will need your personal access token credentials to authenticate when you clone the repository.\n\n[Create a personal access token with the 'repo' scope.](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)\n\n#### (Recommended) Verify you have a credential manager installed to store your credentials\n\nRecent versions of Git install a credential manager to store your credentials so you don't have to put in the credentials for every request. It is highly recommended you check that you have a [credential manager installed and configured](https://github.com/microsoft/Git-Credential-Manager-Core)\n\n#### Step 1. Clone the repository\n\nYou can clone the project to any folder locally, including inside the engine folder. If you clone the repository inside an existing Git repository (e.g. o3de) you should add the project folder to the Git exclude file for the existing repository.\n\n##### Option #1 (Highly Recommended) - cloning into a folder outside the engine repository folder\n\n```shell\n# clone the project into a folder outside your engine repository folder\n\u003e git clone https://github.com/o3de/o3de-samples-project-gems.git\nCloning into 'o3de-samples-project-gems'...\n```\n\n##### Option #2 - cloning into the engine repository folder\n\n```shell\n# clone the project into a folder named 'o3de-multiplayersample' in your existing engine repository folder\n\u003e git clone https://github.com/o3de/o3de-samples-project-gems.git c:/path/to/o3de/Gems/o3de-samples-project-gems\nCloning into 'o3de-samples-project-gems'...\n\n# modify the local engine git exclude file to ignore the project folder\n\u003e echo gems\\o3de-samples-project-gems \u003e c:/path/to/o3de/.git/info/exclude\n```\n\nIf you have a Git credential helper configured, you should not be prompted for your credentials anymore.\n\n### Step 2. Register the gems with the engine\n\nYou may have already done this, these are the same steps as setting up the o3de-multiplayer sample project. But if you are adding them to your own project these are the steps to do so.\n\nMake sure your engine is registered.\n\n```batch\n:: register the gems with the engine, you only need to do this once\n\u003e C:\\path\\to\\o3de\\scripts\\o3de register --this-engine\n```\n\nMake sure your project is registered.\n\n```batch\n:: register the project with the engine, you only need to do this once\n\u003e C:\\path\\to\\o3de\\scripts\\o3de register -p C:\\path\\to\\o3de-samples-project-gems\\Projects\\BistroPBR\n```\n\nNow make sure that the source gems are registered\n\n```batch\n:: register the gems with the engine, you only need to do this once\n\u003e o3de register --all-gems-path C:\\path\\to\\o3de-samples-project-gems\\Gems\n```\n\nThe above command will recursively scan the input path, then registers all paths with gem.json files into the `~/.o3de/o3de_manifest.json`\n\nNow these Gems will be available in the Project Manager and can be added to your Project.\n\n## (Optional) o3de-samples-project-gems\\Projects\\*\n\nThis repository contains its own O3DE Game projects which utilize these sample assets.  These projects can be used by contributors to build, validate, and maintain new assets independently.\n\n```shell\n# the test projects for sample assets are in this project folder in repo\n\u003e cd C:\\path\\to\\o3de-samples-project-gems\\Project\n```\n\n### Option 1. Add Project to O3DE Project Manager\n\n1. Launch your O3DE Project Manager (o3de.exe)\n\n2. Use the blue button in the upper right labeled \"New Project ...\", and with the pulldown select \"Open Existing Project\"\n\n3. Browse to and add a sample project folder: `C:\\path\\to\\repo\\o3de-samples-project-gems\\Projects\\\u003csample project\u003e`\n\n4. You may be prompted to rebuild the project (there are other options for building as a developer)\n\n5. Launch the Editor for the project\n\n### Option 2. Add via cli and build yourself\n\nYou can use the o3de cli tools to register your project with your engine.\n\n```shell\n# change directory to the engine root folder\n\u003e cd C:\\path\\to\\your\\o3de-engine\n# register the gems with the engine, you only need to do this once\n\u003e scripts\\o3de register --project-path C:\\depot\\o3de-samples-project-gems\\Projects\\\u003csample project\u003e\n```\n\nThere are a number of ways to configure and build the engine and project ...\n\n[Configure and Build - Open 3D Engine](https://www.o3de.org/docs/user-guide/build/configure-and-build/)\n\n## Contributing to O3DE-samples-project-gems Repo\n\nAfter following all the steps above, you should be ready to start working. Once you are in the Editor, you can develop assets to be committed to the asset repo. Working with the o3de-samples-project-gems repo is a similar workflow to the o3de codebase, the general git contributor guide is here for reference: https://docs.o3de.org/docs/contributing/to-code/git-workflow/\n\nThe main O3DE contributor guide is here:\n\n[Contribute to Open 3D Engine - Open 3D Engine](https://www.o3de.org/contribute/#contribution-guidelines)\n\nAnd the CONTRIBUTING guide for this asset repo has additional information regarding best practices for developing and contributing assets such as 3D models, texture images and materials, characters and animations, etc.:\n\n[o3de-samples-project-gems/CONTRIBUTING.md](https://github.com/o3de/o3de-samples-project-gems/blob/main/CONTRIBUTING.md)\n\n# Appendix\n\nHow these Asset Gems were made with O3DE:\n\n1. The Gems were created from the [O3DE AssetGem Template](https://github.com/o3de/o3de/tree/development/Templates/AssetGem)\n\n2. Then the `gem.json` (metadata) was manually updated per-gem in a text editor to customize the information to display when browsing and viewing the Gems from the O3DE project manager.\n\n```batch\ncd c:\\path\\to\\o3de\\\nscripts\\o3de create-gem --gem-path C:\\path\\to\\o3de-samples-project-gems\\Gems\\my_gem --template-path C:\\path\\to\\o3de\\Templates\\AssetGem\n```\n\n## License\n\nFor terms please see the LICENSE*.TXT file at the root of this distribution.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fo3de%2Fo3de-samples-project-gems","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fo3de%2Fo3de-samples-project-gems","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fo3de%2Fo3de-samples-project-gems/lists"}