Skip to content

Project layout

BigETI edited this page Mar 4, 2021 · 1 revision

This page will contain information about the project layout of this game.

For now this page is empty and more information will be available in the future.

All assets for this game are available inside the ./Assets/ directory.

The ./Assets/ directory contains the ScribblersPad module, which is the highest level module that contains the most of the important assets for this game.

Music and sound effects

Music and sound effects are located at ./Assets/ScribblersPad/Audios/ in their respective directories.

Animations

Animations are available at ./Assets/ScribblersPad/Animations/ and end with the .anim file extension. Each animation set are in their respective directories.

Animator controllers

Animator controllers describe animation state machines that control the Unity Animator. They are located at ./Assets/ScribblersPad/AnimatorControllers/.

Audio translations

String translations contain translations for sound effects and music used in-game. They are located at ./Assets/ScribblersPad/AudioTranslations/.

Materials

Materials describe the surface of an object, how they should be rendered in a scene. They are located at ./Assets/ScribblersPad/Materials/.

Prefabricated objects

Prefabricated objects are used to quickly instantiate objects in a scene. They can inherited from other prefabricated objects, and contain other prefabricated objects as children. They are located at ./Assets/ScribblersPad/Prefabs/.

Renderer data

Renderer data just contains data for the renderer used in this game. They are located at ./Assets/ScribblersPad/RendererData/.

Resources

Assets in resources can be enumerated in runtime, so anything that should be loaded dynamically in-game, should be available in the resources directory. They are located at ./Assets/ScribblersPad/Resources/.

Scenes

Scenes are split up into menus and game. They are located at ./Assets/ScribblersPad/Scenes/.

Scripts

This is the heart of the game where most of the game logic resides. They are split up into abstract classes, controller classes, data classes, delegates, enumerators, interfaces, manager classes, regular or miscellaneous classes, scriptable object classes, static classes and trigger classes. They are located at ./Assets/ScribblersPad/Scripts/.

Shader Graphs

Shader Graphs describe various shaders used in the game. They are located at ./Assets/ScribblersPad/ShaderGraphs/.

Sprite translations

String translations contain translations for sprites used in-game. They are located at ./Assets/ScribblersPad/SpriteTranslations/.

String translations

String translations contain translations for strings used in-game. They are located at ./Assets/ScribblersPad/StringTranslations/.

Textures

Textures are image files used for materials. They are located at ./Assets/ScribblersPad/Textures/.

Universal Render Pipeline assets

Universal Render Pipeline assets or URP assets are important for the Universal Render Pipeline, which is used in this game. They are located at ./Assets/ScribblersPad/UniversalRenderPipelineAssets/.

Post-processing volume profiles

Post-processing volume profiles are used to describe post processing effects in scenes. They are located at ./Assets/ScribblersPad/VolumeProfiles/.