 | Directory Structure |
The kit directory hierarchy is structured as below:
Base folderPath | Description |
|---|---|
Assets/ | |
Documentation/ | Sandcastle source files for the documentation. |
Mods/ | Sample mods. |
Tools/ | Compile-time XLua tools. |
Documentation.chm | Offline version of this documentation. |
Assets folderPath | Description |
|---|---|
Demos | Demos for the kit. |
Extra | Specialized systems. |
Cards | Scripts for creating playing-card games. |
Grids | A custom grid system with Square, Isometric and Hexagonal modes. |
Weapons | A (modular) weapon/projectile system. |
Prefabs | |
UI/General | Common UI elements that you can just drag-&-drop into your game. |
Scripts/Kit | Kit-specific code. |
Behaviours | MonoBehaviours for all occasions. |
Containers | Collections and data containers. |
Stats | Stat system. |
Json | Json utilities. |
Helpers | Helper functions, algorithms and extension methods. |
Algorithms | Implementations of common algorithms. |
Extensions | Extension methods to ease development. |
Methods | Helper function library. |
Patterns | Design patterns. |
Managers | Global managers. |
Resource loading, unloading, caching, reading, saving, and parsing. | |
UI and window management system. | |
Fade in/out screens or load scenes with it. | |
Play & pool sounds and group them into AudioSources. Handle music. | |
Spawn/de-spawn and pool particle effects. | |
Save/load device-specific app-wide settings. | |
Modding | The modding system. |
Loaders | Handlers for loading mods of different file-types. |
Managers | Core modding system classes. |
Parsers | Handlers for parsing different types of files from mods and ResourceManager. |
Scripting | Support for executing Lua scripts from mods. |
UI | Code for a pre-written Window to manage mods in-game. |
UI | |
Behaviours | Common MonoBehaviours for UI elements. |
Buttons | General functionalities for buttons. |
General | Most frequent UI elements. |
Layout | Scripts for UI layouts. |
Message | A pre-made Window for showing general game messages. |
Widgets | More UI elements. |
Utilities | |
In-game Lua Console brought up with tilde (~). | |
GameObject pooling and grouping. | |
Scripts/Game | Your game code. |
Data | Classes for game data. |
DataManager | Manager for handling game state and data. |
GameData | POCO object to load game data into. |
GameState | POCO object to load game state into. |
UI | Game UI. |
Menu | Main menu code. |
Settings | Settings window code. |
Splash | Splash screen code. |
Plugins | |
References to .NET assemblies. |
See Also