Added more pages (#554)

Update docs
This commit is contained in:
MegaMech 2024-01-20 20:19:41 -07:00 committed by GitHub
parent 1c2b95f383
commit 1b9a6f4e24
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 109 additions and 2 deletions

View File

@ -128,7 +128,37 @@ p {
</a>
</div>
<div class="pagebutton">
<a class="pagea" href="vehicles.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Vehicles</div>
<div class="pagedescription">
<p>Trains, boats, cars, trucks, and more.</p>
</div>
</div>
</div>
</a>
</div>
<div class="pagebutton">
<a class="pagea" href="items.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Items</div>
<div class="pagedescription">
<p>Item Pickups</p>
</div>
</div>
</div>
</a>
</div>
\endhtmlonly
\subpage actors
\subpage objects
\subpage vehicles
\subpage items

View File

@ -59,6 +59,13 @@ Racing segment loads after selecting a grand prix. Note that it is always reload
# Code Breakdown
## Menus
|file|desc|
|---|---|
|menus.c | Menu related code |
|save.c| Save related |
|data/startup_logo.inc.c|Startup logo|
## Players
Player related code resides in
|file|desc|
@ -72,6 +79,7 @@ Actor related code resides in
|---|---|
|actors.c|Variety of [actors](actorsmenu.html), see link for specifics.|
|actors_extended.c|Shells and bananas|
|code_80005FD0.c| Vehicles; trains, cars, trucks, boats |
## Objects
Object related code resides in
@ -108,6 +116,7 @@ Course related code resides in
|file|desc|
|---|---|
|collision.c| |
|code_80005FD0| Pathing code |
## Math
Math related code resides in

1
docs/basics/items.md Normal file
View File

@ -0,0 +1 @@
\page items Items

View File

@ -1,5 +1,5 @@
\page terminology Terminology
#### Definitions
# Technical Definitions
* `Jump/Branch/Function` - Tells the cpu to execute instructions somewhere else and come back here when done.
* `Hexadecimal` - A [numbering system](https://en.wikipedia.org/wiki/Hexadecimal). Similar numbering sytems include decimal (also called base-ten) and roman numerals.
* Easy method for programmers and computers to understand each other which groups/separates bytes of information in a readable format.
@ -12,4 +12,10 @@
* Max value slightly lower than unsigned due to a bit being used to set whether negative or positive.
* Google "Two's complement" for an indepth technical explanation.
* `f32/float` - A positive or negative value containing a decimals such as `5.0f` or `5.1f` or `5.148282f`
* `f64/double` - A positive or negative value of high-precision. Ex. `5.5784298538832` (many decimals).
* `f64/double` - A positive or negative value of high-precision. Ex. `5.5784298538832` (many decimals).
# Racing Terminology
* `Light Tree` - The tree of lights that Lakitu carries; red, orange, green, etc. Tells the racers when to start racing.
* Called a Christmas tree in drag racing.
* `Staging` - Align the racecars with the starting line.
* `Start Sequence` - The light tree activates, going from red to orange to green (Colours and number of lights may differ between different types of races).

18
docs/basics/vehicles.md Normal file
View File

@ -0,0 +1,18 @@
\page vehicles Vehicles
[TOC]
See vehicles.h for defines and other configurable options. This includes how many of each vehicle to spawn.
The game evenly disperses vehicles around their path even when spawning extra vehicles.
# Trains
* Follows a path containing only an x and z coordinate.
* Y coordinate is hard-coded.
* Some of the train path is generated to save space.
# Cars & Trucks
# Boats

1
docs/tutorials/audio.md Normal file
View File

@ -0,0 +1 @@
\page tutorialaudio Audio

12
docs/tutorials/paths.md Normal file
View File

@ -0,0 +1,12 @@
\page paths Paths
The game uses multiple types of course paths
# Course Paths
Used by courses
# Horizontal Paths (no Y coordinate)
Used by the train
# Camera Rails
Pathing for the camera during end of race scene, podium ceremony, and credits.

View File

@ -96,6 +96,36 @@ p {
</a>
</div>
<div class="pagebutton">
<a class="pagea" href="paths.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Paths</div>
<div class="pagedescription">
<p>Overview of the many types of pathing</p>
</div>
</div>
</div>
</a>
</div>
<div class="pagebutton">
<a class="pagea" href="audio.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Audio</div>
<div class="pagedescription">
<p>Basic ways to work with audio</p>
</div>
</div>
</div>
</a>
</div>
\endhtmlonly
\subpage boostramps
\subpage paths
\subpage tutorialaudio