Add 'Structure'

2021-06-30 23:32:17 +00:00
parent e2fb55d110
commit 76c52710d4

16
Structure.md Normal file

@ -0,0 +1,16 @@
The project itself is broken up into multiple files.
The root of the project contains some meta-info about Snoot Game (Licensing, .gitignore, and other nerd shit)
The game folder itself has multiple files
audio/ - Contains audio assets
gui/ - Contains GUI assets
images/ - Contains all image assets that aren't used in the GUI. Sorted by character and purpose.
script/ - Contrains individual chapter script files. Introduced Patchy-Patch5.
tl/ - Translations and other text assets
gui.rpy - Script for handling the GUI options
options.rpy - Options and settings for the projects
screens.rpy - Actually where gui handling and screens are managed. Go here if you want to make a custom screen.
script.rpy - the file that renpy calls first and is mostly used to define some custom variables, characters, transitions, etc. Before Patchy-Patch5, this one file contained ALL of the game's script.
storyline.rpy - Handles the game's story line and is called by script.rpy. Iterates through all of the order the game goes through and manages endings.