Commit Graph

672 Commits

Author SHA1 Message Date
MegaMech 230fe2ec1e rename camera_start_cinematic_shot (#770) 2026-07-26 22:54:33 -06:00
quarrel07 2ccda00a89 Document and (under AVOID_UB) fix the attract timer hijacking an in-flight menu fade (#769)
Vanilla bug: pressing START on the splash screen in the last moments
before the demo timeout plays the enter chime but then drops into the
demo reel with no music. The attract timer fires while the press-start
fade is still in flight and overwrites the fade target, so the fade
completes as a demo entry instead of the main menu.

Adds a @bug comment documenting it, and guards the demo arm with
is_screen_being_faded() under AVOID_UB only, so the matching build is
byte-identical (the non-AVOID_UB path is unchanged).
2026-07-26 22:17:07 -06:00
Jed Grabman 44c71a7978 Document versus rankings and finish info (#766)
* Document versus rankings and finish info

* Document race states

* variable renames
2026-07-18 16:21:51 -06:00
Jed Grabman 44fe054525 Angle conversion (#764)
* First pass on converting degrees

* Document degrees < 10

* Update most rotation values to degrees

* Simplify DEGREES usage

* A few additional DEGREES conversions

* Documentation of DEGREES function

* Use fractional degrees

Instead of using `DEGREES(15) - 9` use `DEGREES(14.95f)` to avoid mixing representations

* Cleanup / document degrees off by 1

* Update documentation of DEGREES
2026-06-13 21:36:53 -06:00
Jed Grabman 8ee86d4c78 DriftStateCounter (#763)
* Document driftStateCounter

* name update_drift_state_counter function
2026-04-17 18:11:43 -06:00
Jed Grabman bb8d234152 Spinout functions (#762)
* Document steering

* Refer to steering position, instead of steering angle

Refer to steering position instead of steering angle, to make clear that it is not the same thing as degrees.

* Change comment to block format

* Pre-spinout swerving

When you sharply move a joystick in 150CC or hit a banana, you can enter a pre-spinout state where you swerve back and forth.

This primarily documents how the swerving works, as well as updating some related function / property names
2026-04-15 19:38:48 -06:00
Jed Grabman c68b3d481f Steering (#761)
* Document steering

* Refer to steering position, instead of steering angle

Refer to steering position instead of steering angle, to make clear that it is not the same thing as degrees.

* Change comment to block format
2026-04-13 17:18:45 -06:00
Jed Grabman 3b794dcce9 Use button names (#758)
Use button names instead of bit flags
2026-03-08 21:01:24 -06:00
Jed Grabman bee9b0f764 Rollback torch (#757)
Rollback torch to commit `c9c21627b3a43969e4ecac2bbbe0dbc05a9f75d7`

Torch updates have caused a number of issues with the build process
2026-02-14 21:58:30 -07:00
coco875 362f2012d0 rename some texture (#698)
* rename some texture

* ok document drifting effect and player particle

* continue rename

* push more rename

* more documentation

* minor rename test

* continue rename texture

* continue rename

* some rename

* more rename

* other fix

* fix comment

* fix a missing I

* fix a mistake

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-12-08 09:10:45 -07:00
coco875 6839dbe4df more documentation on displaylist_packer (#749)
* more documentation on displaylist_packer

* add enum

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-12-08 09:05:52 -07:00
coco875 6647a83a29 Update kart_dma.c (#748) 2025-12-08 09:03:37 -07:00
Jed Grabman 2e7ba091bd Instant spinout bug documentation (#753) 2025-10-31 15:01:28 -06:00
Jed Grabman d3feca2536 Player bitflag attributes (#750)
* unk_044 initial documentation

* Define player.unk_044 magic values

* Turns more than 5 degrees

* Lakitu Effects

* UNK_0B6 (effect graphics) documentation

* UNK_002 documentation

* Document UNK_0DE and define magic values

* Use defined player types

* Rename `player->unk_0CA` to `lakitu_props`

* rename `player->unk_0B6` to `kart_graphics`

* Rename `player->unk_0DE` to `oobProps`

* rename `player->unk_044` to kartProps

* Formatting updates

* Use camelCase instead of snake_case for player properties

* Fix reference to wrong attribute in comment

* Rename `PRESS_A` to `THROTTLE`

Rename `PRESS_A` to `THROTTLE` to describe the Kart state, which may be slightly different than just pressing A.
2025-09-15 18:34:25 -06:00
coco875 e49fe2acfc adjust some name from pr730 (#737)
* small adjustement

* adjust some naming and other just two other in link with time trial

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-07-21 12:04:38 -06:00
Jed Grabman 4f63d1759c Document Sound Effects (#742)
* Naming sound effects

* Update sound effect names and categorize

* Add bomb effect and fix bug

* HIT_FAKE_ITEM -> EXPLOSION_CRASH

* Rename sound_effects to triggers

* Merge branch 'master' into sound_effects

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-07-21 12:04:04 -06:00
ProjectUltra75 f5caebc5de Document *.m64 sequence IDs (and also add support for custom track music) (#740)
* Document sequence IDs

* Document sequence IDs

* Document sequence IDs

* Document sequence IDs

* Document sequence IDs

* Fix function comments

* Properly identify the podium ceremony sequence; fix comments

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-07-19 17:24:43 -06:00
MegaMech bb8ac997a8 Better match for add_unused_obj_index (#734) 2025-07-19 17:07:35 -06:00
MegaMech a927b1db49 Fix alfa for find_vtx_and_set_colours() (#745)
* Update render_courses.c

* More fixes

* Fix hex values
2025-07-19 16:41:05 -06:00
MegaMech 12e6c6bf28 Revert "Fix alfa for find_vtx_and_set_colours() (#739)" (#744)
This reverts commit 6c60f5d785.
2025-07-19 10:19:40 -06:00
Jed Grabman a5526cc5bf Document effects and define magic values (#733)
* Document projection matrix function

Document function for computing a projection matrix. Used for camera and graphics.

* Fix loop index bug

Fix straightforward loop index bug introduced in last commit

* Style guide updates

Changes to match style recommendations
* Update function variables to camelCase
* Use dOxygen tags
* Use block comment

* Document math functions

* Give all functions in src\racing\math_util.c descriptive names

* Improve documentation for math_util

Improves a number of functions by giving descriptive argument names and comments

* Additional merge

* Fix style issues

update variables / parameters to use camelCase instead of snakeCase

* doxygen and other documentation

* Add doxygen documentation
* Rename mat -> mtx for consistency among matrices
* Theta -> Angle for angles
* Give some arguments more descriptive names

* Partial documentation for calculate_orientation_matrix

Documentation for when cosAxisY is 1 and observations that things break when if it does not equal 1.

* Rename functions

Renamed multiple functions for accuracy or clarity

* doxygen whitespace alignment

Improve readability of doxygen info by aligning text

* Make format check

Formatting updates suggested by make format

* Make skyboxes static

* Change function name

angle_from_coords -> get_angle_between_coords

* Math values renamed

Functions:
render_distance_squared -> distance_if_visible
mtxf_rotation_zxy_translate -> mtxf_rotate_zxy_translate

Arguments:
vecTrans -> translate

* Document many effects

Define effects for
* Braking
* Drifting
* Spinning out (driving and bananas)
* Mini turbos
* Losing at GP
* Tumbling on terrain
* CPU rubberbanding

And substitute some pre-existing defined effect names in place of bit flags

* Replace effect magic numbers with defined values

* Separate effect bit-flags into components

* Document more effects

* Rename some effects

* Replace effect bit_flags with defined values

* Formatting fixes

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-07-17 20:53:11 -06:00
MegaMech 0a27fbbba0 Revert "Document sound effects (#735)" (#741)
This reverts commit e88f33fb18.
2025-07-17 20:52:44 -06:00
Jed Grabman e88f33fb18 Document sound effects (#735)
* Naming sound effects

* Update sound effect names and categorize

* Add bomb effect and fix bug

* HIT_FAKE_ITEM -> EXPLOSION_CRASH

* Rename sound_effects to triggers

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-07-17 20:44:27 -06:00
MegaMech 6c60f5d785 Fix alfa for find_vtx_and_set_colours() (#739)
* Update render_courses.c

* More fixes
2025-07-17 13:04:29 -06:00
MegaMech b8823f12a1 Update cpu_vehicles_camera_path.c (#738) 2025-07-12 20:16:14 -06:00
coco875 e19b3b702e Update torch (#736)
* Update torch

* Update torch

* Update torch

* Update torch
2025-07-08 21:00:20 -06:00
arefdsg 4975cb2c42 Update README.md (#718)
* Update README.md

* Update README.md

* Update README.md

* Update README.md

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-06-30 13:27:42 -06:00
Jed Grabman 6b08e60fe6 Document time trial input replay system (#730)
* Document time trial input replay system

Documents how the input replay system works in time trials. This is used for
* Course ghosts (on the raceways)
* Player ghosts
* Replays

* Rename ghosts/replays and minor cleanup

Refer to staff and player ghosts in time trials as replays.
Refer to the basic replay as a "post time trial replay"
Change variable / function names to reflect terminology change

* Define replay magic values

* Rename staff_ghosts files to replays

Renames staff_ghosts files to replays, since they also deal with player ghosts and post time trial replays.

Also, changes staff_ghosts_loop -> replays_loop

* REPLAY_NOT_FRAME_COUNTER -> REPLAY_CLEAR_FRAME_COUNTER

* Add replays header and format

* Update replays.c

* Name load replay functions

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-06-28 16:36:36 -06:00
Jed Grabman 91ee36c539 Rewrite of math_util (#727)
* Document projection matrix function

Document function for computing a projection matrix. Used for camera and graphics.

* Fix loop index bug

Fix straightforward loop index bug introduced in last commit

* Style guide updates

Changes to match style recommendations
* Update function variables to camelCase
* Use dOxygen tags
* Use block comment

* Document math functions

* Give all functions in src\racing\math_util.c descriptive names

* Improve documentation for math_util

Improves a number of functions by giving descriptive argument names and comments

* Additional merge

* Fix style issues

update variables / parameters to use camelCase instead of snakeCase

* doxygen and other documentation

* Add doxygen documentation
* Rename mat -> mtx for consistency among matrices
* Theta -> Angle for angles
* Give some arguments more descriptive names

* Partial documentation for calculate_orientation_matrix

Documentation for when cosAxisY is 1 and observations that things break when if it does not equal 1.

* Rename functions

Renamed multiple functions for accuracy or clarity

* doxygen whitespace alignment

Improve readability of doxygen info by aligning text

* Make format check

Formatting updates suggested by make format

* Make skyboxes static

* Change function name

angle_from_coords -> get_angle_between_coords

* Math values renamed

Functions:
render_distance_squared -> distance_if_visible
mtxf_rotation_zxy_translate -> mtxf_rotate_zxy_translate

Arguments:
vecTrans -> translate

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-06-28 11:39:14 -06:00
coco875 d2b3217754 document vertex of player (#729)
* document vertex

* Update render_player.c
2025-06-28 11:35:02 -06:00
Oleksandr Kalko b329e813e6 Upgrade Torch to include CMake 4.0 fixes (#725)
Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-06-21 13:00:14 -06:00
ZackWeinstein d6076b5cb7 Labeling particle related code (#719)
* Labeling particle related code

* More labeling. Naming pass on what was labeled last commit

* Stick X clamped with deadzone

* Renaming TyreParticle to Particle

* Matching coco's names and renaming some already labeled to keep style consistent

* Minor extra particle labeling

* Small extra labeling. Restoring some removed newlines

* One last newline adjustment

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-06-21 12:59:32 -06:00
Jed Grabman 184f5939f2 Shiftability fix and documentation (#723)
* Shiftability fix and documentation

* Allow setting `AVOID_UB=1` directly while building
* Set `AVOID_UB` when building with DEBUG.
* Document options for enabling shiftability
* Document `make clean`

* Delete HTML file

* Update compiling.md

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-06-21 12:50:57 -06:00
Jed Grabman 3288752b47 Document projection matrix function (#722)
* Document projection matrix function

Document function for computing a projection matrix. Used for camera and graphics.

* Fix loop index bug

Fix straightforward loop index bug introduced in last commit

* Style guide updates

Changes to match style recommendations
* Update function variables to camelCase
* Use dOxygen tags
* Use block comment

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-06-21 12:15:45 -06:00
Maciek Baron ac4dfe3211 Document alpha, movement (#721)
* Document alpha, movement

* Fix typo

* Add missing ~
2025-06-21 11:56:23 -06:00
Maciek Baron 8d4fa64f5a Document functions and variables (balloons, acceleration, a button handling etc.) (#720)
* Document various functions and variables

* Fix code changes

* Rename function based on discussion

* Identify global table of player speeds

* Improve names of functions

* Label further things related to playerIndex

* Label further balloon related things

* Document further balloon related things

* Use STAR_DURATION

* Update vars

* Fix missing arg
2025-06-10 13:59:02 -06:00
coco875 c6e40bcec0 fix name introduce by the previous pr (#701)
* fix more name

* Update cpu_vehicles_camera_path.c

* more fix of name

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-05-18 14:20:05 -06:00
coco875 c6dcc84092 document greyscale math (#700)
* document greyscale math

* fix match

* Update menu_items.c

* Update menu_items.c

* Update menu_items.c

* Update menu_items.h
2025-05-18 14:19:43 -06:00
Oleksandr Kalko d7e434213f [Documentation] Update compiling for EU (#713)
#710 changed the environment variables for compiling EU roms
2025-05-12 05:32:12 -06:00
AloXado320 668523b9cf Fix progress rounding script (#711)
Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-05-11 19:16:17 -06:00
MegaMech ffa7bdf517 Update README.md (#712) 2025-05-11 19:07:42 -06:00
MegaMech 89fb420555 Match Mario Kart 64 (#709)
* Commit unpr'd matches

* fix compile

* Commit matching func_80086074

* More matches

* Fix missed labelling

* menus.c formatting

* More matches

* Match update_player_path_completion

* Formatting

* Match func_80050E34

* Match EU Audio init

* Match func_800C16E8

* Match synthesis_process_note

* Match func_80009B60

* Match

* Match cpu_use_item_strategy

* Match render_menus

* match last func
2025-05-11 18:03:50 -06:00
AloXado320 30fef62f81 Fix EU build and related cleanup and fixes (#710)
* Fix EU build and eu-final offsets

* Fix instrument align and bring EU matches

* Fix EU trig table segment

* Label audio_init

* Simplify float comments

* Proper EU name version defines
2025-05-11 18:00:37 -06:00
Revo 1f9e0d7e6a Square is a Bad Company (#708)
* square is a bad company
2025-05-08 20:26:51 -06:00
MegaMech 6d900d30ac PR Matching func_80086074 (#707)
* Commit unpr'd matches

* fix compile

* Commit matching func_80086074
2025-05-08 16:03:42 -06:00
MegaMech daab4f501f PR Matches (#706)
* Commit unpr'd matches

* fix compile
2025-05-08 15:00:53 -06:00
Rainchus 8dfb7e7fd5 move SQ macro define to header file so project builds (#705) 2025-05-02 16:52:04 -06:00
inspectredc 5dbcf42e95 Misc matches (#704)
* couple of matches

* match func_800C4FE4

* match func_800C284C

* match func_800C2A2C

* match func_800C3724

* match func_800C4398

* format

* format2

* remove asms
2025-04-30 10:36:02 -06:00
Alejandro Asenjo Nitti 1b10da7c24 fix matching (#702)
Co-authored-by: Sonic Dreamcaster <alejadro.asenjo88@gmail.com>
2025-02-16 10:49:25 -07:00
Alejandro Asenjo Nitti 809450525a match func_80099AEC and fix some warnings (#699)
* match func_80099AEC and fix some warnings
2025-01-24 11:18:03 -07:00