Skip to content

kauheaa/ASMGameJam24

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Credits

Textures from ambientcg.com

Model inspiration and some textures used

--

Font VCR OSD Mono by Riciery Leal https://www.dafont.com/vcr-osd-mono.font

--

Project notes

File structure, hierarchy and asset naming

Guidelines for keeping the project organized and easy to manage.

Version control

After cloning the repository

  1. Create a branch with your name. This is the branch you'll be working on and where you push changes.
  2. Avoid making changes to the same scenes or prefabs at the same time with others.
  3. Remember to commit changes regularly to avoid massive commits. Write descriptive comments. Push the commits when you have finished something that works, and create a pull request.

Asset naming

PascalCase is used for all naming.

No spaces or hyphens on file or directory names.

Use descriptive names, in English.

Try to use full words instead of abbreviations unless the name would be super long so it's hard to see parts of it on project.

  • Only use underscores for different aspects of same thing:

    • StartButton_Active StartButton_Inactive
    • TitleBox_TopLeft, TitleBox_Top, TitleBox_TopRight
  • Use descriptive words instead of numbering:

    • StartButton_Hover instead of StartButton_2
  • Only use numbering for objects that form sequences

    • PathPoint_01, PathPoint_02, PathPoint_03...

Directory Structure

Nothing should be placed in Assets folder except subfolders. Create new folder if need be.

Assets
+---Animations
|   +---Characters
|   +---Environment
|   +---Objects
|   +---Placeholders
|   +---UI
+---Animators
|   +---Characters
|   +---Environment
|   +---Objects
|   +---UI
+---Audio
|   +---AudioClips
|   +---AudioMixers
+---Effects
|   +---ParticleEffects
|   +---ParticleMaterials
+---Prefabs
|   +---Characters
|   +---Environment
|   +---MathTasks
|   +---Objects
|   +---TestPrefabs
|   +---UI
+---Scenes
|   +---Levels
|   +---TestScenes
|   +---UI
+---Scripts
|   +---TestScripts
|   +---Math (or smth)
+---Sprites
|   +---Characters
|   +---Environment
|   +---Objects
|   +---Placeholders
|   +---UI

Hierarchy Structure

Scene

Scene
+---Camera
+---Gameplay
|   +---Characters
|   +---Objects
|   +---MathTasks
+---UI
|   +---GUI
|   +---StickerBook
+---Management
+---World
|   +---BackgroundObjects

Important

  • Use named gameObjects as scene "folders". Duplicates of same objects in scene should be found under the same "folder". All "folder" objects should be located in 0,0,0 with scale 1,1,1 and no rotation.
  • Check that everything that is added to a scene starts from location 0,0,0 with scale 1,1,1 and no rotation. Pay attention to z-index, it's rarely supposed to be other than 0.
  • Do not use object scale for resizing sprites (unless it's for animating). All objects should start from 1,1,1 scale. If you have to resize sprite in Unity, change Pixels Per Unit from import settings.

About

ASM Game Jam 2024 project Team Couple Beets (two of them)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •