mark/sota
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: grammar

Browse source
This commit is contained in:
Mark Joshwel 2024-07-14 18:11:37 +08:00
parent 1c44f4c99f
commit f572cef7b3
1 changed files with 38 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -1,14 +1,14 @@
<p align="center" width="100%"> <p align="center" width="100%">
<img width="50%" src="Design/Exports/ss-logo-alt-horizontal-bordered-on_dark.svg"> <img width="50%" src="Design/Exports/ss-logo-alt-horizontal-bordered-on_dark.svg" alt="sota staircase Horizontal Logo">
</p> </p>
# The sota staircase Monorepository # The sota staircase Mono-repository
Primary Repository: <https://forge.joshwel.co/mark/sota> Primary Repository: <https://forge.joshwel.co/mark/sota>
Submission Mirror: <https://github.com/markjoshwel/sota> Submission Mirror: <https://github.com/markjoshwel/sota>
| **Name** | **Primary Role** | **Secondary Role** | **Forge** | **GitHub** | | **Name** | **Primary Role** | **Secondary Role** | **Forge** | **GitHub** |
|:--------:|:-------------------------------:|:------------------:|:-------------:|:--------------:| |:--------:|:-------------------------------:|:------------------:|:-----------:|:--------------:|
| mark | creative and technical director | senior programmer | @mark | @markjoshwel | | mark | creative and technical director | senior programmer | @mark | @markjoshwel |
| ryan | programmer | generalist | @ryan | @sc0rch-thinks | | ryan | programmer | generalist | @ryan | @sc0rch-thinks |
| sai | lead 3d artist | quality checker | @sai-thinks | @sippy-thinks | | sai | lead 3d artist | quality checker | @sai-thinks | @sippy-thinks |
@ -28,7 +28,7 @@ Submission Mirror: <https://github.com/markjoshwel/sota>
### on 3D Modelling (Maya, Blender, ZBrush, etc.) ### on 3D Modelling (Maya, Blender, ZBrush, etc.)
| Lead | Sai | | Lead | Sai |
| :--: | :--: | |:----:|:---:|
design-as-in-modelling your assets with modularity in mind, anything that can design-as-in-modelling your assets with modularity in mind, anything that can
be modular should be modular be modular should be modular
@ -51,7 +51,7 @@ Modelling
├── Modulars ├── Modulars
│ ├── <Asset Name>_lowpoly │ ├── <Asset Name>_lowpoly
│ └── <Asset Name>_highpoly │ └── <Asset Name>_highpoly
└── Heros └── Heroes
├── <Asset Name>_lowpoly ├── <Asset Name>_lowpoly
│ └── *.fbx │ └── *.fbx
└── <Asset Name>_highpoly └── <Asset Name>_highpoly
@ -60,9 +60,10 @@ Modelling
### on Graphic and UI/UX Design ### on Graphic and UI/UX Design
| Lead | Mark | | Lead | Mark |
| :--: | :--: | |:----:|:----:|
if it involves the brand: follow the brand guidelines at [Documents/sota staircase Brand Guidelines.pdf](Documents/sota%20staircase%20Brand%20Guidelines.pdf) if it involves the brand:
follow the brand guidelines at [Documentation/sota staircase Brand Guidelines.pdf](Documentation/sota%20staircase%20Brand%20Guidelines.pdf)
and then send it to mark for approval (●'◡'●) and then send it to mark for approval (●'◡'●)
@ -74,7 +75,7 @@ organise as you wish but make sure it's logical
### on Game Development ### on Game Development
| Lead | Mark | | Lead | Mark |
| :--: | :--: | |:----:|:----:|
1. make changes 1. make changes
@ -89,35 +90,35 @@ organise as you wish but make sure it's logical
![example](Documentation/Examples/reformat.png) ![example](Documentation/Examples/reformat.png)
5. push **to the forge**, or branch off and make a pull request if there's conflicts 5. push **to the forge**, or branch off and make a pull request if there are conflicts
### on Game and Level Design ### on Game and Level Design
| Lead | kinda everyone moreso mark | | Lead | kinda everyone more so mark |
| :--: | :------------------------: | |:----:|:---------------------------:|
this just discuss with the group; either through the telegram group or through an issue for 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 [the forge](https://forge.joshwel.co/mark/sota/issues)
### on Documentation (for All Modules) ### on Documentation (for All Modules)
| Lead | kinda everyone moreso mark | | Lead | kinda everyone more so mark |
| :--: | :------------------------: | |:----:|:---------------------------:|
follow the brand guidelines at [Documents/sota staircase Brand Guidelines.pdf](Documents/sota%20staircase%20Brand%20Guidelines.pdf) follow the brand guidelines at [Documentation/sota staircase Brand Guidelines.pdf](Documentation/sota%20staircase%20Brand%20Guidelines.pdf)
source files (.docx, .fig, etc) should be in the respective modules' directory, source files (.docx, .fig, etc.) should be in the respective modules' directory,
and then exported as .pdfs to `Documentation/*.pdf` and then exported as .pdfs to `Documentation/*.pdf`
### on Repository Syncing ### on Repository Syncing
| Wizard | Mark | | Wizard | Mark |
| :----: | :--: | |:------:|:----:|
instructions: instructions:
```text ```text
python sync.py python restepper.py
``` ```
if it screams at you, fix them if it screams at you, fix them
@ -133,11 +134,11 @@ development of the project
1. software source code 1. software source code
software source code, unless otherwise stated, is licenced under the 0bsd licence. software source code, unless otherwise stated, is licenced under the 0BSD licence.
for more information, see [LICENCE.0BSD](LICENCE.0BSD) for more information, see [LICENCE.0BSD](LICENCE.0BSD)
considering how much youtube tutorials were used on ryans end, considering how many YouTube tutorials were used on ryan's end,
i doubt we extenstively used NP resources I doubt we extensively used NP resources
2. models made with ["extensive use of NP resources"](https://www.np.edu.sg/student_ip): 2. models made with ["extensive use of NP resources"](https://www.np.edu.sg/student_ip):
@ -157,11 +158,11 @@ development of the project
(_i mean mr q said this already lol_) (_i mean mr q said this already lol_)
the only exception to this is if the model was made in blender, and doesn't 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 touch substance painter, in which it falls under the modified unsplash licence
noted below noted below
3. whatever's left 3. whatever is left
everything else, from assets to documentation, unless otherwise stated, everything else, from assets to documentation, unless otherwise stated,
is licenced under a modified unsplash licence. is licenced under a modified unsplash licence.
@ -169,20 +170,22 @@ development of the project
**disclaimer**: the creative lead (mark) has been using adobe software even **disclaimer**: the creative lead (mark) has been using adobe software even
[before enrolling into np](https://github.com/markjoshwel/portfolio-eae/blob/main/public/assets/skill-adobe.png), [before enrolling into np](https://github.com/markjoshwel/portfolio-eae/blob/main/public/assets/skill-adobe.png),
so whether or not it's "extensive use" is fair game lol so whether it's "extensive use" is fair game lol
(_also yea i don't really have a better example than my eae portfolio oops_) (_also yea I don't really have a better example than my eae portfolio oops_)
### Third-party Licences ### Third-party Licences
Exceptions to the above licences are as follows: exceptions to the above licences are as follows:
> Template: > Template:
> ``` > ```
> - `path/to/file`: (Asset/Work Name) by (Author Name) > - (Asset/Work Name) by (Author Name): (Licence Name)
> (Licence Name) > `directory path, file path or glob pattern`
> ``` > ```
> Example: > Example:
> >
> - `Game/Assets/Character/Frogman`: Frogman by Frog Creator > - Frogman by Frog Creator: Standard Unity Asset Store EULA (Extension Asset)
> Standard Unity Asset Store EULA (Extension Asset) > `Assets/Characters/Frogman`
>
> comma-separate multiple licences, and use code blocks if you need to list multiple files/directories/patterns