Creating a New Project

Project Creation

The rakefile to create a new project is in Usagi/Templates.

1. Create a directory where you wish to create your new project

2. Either check-out Usagi to this directory or add it as a submodule to a repository created in that directory
   The engine should always be placed in a folder named 'Usagi' (case sensitive)

3. In a command terminal go the following:

cd Usagi\Templates
rake project=<<NameOfProject>>

The project name should not include any spaces.

You will now have a blank project which includes all of the necessary files to create a game. It even has an empty mode called ModeGame which you can use to start development.

To build the game first right-click on the ProjectGenerator solution and select 'Build'.
Then set the project which matches NameOfProject as the default startup project (by right clicking and selecting 'Set as Startup Project') and run.

ModeGame inherits from usg::SystemsMode which handles set-up of the ECS systems. Modes which do not use the systems (such as menus and title screens) should inherit directly from usg::Mode instead.
Modes using 2D rendering will also likely only need a single RenderTarget rather than having an instance of usg::PostFX.

Components which you want your scene root to include are merged in with Data\Entities\Root.yml (the default assumes a ModelMgrComponent and PhysicsScene).