From 8a3af49db30d96b3ebcf40fb04a431f6eaf63ed0 Mon Sep 17 00:00:00 2001 From: Mark Joshwel Date: Thu, 11 Jul 2024 16:25:59 +0800 Subject: [PATCH] docs: add readme + licences --- Documentation/Examples/reformat.png | 3 + LICENCE.0BSD | 14 +++ LICENCE.UNSPLASH | 9 ++ README.md | 162 ++++++++++++++++++++++++++++ 4 files changed, 188 insertions(+) create mode 100644 Documentation/Examples/reformat.png create mode 100644 LICENCE.0BSD create mode 100644 LICENCE.UNSPLASH create mode 100644 README.md diff --git a/Documentation/Examples/reformat.png b/Documentation/Examples/reformat.png new file mode 100644 index 0000000..d989878 --- /dev/null +++ b/Documentation/Examples/reformat.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:69cc65884ebc55ae6909dd597395b2db213f6b85cbe3eaef4b841c9c1535d0ea +size 82869 diff --git a/LICENCE.0BSD b/LICENCE.0BSD new file mode 100644 index 0000000..4e3e652 --- /dev/null +++ b/LICENCE.0BSD @@ -0,0 +1,14 @@ +BSD Zero Clause License + +Copyright (c) 2024 Mark Joshwel, Sai Puay, Ryan Lin + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. diff --git a/LICENCE.UNSPLASH b/LICENCE.UNSPLASH new file mode 100644 index 0000000..9df0ffd --- /dev/null +++ b/LICENCE.UNSPLASH @@ -0,0 +1,9 @@ +Modified Unsplash License + +Copyright (c) 2024 Mark Joshwel, Sai Puay, Ryan Lin + +Mark Joshwel, Ryan Lin, Sai Puay (the "Creators"), grant you an irrevocable, +nonexclusive, worldwide copyright license to download, copy, modify, +distribute, perform, and use original work of authorship and/or a database +(each, a "Work"), from the Creators for free, including for commercial +purposes, without permission from or attributing the Creators. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d4f3c5b --- /dev/null +++ b/README.md @@ -0,0 +1,162 @@ +

+ +

+ +# The sota staircase Monorepository + +Primary Repository: +Submission Mirror: + +| **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 | @sippy-thinks | @sai-thinks | + +- [Handbook](#handbook) + - [on 3D Modelling (Maya, Blender, ZBrush, etc.)](#on-3d-modelling-maya-blender-zbrush-etc) + - [on Graphic and UI/UX Design](#on-graphic-and-uiux-design) + - [on Game Development](#on-game-development) + - [on Game and Level Design](#on-game-and-level-design) + - [on Documentation (for All Modules)](#on-documentation-for-all-modules) + - [on Repository Syncing](#on-repository-syncing) +- [Licence and Credits](#licence-and-credits) + - [Third-party Licences](#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: + +```text +Modelling +├── Sources +│ ├── .blend +│ └── (Maya Project Directory) +│ ├── ... +│ └── workspace.mel +├── Textures +│ └── +│ ├── *.png +│ └── ... +├── Modulars +│ ├── _lowpoly +│ └── _highpoly +└── Heros + ├── _lowpoly + │ └── *.fbx + └── _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](Documents/sota%20staircase%20Brand%20Guidelines.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 + + ![example](Documentation/Examples/reformat.png) + +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](https://forge.joshwel.co/mark/sota/issues) + +### on Documentation (for All Modules) + +| Lead | kinda everyone moreso mark | +| :--: | :------------------------: | + +follow the brand guidelines at [Documents/sota staircase Brand Guidelines.pdf](Documents/sota%20staircase%20Brand%20Guidelines.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 | +| :----: | :--: | + +TODO ☆\*: .｡. o(≧▽≦)o .｡.:\*☆ + +tentative instructions: + +1. ensure your repo is up-to-date with the forge + + ```text + git push origin main + ``` + + ```text + git pull origin main + ``` + + if you have issues syncing, fix em first + +2. run the sync script + + ```text + python sync.py + ``` + + for what the script does, see the script itself: [sync.py](sync.py) + +## Licence and Credits + +Software Source Code, unless otherwise stated, is licenced under the 0BSD licence. +For more information, see [LICENCE.0BSD](LICENCE.0BSD). + +Everything else, from assets to documentation, unless otherwise stated, +is licenced under a Modified Unsplash Licence. +For more information, see [LICENCE.UNSPLASH](LICENCE.UNSPLASH). + +### 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)