Commit Graph

30 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
coco875 731b24eabf Doc code 80005fd0 (#697)
* Document code_80005FD0.c
2025-01-18 17:24:09 -07:00
coco875 5e1ce53a4c the big code_80091750.c rename (#684)
* some rename

* type menu

* continue rename and place const

* Renames and doc

* more

* buffer vars

* clang format

* continue rename

* some rename and get it compile (but don't match for obscure reason)

* get it match again and fix some warning

* fix all warning

* Match 6 functions

* continue rename

* load img renames and first step or label menu items

* MenuItem struct names and some rename

* rename around

* rename code_80091750 to menu_item

* clean up a little

* Update menu_item.h

* document waypoint and more

* Revert "document waypoint and more"

This reverts commit 5e6eb4fbcc.

* apply review

* Update menu_item.c

* fix some review

* rename func_8009E620 to clear_menus

* do a rename

* apply review

* finish rename normally

* more small rename

* few fix of name

* few more fix

* minor fix

* Update menus.c

* last rename normally

* Update render_menus.s

* Update menu_items.c

* Renames seg2 textures.c

* MENU_ITEMtype --> MENU_ITEM_TYPE

* remove a useless parameter

* func_80099110 --> clear_menu_textures

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
Co-authored-by: AloXado320 <david.albujar.s.30@gmail.com>
2025-01-03 17:44:23 -07:00
coco875 8901f82f5a some rename and allow change the course engine (#691)
* some rename and allow change the course engine

* fix comment

* add more comment

* rename and change description
2024-10-20 17:24:37 -06:00
coco875 17a6f4bb3d update clang and add action (#664)
* update clang and add action

* try clang on course folder only

* forget two file

* Update course_displaylists.inc.c

* forget few other file

* Update course_vertices.inc.c

* format all code while get it match

* second pass

* format other dir

* disable clang format on bad ido code

* fix some tabulation

* revert format on tool dir

* Update clang-format.yml

* ignore gbi.h

* add some read me instruction

* fix error

* format and fixing error

* Update README.md

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2024-08-24 15:27:53 -06:00
coco875 40f677db52 Document Vehicles (#641)
* start doc collision

* fix merge

* finish rename fonction related to vehicle

* document around waypoint of vehicle

* make some modification

* make some change and rename one

* copy_ to oldPos

* doc smoke ferry and train

* some rename

* fix some renaming

* precise index

* rename a funciton

* simplify waypoint_vehicles

* change some name

* change some name

* rename move_to_point_direction

* fix some conflict

* Update code_80005FD0.c

* Update code_80005FD0.h

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2024-08-22 23:56:57 -06:00
coco875 81fe450051 fix typo src (#654)
* fix typo src

* fix non matcing

* Update code_80091750.c

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2024-08-16 15:38:16 -06:00
coco875 3d0c047cc9 change bool (#644)
Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2024-07-21 21:42:14 -06:00
MegaMech 3d7cdcee8a Collision Documentation (#640)
* Collision related renames
2024-06-26 19:22:38 -06:00
MegaMech 7a10ba89f6 Header cleanup and some renames (#616)
* Place macros for addr conversions

* dl renames

* fixes

* changes ok

* Delete types.h

* move enums
2024-04-20 19:10:53 -06:00
coco875 9ac20c80b8 fix a lot of warning in code (#598)
* Fix warnings
* Fix building
2024-04-16 10:00:08 -06:00
coco875 2b66867af1 Rename cpu behaviour related symbols (#586)
* Rename cpu related symbols
2024-04-06 11:35:13 -06:00
coco875 12f332614e move actors code in actors folder and rename thing related to actor (#584)
* Move actors into their folders

* Renamings and documentation
2024-04-03 12:44:44 -06:00
coco875 f99e242d97 Document render/update objects (#565)
* Document objects related code.
  * Including render/update objects code
* Various renamings
2024-03-04 09:02:45 -07:00
coco875 d6663422b0 fix warning, type and document audio (#559)
* Document audio

* Update external.h

* fix warnings

* put a do while on one line
2024-02-13 07:27:58 -07:00
MegaMech 19410f2825 Code Segments Shiftable (#566)
his PR cleans up segment related code in main.c.
Also cleans up the linker a bit.

    Add memory pool to linker as .bss to validate that it exists properly.

    Move framebuffers, gfx, and audio buffers out of racing segment and make its own segment.

    Rename framebuffers.c to buffers.c as it contains more than just framebuffers.

    Import asserts from sm64 to validate that code segments are not overlapping

    Rename segNoload to segmentNoload

    Rename 802BA370 segment to trigTables

    Rename gMenuSelectionFromEndingSequence to gGotoMenu

    Rename gMenuSelectionFromQuit to gGotoMode

    Rename SEG_ENDING_SEQUENCES to SEG_ENDING

    Rename data_821D10 to ceremonyData

    Rename data_825800 to startupLogo
2024-02-05 17:08:29 -07:00
coco875 639fec1458 place surface type const and unassemble flag in vtx and document effects (#553)
* place surface type const and unassemble flag in vtx
2024-01-20 21:22:35 -07:00