4 Structure
Mappening edited this page 2022-11-18 19:26:04 +00:00

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.

the src folder contains code custom to Snoot Game

  • cg_gallery.rpy - Self explanatory. This gallery is custom made and does not use Renpy's gallery system, because as the person who wrote it would say, "It's stupid"
  • credits.rpy - Generates a displayable containing the credits text in plain text so that it is easily editable
  • definitions.rpy - Contains (almost) all image definitions. If you're developing something and need to define images in another spot for convenience, that's fine, but be sure to put them in THIS file eventually so that is is at least marginally organized.
  • extra_chapters_menu.rpy - Defines the bonus chapters menu
  • gallery_data_set.json - Contains what images to display in the gallery
  • mod_menu.rpy - Self explanatory
  • splashscreen.rpy - contains a label to go to the startup splashscreen, and what happens on first-time launch.
  • translation.rpy - Handles the translation buttons and startup screen