Latest version:
Tramway SDK 0.0.9
Github
Quick links
Home
Get Started

Structure of a project

Your project files are located in your project directory. It also contains several other directories. This is how these are structured and where everything is located.

/assets/

Currently there are no tools which use this particular directory, but there will be in the future.

The assets directory is meant to shadow the structure of the data directory, with the main difference that the data files are stored in an editable format. For example, the assets directory could contain /assets/models/frogs/green.blend file and it would have its counterpart /data/models/frogs/green.dymdl which is prepared from the first file.

/data/

This is the main data directory. It contains the directories for various resources, as well as language files, editor settings and entity definition files (might be moved in the future) and the material definition files.

/data/animations/

This directory contains the all of the Animation resources.

/data/audio/

This directory contains the all of the Sound resources.

/data/models/

This directory contains the all of the 3D model resources.

/data/navmesh/

This directory contains the all of the Navhmeshes.

/data/paths/

This directory contains the all of the Paths.

/data/sprites/

This directory contains the all of the Sprite resources.

/data/textures/

This directory contains the all of the textures for the Material resources.

/data/sprites/

This directory contains the all of the WorldCells.

/scripts/

This directory contains all of the scripts. When the Script system is initialized with a scripting language initialized, it will load the api file, which contains the language-specific script bindings.

For Lua, this is the api.lua file. You probably should avoid editing it, unless you know what you are doing.

There is also an init file. This is loaded by the template project after initializing all of the framework's systems. You can edit this file and put whatever you want in it.

/shaders/

This directory contains all of the shaders for the rendering backends that support shaders. You can edit them if you want.

/src/

Contains all of the C++ source code for the project.

/

The project root directory contains the executable file for the application, as well as various configuration files. This is also the working directory from which the various tools and utilities need to be launched from.