Courses
+
+
+ Some course related stuff
+
@@ -156,9 +75,9 @@ p {
-\endhtmlonly
+@endhtmlonly
-\subpage actors
-\subpage objects
-\subpage vehicles
-\subpage items
+@subpage actors
+@subpage objects
+@subpage vehicles
+@subpage items
diff --git a/docs/basics/BUILD_WINDOWS.md b/docs/basics/BUILD_WINDOWS.md
index 88236bcad1..cb7fdafe88 100644
--- a/docs/basics/BUILD_WINDOWS.md
+++ b/docs/basics/BUILD_WINDOWS.md
@@ -1,4 +1,4 @@
-\page buildwindows Compiling for Windows
+@page buildwindows Compiling for Windows
## Compiling mk64 Decomp In Windows
***This method is not recommended nor supported. However, it is the only solution to build in W7/W8. WSL is the path of least resistance, use that not this***
diff --git a/docs/basics/basicconcepts.md b/docs/basics/basicconcepts.md
index 0b9254fa3e..f5b2d555b7 100644
--- a/docs/basics/basicconcepts.md
+++ b/docs/basics/basicconcepts.md
@@ -14,7 +14,7 @@ Computers use addresses to jump through code. This works similar to a house numb
A typical N64 address: `0x80160158`
In an N64 program, addresses begin at `0x80000000`. As you create code, data, and the like, the compiler will add onto this base number and assign variables to an address.
-```
+```c
s32 a = 2; // 0x80000004
s32 b = 7; // 0x80000008
s32 c = 5; // 0x8000000C
@@ -22,7 +22,7 @@ s32 d = 1; // 0x80000010
s32 e = 3; // 0x80000014
```
Replacing a variable with a hard-coded address grabs the value at that address.
-```
+```c
print(0x80000004); // or
print(a);
```
@@ -40,7 +40,7 @@ Texture a_texture[] = {
};
```
The address of this could extend from `0x80000100` to `0x800000534`. However, you would not see data begin at `0x80000533`. The compiler generally aligns objects to 4, 8, 0xC, or 0x10. With the exception being when you're working with s16 and s8. If you have:
-```
+```c
s16 a = 3; // Value compiled to 0x0003
s32 b = 5; // Value compiled to 0x00000005
```
@@ -52,7 +52,7 @@ The compiler aligned `b` to the nearest 0x4. If there were two s16's then the bl
# How Errors Happen
The maximum value of an s8 (0x00) is 0xFF or 255. `0xFF + 1 = 0x100` imagine this scenario:
-```
+```c
s8 a = 1;
s8 b = 2;
s8 c = 3;
diff --git a/docs/basics/compiling.md b/docs/basics/compiling.md
index c6fa24a7a0..59ade96da7 100644
--- a/docs/basics/compiling.md
+++ b/docs/basics/compiling.md
@@ -11,13 +11,13 @@ The build system has the following package requirements:
To add submodules run `git submodule update --init --recursive` after cloning.
# Linux
-```
+```bash
sudo apt install build-essential pkg-config git binutils-mips-linux-gnu python3 zlib1g-dev libaudiofile-dev libcapstone-dev
```
### Arch
-```
+```bash
sudo pacman -S base-devel capstone python
```
Install the following AUR package:
@@ -34,7 +34,7 @@ Not recommended. Use WSL unless this is your only option.
# macOS
Install [Homebrew](https://brew.sh), then install the following dependencies:
-```
+```bash
brew update
brew install python3 capstone coreutils make pkg-config tehzz/n64-dev/mips64-elf-binutils
```
@@ -44,19 +44,19 @@ Build using `gmake` ensuring homebrew `make` is used instead of the old macOS sy
# Docker
Build the Docker image:
-```
+```bash
docker build -t mk64 .
```
When building and using other tools, append the following in front of every command you run:
```bash
-docker run --rm -v ${PWD}:/mk64 mk64
+docker run --rm -v .:/mk64 mk64
```
For example:
```bash
-docker run --rm -v ${PWD}:/mk64 mk64 make -C tools
-docker run --rm -v ${PWD}:/mk64 mk64 make
+docker run --rm -v .:/mk64 mk64 make -C tools
+docker run --rm -v .:/mk64 mk64 make
```
# Building US
@@ -78,16 +78,16 @@ mk64 decomp supports two EU versions
* EU 1.1 `eu-final`
Build using
-```
+```bash
make -j VERSION=eu-1.0
```
or
-```
+```bash
make -j VERSION=eu-final
```
First-diff/diff commands for EU
-```
+```bash
python3 first-diff.py --eu
./diff + * [idle](@ref thread1_idle), [video](@ref thread3_video), [audio](@ref thread4_audio), [game loop](@ref thread5_game_loop)
+* [game loop](@ref thread5_game_loop):
+ * [audio](@ref thread4_audio)
+ * [jumpTo a specific menu or race based on a gameState flag.](@ref update_gamestate)
+ * [profiler](@ref profiler_log_thread5_time)
+ * [config_gfx_pool](@ref config_gfx_pool)
+ * [read_controllers](@ref read_controllers)
+ * [game_state_handler](@ref game_state_handler)
+ * [endDL/vsync](@ref display_and_vsync)
+ * [game_state_handler](@ref game_state_handler):
+ * switch([gGamestate](@ref gGamestate))
+ * [menus](@ref update_menus) -> switch([menu](@ref gMenuSelection)) { // do menu stuff }
+ * [race_logic_loop](@ref race_logic_loop) -> spaghetti
+ * [podium_ceremony](@ref podium_ceremony_loop)
+ * [credits](@ref credits_loop)
+* [video](@ref thread3_video):
handles interaction between video/audio threads. handles vblanking and some elements pertaining to framebuffer most of all, handles which step of rendering a frame the cpu is in. Checks when new to start new sp tasks -``` + + If mk64 is in a menu state it will branch off to the menu code, running relevant bits of code based on more flags such as which particular menu the user is in. This will loop until the state changes to a different one such as race mode. If mk64 is in a race state, then race related code is ran and it spaghetti's off into a wide series of branches. This may include concepts such as `isLinedUp, isRacing, isRaceFinished, gotoNextCourse, isHuman, and isAI`. This relatively primitive design could be defined as a state machine from an abstract point of view. This would differ from an OOP design that uses objects and hierarchy. You will become very familiar with this design principle as you explore the code-base. During any step of the game loop, a switch can be setup to check a flag then run code relevant to the situation. For instance, a flag can check whether a race is in-progress or complete. If in-progress set the player to human controlled. If complete, set player to AI controlled. # Segments -mk64 code is split into three sections +mk64 code is split into three sections for now. |Segment|desc| |---|---| -|Main|Menus, audio, libultra, rsp| -|Racing|Memory management, courses, players, actors, skybox, collision, math | -|Ending|Podium ceremony, credits| +|Main|[Menus](@ref menus.c), [audio](@ref audio), [libultra](@ref PR), rsp (include in libultra)| +|Racing|[Memory management](@ref memory.c), [courses](@ref render_courses.c), [players](player_controller.c), [actors](@ref actors.c), [skybox](@ref skybox_and_splitscreen.c), [collision](@ref collision.c), [math](@ref math_util.c) | +|Ending|[Podium ceremony](@ref ending), [credits](@ref credits.c)| Racing segment loads after selecting a grand prix. Note that it is always reloaded preventing randomization of cpu's at the start of the first race due to no time for the random seed to actually become random. @@ -62,32 +65,32 @@ Racing segment loads after selecting a grand prix. Note that it is always reload ## Menus |file|desc| |---|---| -|menus.c | Menu related code | -|save.c| Save related | -|data/startup_logo.inc.c|Startup logo| +|[menus](@ref menus.c)| Menu related code | +|[save](@ref save.c)| Save related | +|[startup_logo](@ref data/startup_logo.inc.c)|Startup logo| ## Players Player related code resides in |file|desc| |---|---| -|player_controller.c| Applies physics to players | -|camera.c| Player cameras | +|[player_controller](@ref player_controller.c)| Applies physics to players | +|[camera](@ref camera.c)| Player cameras | ## Actors Actor related code resides in |file|desc| |---|---| -|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 | +|[actors](@ref actors.c)|Variety of [actors](actorsmenu.html), see link for specifics.| +|[actors_extended](@ref actors_extended.c)|Shells and bananas| +|[code_80005FD0](@ref code_80005FD0.c)| Vehicles; trains, cars, trucks, boats | ## Objects Object related code resides in |file|desc| |---|---| -|code_80057C60.c|Objects| -|code_80071F00.c|Objects| -|code_80086E70.c|Objects| +|[code_80057C60](@ref code_80057C60.c)|Objects| +|[code_80071F00](@ref code_80071F00.c)|Objects| +|[code_80086E70](@ref code_80086E70.c)|Objects| Documentation of the specifics still in-progress. See [actors](actorsmenu.html) for more information. @@ -95,11 +98,12 @@ Documentation of the specifics still in-progress. See [actors](actorsmenu.html) Course related code resides in |file|desc| |---|---| -|memory.c| Loads and extracts course data| -|render_courses.c|Renders course content| -|common_textures.inc.c|Content accessible to every course such as items and portraits| +|[memory](@ref memory.c)| Loads and extracts course data| +|[render_courses](@ref render_courses.c)|Renders course content| +|[common_textures](@ref common_textures.inc.c)|Content accessible to every course such as items and portraits| ### Course Folder +[course folder link][@ref courses] |file|desc| |---|---| |courses/course_name/course_data.inc.c|Course data| @@ -110,25 +114,25 @@ Course related code resides in ## UI & Other 2D Screen data |file|desc| |---|---| -|hud_renderer.c|ItemWindows| +|[hud_renderer](@ref hud_renderer.c)|ItemWindows| ## Engine |file|desc| |---|---| -|collision.c| | -|code_80005FD0| Pathing code | +|[collision](@ref collision.c)| | +|[code_80005FD0](@ref code_80005FD0.c)| Pathing code | ## Math Math related code resides in |file|desc| |---|---| -|math_util.c| | -|math_util_2.c| | +|[math_util](@ref math_util.c)| | +|[math_util_2](@ref math_util_2.c)| | ## Ending |file|desc| |---|---| -|ceremony_and_credits.c|Camera rails for podium ceremony and credits| -|podium_ceremony_actors.c|Fireworks and balloons for podium ceremony| -|ceremony_data.inc.c|Trophies and podium models. Paths.| -|credits.c|Credits text and UI positions| +|[ceremony_and_credits](@ref ceremony_and_credits.c)|Camera rails for podium ceremony and credits| +|[podium_ceremony_actors](@ref podium_ceremony_actors.c)|Fireworks and balloons for podium ceremony| +|[ceremony_data](@ref ceremony_data.inc.c)|Trophies and podium models. Paths.| +|[credits](@ref credits.c)|Credits text and UI positions| diff --git a/docs/basics/items.md b/docs/basics/items.md deleted file mode 100644 index 3467925630..0000000000 --- a/docs/basics/items.md +++ /dev/null @@ -1 +0,0 @@ -\page items Items diff --git a/docs/basics/objects.md b/docs/basics/objects.md deleted file mode 100644 index 58e62b9ab9..0000000000 --- a/docs/basics/objects.md +++ /dev/null @@ -1,2 +0,0 @@ -\page objects -# Objects diff --git a/docs/basics/terminology.md b/docs/basics/terminology.md index 5dab7295b8..a4f8e15d22 100644 --- a/docs/basics/terminology.md +++ b/docs/basics/terminology.md @@ -1,4 +1,4 @@ -\page terminology Terminology +@page terminology Terminology # 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. diff --git a/docs/basics/basicsmenu.md b/docs/basicsmenu.md similarity index 54% rename from docs/basics/basicsmenu.md rename to docs/basicsmenu.md index 8de0916b56..af397d70be 100644 --- a/docs/basics/basicsmenu.md +++ b/docs/basicsmenu.md @@ -1,86 +1,9 @@ -\page basics Understanding the Basics +@page basics Understanding the Basics -\htmlonly +@htmlonly Essential skills and concepts to help you get started with mk64 decomp.
-
@@ -141,10 +64,10 @@ p {
-\endhtmlonly
+@endhtmlonly
-\subpage compiling
-\subpage concepts
-\subpage controlflow
-\subpage terminology
-\subpage buildwindows
+@subpage compiling
+@subpage concepts
+@subpage controlflow
+@subpage terminology
+@subpage buildwindows
diff --git a/docs/basics/courses.md b/docs/courses/courses.md
similarity index 100%
rename from docs/basics/courses.md
rename to docs/courses/courses.md
diff --git a/docs/basics/surfacetypes.md b/docs/courses/surfacetypes.md
similarity index 92%
rename from docs/basics/surfacetypes.md
rename to docs/courses/surfacetypes.md
index 8cfef23aa4..67203e16c5 100644
--- a/docs/basics/surfacetypes.md
+++ b/docs/courses/surfacetypes.md
@@ -1,6 +1,8 @@
-\page surfacetypes Surface Types
+@page surfacetypes Surface Types
-Surfaces produce effects, driven on sounds, and other behaviour. Note that surface type is not generally used for out of bounds behaviour. As such, out of bounds areas may use any combination of surface types or flags.
+Surfaces produce effects, driven on sounds, and other behaviour. Note that surface type is not generally used for out of bounds behaviour. As such, out of bounds areas may use any combination of surface types or flags.
+
+extract from [SURFACE_TYPE](@ref SURFACE_TYPE)
| id | Name | Desc | Courses |
|---|---|---|---|
diff --git a/docs/coursesmenu.md b/docs/coursesmenu.md
new file mode 100644
index 0000000000..7fc654e9c1
--- /dev/null
+++ b/docs/coursesmenu.md
@@ -0,0 +1,41 @@
+@page coursesmenu Courses
+
+@htmlonly
+
+How courses work in mk64
++ +
+
+
+
+
+
+
+@endhtmlonly
+
+@subpage courses
+@subpage surfacetypes
+
diff --git a/docs/basics/coursesmenu.md b/docs/docs.css
similarity index 58%
rename from docs/basics/coursesmenu.md
rename to docs/docs.css
index f6aceca715..f09179e9ce 100644
--- a/docs/basics/coursesmenu.md
+++ b/docs/docs.css
@@ -1,53 +1,54 @@
-\page coursesmenu Courses
-
-\htmlonly
-
-How courses work in mk64
-
+ 
+
+
+
+
+- - - - - - - -\endhtmlonly - -\subpage courses -\subpage surfacetypes +html.dark-mode .clipboard { + fill: white; +} diff --git a/docs/header.html b/docs/header.html new file mode 100644 index 0000000000..1daffbae60 --- /dev/null +++ b/docs/header.html @@ -0,0 +1,84 @@ + + + + + + + + +