Skip to content
nullquery edited this page Nov 13, 2014 · 2 revisions

Welcome to the SS99 wiki!

The SS99 project is split up into the following folders:

  • coding for all DM code.
  • icons for all DMI icons.
  • sounds for all sound files.
  • graphics for all graphics (non-DMI graphics)

The only exception to the above rule is that a module may have any type of file in its relative path. This is to keep required files for modules together and to encourage a relative path convention (where the module references its files relative to the module folder rather than the root of the project, to promote refactoring and utilizing modules in other projects).

The SS99 project is split up into the following components:

  • core contains the core mechanics for the project. These MUST be included or it won't compile.
  • core/modules contains core modules. These MUST be included or it won't compile (but given that they're modular you may find it easier to work around them).
  • game contains the specific code for the game. These MAY be deleted allowing a restart from scratch using the core as a framework to build a game with.
  • game/modules contains game modules. These may or may not be required when compiling, generally everything in coding/game is considered flexible.
  • modules contains additional modules. These MUST be optional, removing a module should not still allow the project to compile (albeit naturally with some functionality removed).

The folders described above MUST be split up into components described above.

Clone this wiki locally