o3de-multiplayersample-assets

O3DE MultiPlayerSample Assets

This repository contains:

1. A collection of O3DE Asset Gems, used in o3de-multiplayersample project
   1. The source folder for each Gem, for development by Contributors.
   2. e.g. a gem for sample characters: https://github.com/o3de/o3de-multiplayersample-assets/Gems/character_mps
2. (Future) A repo.json file containing information about this O3DE Remote Gem Repository
3. (Future) A GitHub release folder
   1. The gem .zip containing the gem and associated gem.json for each gem

If you are using o3de-multiplayer-sample Game

These gems are required for and utilized by the o3de-multiplayer sample project, you can find the repo and instructions for that project and adding these gems here:

GitHub - o3de/o3de-multiplayersample: Multiplayer sample project for the Open 3D Engine

If you want to use these Gems in your own o3de game project

(Future) Option #1. Remote Repository, use packaged Gems with the Project Manager

!!! Skip to Option #2 !!!

Use of this as a remote gem repository is not yet implemented!

Add this remote repository in the Project Manager using this URL:

https://raw.githubusercontent.com/AMZN-temp-user-replace-me/o3de-remote-gem-repo-demo/main

You can then browse the gems in the Project Manager and add them to your Project.

Option #2.  Download and use source Gems

You can clone the 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.)

If you are a developer contributing to these asset gems

Download and Install

This 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.

Create a Git Personal Access Token

You will need your personal access token credentials to authenticate when you clone the repository.

Create a personal access token with the 'repo' scope.

(Recommended) Verify you have a credential manager installed to store your credentials

Recent 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

Step 1. Clone the repository

You can clone the project to any folder locally, including inside the engine folder. If you clone the project inside an existing Git repository (e.g. o3de) you should add the project folder to the Git exclude file for the existing repository.ne-the-repository)

Option #1 (Highly Recommended) - cloning into a folder outside the engine repository folder

# clone the project into a folder outside your engine repository folder
> git clone https://github.com/o3de/o3de-multiplayersample-assets.git
Cloning into 'o3de-multiplayersample-assets'...

Option #2 - cloning into the engine repository folder

# clone the project into a folder named 'o3de-multiplayersample' in your existing engine repository folder
> git clone https://github.com/o3de/o3de-multiplayersample-assets.git c:/path/to/o3de/o3de-multiplayersample-assets
Cloning into 'o3de-multiplayersample'...

# modify the local engine git exclude file to ignore the project folder
> echo o3de-multiplayersample-assets > c:/path/to/o3de/.git/info/exclude

If you have a Git credential helper configured, you should not be prompted for your credentials anymore.

Step 2. Register the gems with the engine

You 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.

Make sure your engine is registered.

:: register the gems with the engine, you only need to do this once
> c:\path\to\o3de\scripts\o3de register --this-engine

Make sure your project is registered.

:: register the project with the engine, you only need to do this once
> c:\path\to\o3de\scripts\o3de register -p c:/path\to\o3de-multiplayersample

Now make sure that the source gems are registered

:: register the gems with the engine, you only need to do this once
> o3de register --all-gems-path c:\path\to\o3de-multiplayersample-assets\Gems

 The above command will recursively scan the input path, then registers all paths with gem.json files into the ~/.o3de/o3de_manifest.json

Now these Gems will be available in the Project Manager and can be added to your Project.

(Optional) MPS: Asset Test Project

This repository contains it's own O3DE Game project, which can be used by contributors to build, validate, and maintain new assets independently.

# the test project for mps assets, is in this project folder in repo
> cd C:\path\to\o3de-multiplayersample-assets\Project

Option 1. Add Project to O3DE Project Manager

1. Launch your O3DE Project Manager (o3de.exe)

2. Use the blue button in the upper right labeled "New Project ...", and with the pulldown select "Open Existing Project"

3. Browse to and add the MPS Asset Test Project folder: C:\path\to\repo\o3de-multiplayersample-assets\Project

4. You may be prompted to rebuild the project (there are other options for building as a developer)

5. Launch the Editor for the project

Option 2. Add via cli and build yourself

You can use the o3de cli tools to register your project with your engine.

# change directory to the egine root folder
> cd c:\path\to\your\o3de-engine
# register the gems with the engine, you only need to do this once
> scripts\o3de register --project-path C:\depot\o3de-multiplayersample-assets\Project

There are a number of ways to configure and build the engine and project ...

Configure and Build - Open 3D Engine

As a developer, I often find it useful to build in an engine-centric way

# change directory to the egine root folder
> cd c:\path\to\your\o3de-engine
# create a build folder
> mkdir build
> cd build
# configure cmake and create sollutiuon
> cmake .. -G "Visual Studio 16" -A x64 -DLY_3RDPARTY_PATH="%LY_3RDPARTY_PATH%" -DLY_UNITY_BUILD=OFF -DLY_PROJECTS="C:\path\to\repo\o3de-multiplayersample-assets\Project"

This should generate a build\O3DE.sln file, which can be opened in Visual Studio 2019 and compiled.

Don't forget to build the project in Profile

Building the Editor project will build with all dependencies.

The built binary executables will be in:

# bin folder
> cd C:\depot\o3de-dev\build\bin\profile\
# executbales
# C:\depot\o3de-dev\build\bin\profile\o3de.exe
# C:\depot\o3de-dev\build\bin\profile\editor.exe
# ...

If this is the project you are primarily working with, you can also set it as the "default project".

# change directory to the egine root folder
> cd c:\path\to\your\o3de-engine
# register the gems with the engine, you only need to do this once
> scripts\o3de set-global-project -pp <project-path>

This will make this the project that launches by default if you manually directly double-click on a o3de executable like editor.exe

Appendix

After the gems are registered and added to a project, you can validate they are operational via the Asset Processor

How these Asset Gems were made with O3DE.

1. The Gems were created from the Asset Gem template

2. Then the gem.json (metadata) was manually updated per-gem

   cd c:\path\to\o3de\
   scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\props_mps --template-path C:\o3de\Templates\AssetGem
   scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\level_art_mps --template-path C:\o3de\Templates\AssetGem
   scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\character_mps --template-path C:\o3de\Templates\AssetGem
   scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\landscape_mps --template-path C:\o3de\Templates\AssetGem
   scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\pbr_material_pack_mps --template-path C:\o3de\Templates\AssetGem
   scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\particlefx_mps --template-path C:\o3de\Templates\AssetGem
   scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\kb3d_mps --template-path C:\o3de\Templates\AssetGem