The sota staircase Monorepository

Primary Repository: https://forge.joshwel.co/mark/sota
Submission Mirror: https://github.com/markjoshwel/sota

Name	Primary Role	Secondary Role	Forge	GitHub
mark	creative and technical director	senior programmer	@mark	@markjoshwel
ryan	programmer	generalist	@ryan	@sc0rch-thinks
sai	lead 3d artist	quality checker	@sai-thinks	@sippy-thinks

• Handbook
  • on 3D Modelling (Maya, Blender, ZBrush, etc.)
  • on Graphic and UI/UX Design
  • on Game Development
  • on Game and Level Design
  • on Documentation (for All Modules)
  • on Repository Syncing
• Licence and Credits
  • Third-party Licences

Handbook

on 3D Modelling (Maya, Blender, ZBrush, etc.)

Lead	Sai

design-as-in-modelling your assets with modularity in mind, anything that can be modular should be modular

design-as-in-look should be checked with the group

structure your files similarly:

Modelling
├── Sources
│   ├── <Asset Name>.blend
│   └── <Asset Name> (Maya Project Directory)
│       ├── ...
│       └── workspace.mel
├── Textures
│   └── <Asset Name>
│       ├── *.png
│       └── ...
├── Modulars
│   ├── <Asset Name>_lowpoly
│   └── <Asset Name>_highpoly
└── Heros
    ├── <Asset Name>_lowpoly
    │   └── *.fbx
    └── <Asset Name>_highpoly

on Graphic and UI/UX Design

Lead	Mark

if it involves the brand: follow the brand guidelines at Documents/sota staircase Brand Guidelines.pdf

and then send it to mark for approval (●'◡'●)

anything that can be saved locally (including figma files, btw) should be saved locally, and then pushed to the forge under Design/

organise as you wish but make sure it's logical

on Game Development

Lead	Mark

1. make changes

2. make sure the language checker isn't nagging you
   (spelling and grammatical errors)

3. make sure intellisense isn't nagging you
   (variable/class naming conventions, etc.)

4. reformat using rider's Reformat and Cleanup Code function, using the Built-in: Full Cleanup profile

   

5. push to the forge, or branch off and make a pull request if there's conflicts

on Game and Level Design

Lead	kinda everyone moreso mark

this just discuss with the group; either through the telegram group or through an issue on the forge

on Documentation (for All Modules)

Lead	kinda everyone moreso mark

follow the brand guidelines at Documents/sota staircase Brand Guidelines.pdf

source files (.docx, .fig, etc) should be in the respective modules' directory, and then exported as .pdfs to Documentation/*.pdf

on Repository Syncing

Wizard	Mark

instructions:

python sync.py

if it screams at you, fix them

if it breaks, refer to the resident "wizard"

for what the script does, see the script itself: sync.py

Licence and Credits

"NP resources" hereby refers to resources provided by Ngee Ann Polytechnic (NP) for the development of the project

1. software source code

   software source code, unless otherwise stated, is licenced under the 0bsd licence. for more information, see LICENCE.0BSD

   considering how much youtube tutorials were used on ryans end, i doubt we extenstively used NP resources

2. models made with "extensive use of NP resources":

   specifically coming from, or in part have had the following software and/or services involved:

   • Autodesk Maya
   • Adobe Substance 3D
     • Substance 3D Modeler
     • Substance 3D Sampler
     • Substance 3D Designer
     • Substance 3D Painter
     • Substance 3D Stager
     • Substance 3D Assets

   would be all rights reserved, unless otherwise stated

   (i mean mr q said this already lol)

   the only exception to this is if the model was made in blender, and doesn't touch substance painter, in which it falls under the modified unsplash licence noted below

3. whatever's left

   everything else, from assets to documentation, unless otherwise stated, is licenced under a modified unsplash licence. for more information, see LICENCE.UNSPLASH

   disclaimer: the creative lead (mark) has been using adobe software even before enrolling into np, so whether or not it's "extensive use" is fair game lol

   (also yea i don't really have a better example than my eae portfolio oops)

Third-party Licences

Exceptions to the above licences are as follows:

Template:

- `path/to/file`: (Asset/Work Name) by (Author Name)  
  (Licence Name)

Example:

• Game/Assets/Character/Frogman: Frogman by Frog Creator
  Standard Unity Asset Store EULA (Extension Asset)