Repository Layout

Repository Layout

This page aims to document the purpose of different branches and the main file structure.

Branches

master - Stable version
(Note: there is no stable version right now so this branch has no code)

dev - Active development branch

media - Hosts demo gifs/images and Discord + Steam assets

File structure (dev branch)

.
|   .gitattributes          - Makes GitHub not count library files when calculating the language breakdown
|   .gitignore              - Ignore many unneeded files (builds, debug data, etc.)
|   codeanalysis.ruleset    - Rules for code analysis in VS
|   FallingSandSurvival.sln - The VS 2017 solution file
|   README.md               - The main readme
|   setup.sh                - The script for setting up the repo and libraries
|   SETUP.txt               - File explaining how to set up the repo
|
\---FallingSandSurvival
    |   .editorconfig                   - Makes VS maintain some consistent formatting
    |   conanfile.txt                   - Lets VS download & set up most of the libraries automatically using Conan
    |   FallingSandSurvival.vcxproj     - The sole project file in the VS solution
    |   steam_appid.txt                 - File so Steam knows what game this is
    |   (The main code in many .hpp and .cpp files)
    |
    +---assets
    |   |   title.txt   - ASCII art that prints out in the console
    |   |   (A few random .png files)
    |   |
    |   +---audio
    |   |   |   title.ptcop - The pxtone Collage file for the splash screen jingle
    |   |   |
    |   |   \---fmod
    |   |       |   project.fspro   - The FMOD project file
    |   |       |
    |   |       +---Assets
    |   |       |       (Audio asset files for the FMOD project)
    |   |       |
    |   |       \---Build
    |   |           \---Desktop
    |   |                   Master.bank         - The built FMOD project
    |   |                   Master.strings.bank - The built FMOD project
    |   |
    |   +---backgrounds
    |   |       (Assets for backgrounds)
    |   |
    |   +---fonts
    |   |       (Font files)
    |   |
    |   +---logo
    |   |       (Logo files)
    |   |
    |   +---objects
    |   |       (Assets for items or rigidbodies)
    |   |
    |   +---textures
    |   |       (Textures for materials)
    |   |
    |   \---title
    |           (Splash screen assets)
    |
    +---data
    |   \---shaders
    |           (GLSL shader files)
    |
    \---lib
            README.md   - File explaining some info about the libraries