ctr-tools/ctr-modsdk

ModSDK - a modding toolkit to create mods for Crash Team Racing in C. This repository also houses an effort to fully decompile and reverse-engineer CTR in C.

CTR-ModSDK

ModSDK. (noun) A toolkit that allows you to create mods for Crash Team Racing (1999) in C.

This repository also houses an effort to fully decompile and reverse-engineer CTR in C.

🏁 Modding CTR

Requirements

This SDK requires the installation of mateusfavarin's psx-modding-toolchain. You can check the repo's readme for instructions on the installation and additional documentation on its usage. All python and pip steps are mandatory.

Downloading the SDK

After setting up psx-modding-toolchain, clone this repository into the local directory psx-modding-toolchain/games:

$ git clone https://github.com/CTR-Tools/CTR-ModSDK.git

• You can find example mods in our repo.
• Each mod folder includes a readme.txt file on what the mod does and how to use it.

CTR-in-C

As mentioned earlier, this repository is also used for an attempt at decompiling the original CTR assembly into human-readable C code. Our decompilation targets non-matching code that still functions identically compared to the original code.

🤝 Contributing

Are you interested in contributing? Have any experience in C programming language? You're welcome to join!

How to rewrite functions:

• Make sure you have cloned this repo and installed the requirements.
• Choose a .c file from the ghidra folder. Each file represents a code section or category. All non-numbered .c files are parts of the main EXE while the numbered files are overlays.
• Choose a function in that section to rewrite. Read the documentation comments on what the function does and what's the address.
• Set up a compile folder for your rewritten function using psx-modding-toolchain. Please refer to the above section for its installation and usage.

* Build codenames:
common: All versions;
926: USA Retail;
1006: Japan Trial;
1020: Europe Retail;
1111: Japan Retail.

** Code region:
exe: main EXE;
221-233: Overlays (use the original .c filename number)

• Run build.bat and choose "Compile", "Build ISO", then test the game.
• After you've confirmed that it's functional, add your new function .c file to the decompile directory.
• Feel free to make a pull request after everything is working!

If you have any questions, reach us out in our Discord server.

ctr-modsdk's Issues

DisableHUD weapon sound bug

If you grab a weapon box, the weapon roulette sound will never stop playing

USA AdvBosses makes AdvMode Purple Gem Cup crash

All tracks are playable, but before entering the podium event the game crashes with a red screen.

ReservesMeter and Retro-Fueled mod — and possibly the Turbo_Increment decompile — are bugged in PAL

-Allegedly, reserves are being decreased too quickly in PAL
-There might also be an error with allowing power slides to occur whenever you try to start a power slide at the same time you hit a turbo pad, with the game acting as though you're holding brake
both may have to do with the fact both the ReservesMeter and Retro-Fueled mods use the decompiled Turbo_Increment function

OverrideMPK breaks Pinstripe in Adventure Mode

When using OverrideMPK with AdvBosses or any other modpacks that have both, Pinstripe will fail to load the correct animation/model right after any podium and crash the game.

Pinstripe breaks after the first podium

Used just AdvBosses to play the first area, but Pinstripe with OverrideMPK will still breaks after podium in other areas too

So far I've only found this bug with Pinstripe, but it happens in all retail versions. The problem might lies with Pinstripes adventure mpk file.

RF Custom Textures

Retro Fueled textures are not compatible with SaveRAM, because they both take the same kernel memory.
This means RF textures can't be displayed when using CharacterRandomizer (newest version), and OxideFix (any version). RF textures also do not work in the japan version of CTR

LangMenu mod references non-existing files

The LangMenu module references src/newRow.bin´ and src/newRows.c` but those files do not seem to exist:

CTR-ModSDK/mods/Modules/LangMenu/buildList.txt

Line 11 in 54cddd8

926, 230, 0x800b4534, 0x0, src/newRow.bin

There is newLanguageRows.c which I suppose is the file that should be used?

Release 5

Must rebuild all XDELTAs for all mods that use:

• character randomizer (now uses SaveRAM)
• oxide fix (with updated SaveRAM)

RF mod packs were not updated, because the new SaveRAM breaks RF.
The only way to crash the game is something completely insane, like RF + 2P Arcade Cups + Randomizer all at once

2P Vertical Splitscreen bug

When using the warpball weapon, the weapon still moves on the horizontal midpoint, not the vertical midpoint

Practice Tool Standalone [All versions] - Engine Swap doesn't work on Restart

Engine Swap doesn't work on restart, every time you restart after switching engine it goes back to Penta.
The engine does change during the run but that bugs out the audio.

Oxide PAL bug

Oxide does not draw properly in the PAL character selection, but the rest of gameplay works fine

cannot open release 11 zip

Rebuilding PAL roms leaves out XA audio

currently affects every european patch in the mod collection
tested with an EDC rom as the source

Current issues with 60fps

Semi-functional patches

• Particles are patched emitter-by-emitter, 231 emitters unpatched, should patch Particles_UpdateLists
• Texture scrolling (turbo, waterfall, etc) run at 30fps
• Bosses dont constantly spam weapons, but it's still not right
• When opening Adv Hub door with key, zoom out should take 2 sec, not 1 sec
• Blizzard Bluff + Sewer Speedway update hazards at 30fps
• N Gin Labs barrel hazard runs at 30fps
• Weapon roulette flashes too fast, but duration is correct
• Shiled weapon shakes too much
• Entering warp pad sometimes works right, and sometimes throws player upward
• Blinking map UI, partly fixed and partly abandoned
• AI animations
• Player reverse, crash, jump animation
• Spiders have a slightly-off cycle

Known issues

• Steering angular acceleration isn't patched for 60fps (see Player_Steer_GetAngularVelocity)
• Animations are half-working, half-fix
• Flashing colors for player icons are too fast
• Demo Mode only lasts half-time (even though it "should" be fixed???)
• UI highlight (red/yellow) in menus is too fast
• Demo Mode / End-Of-Race cameras sometimes are too fast
• Adventure Garage camera is too fast
• Adventure Hub Warp pad electric field
• Lots of flashing text is flashing too fast
• At end of Time Trial / Relic, high scores disappear halfway off-screen
• AI acceleration from starting line
• Screen fade transitions (fade to black, fade to white, etc.)
• Red potion (fix disabled, freezes game)
• Bubble particles fail to be culled by water surface (hits the top of the screen)
• Still can't skip weapon roulette by pressing circle
• Wumpa gets collected too quickly (code for this is in DrawHUD_Racing)

Splatoon bugs

• Powerslide meter looks empty on the first frames, even though it isn't
• Engine sounds are spamming, should just disable those
• Collision breaks when going uphill

This is also just unfinished in general, need to make a way to "throw" paint, and a combat system, and swimming on walls.

ModPack OxideFix and Everything Ever - Only USA Errors (no retrofueled)

Adventure mode is ubeatable due to errors in Rocky Road and Nitro Court purple token challenge, some nitros and every ? crates dont have collision, if you touch some nitros crashes the game or emulator, uncollectable multicolored crystal and invisible pits in the terrain, only in this modpack happens



one crate was breakable but the bomb crashed the game

Nitro Court



DED, not big surprise

this error date since Mod Collection Release 2 to the actual Mod Collection Release 11

[Mod Collection Release 11] Save states do not work on Standalones/PracticeROM

Please add to readme that save states require having vibrations on.

Oxide all-region bugs

Mystery Caves can crash randomly, reason unknown

Purple Gem Cup podiums can run out of RAM, red screen of death, could be improper model loader

Character Randomizer dont make Oxide appear.

The rest of the characters appears without any problems. But for some reason Oxide never shows, not matter the amount of times one tries.

60fps bugs

List of bugs is in a txt document, saved in the src folder of the 60fps mod.
Another txt document, list of fixes, describes some features "partially" fixed, that aren't perfect

Extraction crashes at plugin step with the latest psx-modding-toolchain

Crash is caused by the missing additional version param in the self.plugin.extract.
https://github.com/CTR-tools/CTR-ModSDK/blob/main/plugins/plugin.py

the breaking change:
mateusfavarin/psx-modding-toolchain@aebf3ed

PracticeROM is broken

• Crashes at main menu in NTSC-J
• Save states don't work
  the latest commit (as of writing) changing PracticeROM was me trying to fix it failing to compile due to common.h changes, I guess I didn't entirely fix that

Current issues with OxideFix

• Oxide's character preview in the character select screen is displayed with
  the wheels that the other characters' karts have. These are to be removed in
  a future version of the mod.
• Oxide's character icon in the character select screen flies into view from
  the left side of the screen as opposed to the bottom. It is yet unknown why
  this happens.
• Oxide's model in the character select screen displays erroneously in the
  European version of the game. This is assumed to be due to how this
  functionality was achieved by a manual edit of Oxide's character model, and
  thus how model information may be read differently in the European version.
  More research on the game's model formats may be required to fix this issue.