[Gem workflow] Adding a Gem to Project solution?

Question

Hi,
So I am easily able to create a Gem, but I am slightly confused about the recommended workflow surrounding the intended use of Gems.

My specific question is, how is it intended we work on a Gem in Visual Studio?

I have, created and compiled a project which generates the solution, now if I am creating a Gem, shouldn't MyGem have a Visual Studio Project that is added to MyProject Solution? One does not seem to be generated automatically, in *dev/Solutions/MyProject_vc140.depproj*, or anywhere else.

Am I supposed to create a project for MyGem and add it to MyProject Solution? Or am I supposed to create a Solution just for MyGem, independent from MyProject Solution?

I'm unfamiliar with this new workflow, and all the tutorials I've found have people working on Entity Components directly in the Project Solution without using a Gem, which seems to be more of the old workflow.

This seems like something which is overlooked in the documentation, at least that I have read so far.

Any information is appreciated!

Regards,
Uriah

Accepted Answer

Create a gem using the Project Configurator by selecting "Enable Gems" on a project, doesnt matter which one, then "Create a new Gem" in the top left corner of that page and follow the wizard.

Next, enable the gem that you created on the project that is set as default, this is important as it wont show up in the VS project if it's enabled on a non default project.

After that, "lmbr_waf.bat configure msvs". This will configure the build environment and create both the gem's project solution and the giant project solution that houses all of the other solutions.

Finally, it should show up in the LumberyardSDK_vc<120/140>.sln or in the LumberyardSDK_vc<120/140>.depproj folder within the Solutions folder.

If using the LumberyardSDK_vc<120/140>.sln, it should show up under the "Gems" subfolder.

Answer

I believe so.

Answer

Hi @REDACTEDUSER

Thanks for the reply!

So that is all I was missing. Now if I compile the LumberyardSDK I can work on my Gem project in that solution, yet indepenedent from MyProject solution, which can use the Gem like any other. Am I understanding that correctly?

[Gem workflow] Adding a Gem to Project solution?

Relevant content