File Structure - GameDevWeek/CodeBase GitHub Wiki
This is a recommended file structure, to keep things clean and easy to understand. You are of course free to adapt this, as long as it helps keeping things organized (make sure to communicate these changes!).
src/main/resources/dataThe base file path. Everything in this folder will be packed into the jar during a build.dummiesA folder to put placeholder images, so they later can be easily removed. (use subfolders as shown below)entitiesParent folder for entity images and animations (create subfolders for every entity).fontsFont files (and corresponding images).jsonJSON configuration files (for entities, image lists, etc.)mapsMaps (and corresponding preview screenshots)tilesetsTilesets (and corresponding images)
musicMusic files (saved as .ogg, mono or stereo)soundsSound files (saved as .wav, mono)particlesParticle Effect files (and corresponding images)shadersShader filesuiAnything related to the user-interface.menuMenu graphicsskinsMenu skins (and corresponding images)
hudGraphics for the heads up display.
Create subfolders as you see fit.
Naming convention:
Apply the folling naming conventions to avoid problems and to keep things the same way everywhere:
- lowercase characters
- english characters and numbers only.
- separate words by underscore.
Want to see this in action?
Actually, this guideline is too fresh, so it has not been applied to any previous GDW. But the last game, Great Unicorn Massacre was using a file structure quite similar.