Difference between revisions of "MKW-SP"
Jump to navigation
Jump to search
m (Style fix) |
(Turns out stebler has a wiiki account) |
||
Line 2: | Line 2: | ||
|+ {{PAGENAME}} | |+ {{PAGENAME}} | ||
! Author: | ! Author: | ||
− | | | + | | [[stebler]] |
|- | |- | ||
! Type: | ! Type: | ||
Line 31: | Line 31: | ||
== Overview == | == Overview == | ||
− | '''Mario Kart Wii - Service Pack''' (abbreviated ''MKW-SP'') is an open source mod created by stebler. It features up to 6 different licenses, viewing up to 11 ghosts at a time, a custom speedometer, SD ghost saving, and more. | + | '''Mario Kart Wii - Service Pack''' (abbreviated ''MKW-SP'') is an open source mod created by [[stebler]]. It features up to 6 different licenses, viewing up to 11 ghosts at a time, a custom speedometer, SD ghost saving, and more. |
A quote from the author: | A quote from the author: | ||
Line 70: | Line 70: | ||
* The character animations are now correctly applied (and unlike in live view, also for the non-spectated ghost). [stebler] | * The character animations are now correctly applied (and unlike in live view, also for the non-spectated ghost). [stebler] | ||
* The camera no longer wrongly follows the player when falling out-of-bounds or in cannons. [stebler] | * The camera no longer wrongly follows the player when falling out-of-bounds or in cannons. [stebler] | ||
− | * A bug where the UI overlay was shown when a non-spectated ghost was falling out-of-bounds has been fixed. [stebler, riidefi] | + | * A bug where the UI overlay was shown when a non-spectated ghost was falling out-of-bounds has been fixed. [[[stebler]], riidefi] |
* An option to remove leading zeros from ghost tags when using the finish time has been added. [riidefi] | * An option to remove leading zeros from ghost tags when using the finish time has been added. [riidefi] | ||
− | * Several crashes and freezes when going back to the menu have been fixed. [stebler, Seeky] | + | * Several crashes and freezes when going back to the menu have been fixed. [[[stebler]], Seeky] |
* The first 4 ghosts no longer desync due to the cones on Daisy Circuit. A fix is in the works to extend that limit. [stebler] | * The first 4 ghosts no longer desync due to the cones on Daisy Circuit. A fix is in the works to extend that limit. [stebler] | ||
* Lakitu now follows the spectated ghost. [stebler] | * Lakitu now follows the spectated ghost. [stebler] | ||
Line 94: | Line 94: | ||
* Colored minimaps are now supported for race tracks. [riidefi] | * Colored minimaps are now supported for race tracks. [riidefi] | ||
* Support for USB keyboard has been added to perform certain actions via commands. For now this only works on Dolphin on Windows. [riidefi] | * Support for USB keyboard has been added to perform certain actions via commands. For now this only works on Dolphin on Windows. [riidefi] | ||
− | * The gecko code check has been improved to work on console and the warning has been clarified. Note that support will only get worse when memory protection is implemented. [Star, stebler] | + | * The gecko code check has been improved to work on console and the warning has been clarified. Note that support will only get worse when memory protection is implemented. [Star, [stebler] |
* The shroom strategy is now saved in the MKW-SP ghost header. [stebler] | * The shroom strategy is now saved in the MKW-SP ghost header. [stebler] | ||
− | * The project has been renamed to “Service Pack”, which as some of you have guessed is inspired by Microsoft Windows and was the intent since the start (Support Packages also exist in computing but are not quite the same thing). [stebler, Zach] | + | * The project has been renamed to “Service Pack”, which as some of you have guessed is inspired by Microsoft Windows and was the intent since the start (Support Packages also exist in computing but are not quite the same thing). [[[stebler]], Zach] |
|- | |- | ||
| [https://www.mkw-sp.com/2022/02/27/mkw-sp-0.1.2-released.html v0.1.2] | | [https://www.mkw-sp.com/2022/02/27/mkw-sp-0.1.2-released.html v0.1.2] | ||
Line 122: | Line 122: | ||
|- | |- | ||
| Custom Save System | | Custom Save System | ||
− | | stebler | + | | [[stebler]] |
| The rksys.dat format is replaced with a custom system that can support more than 4 licenses (for now the UI can [https://www.mkw-sp.com/assets/6-licenses.png handle up to 6]) and [https://www.mkw-sp.com/assets/license-settings.png additional settings]. Ghosts are moved to separate files and everything is always unlocked. Riivolution’s redirect feature is used to store all files to the SD card (or equivalent) instead of the NAND. | | The rksys.dat format is replaced with a custom system that can support more than 4 licenses (for now the UI can [https://www.mkw-sp.com/assets/6-licenses.png handle up to 6]) and [https://www.mkw-sp.com/assets/license-settings.png additional settings]. Ghosts are moved to separate files and everything is always unlocked. Riivolution’s redirect feature is used to store all files to the SD card (or equivalent) instead of the NAND. | ||
|- | |- | ||
| 11-Way Multi-Ghost | | 11-Way Multi-Ghost | ||
− | | stebler | + | | [[stebler]] |
| It is possible to race against or watch up to 11 ghosts at once. One can switch between ghosts during a replay (similar to live view). The ghost selection UI has been [https://www.mkw-sp.com/assets/ghost-selection.png accordingly remade from scratch]. | | It is possible to race against or watch up to 11 ghosts at once. One can switch between ghosts during a replay (similar to live view). The ghost selection UI has been [https://www.mkw-sp.com/assets/ghost-selection.png accordingly remade from scratch]. | ||
|- | |- | ||
| Tag Limit Increase | | Tag Limit Increase | ||
− | | stebler | + | | [[stebler]] |
| Up to 12 tags can be shown at once (from 3 in the vanilla game). | | Up to 12 tags can be shown at once (from 3 in the vanilla game). | ||
|- | |- | ||
| Speedometer | | Speedometer | ||
− | | stebler, [[Syara]] | + | | [[stebler]], [[Syara]] |
| The speed of the player is shown in the HUD, including [https://www.mkw-sp.com/assets/som-moving-road.png moving road] and [https://www.mkw-sp.com/assets/som-moving-water.png moving water]. Split-screen [https://www.mkw-sp.com/assets/som-split-screen.png is supported]. The “SPEED” label has been translated into 4 languages. | | The speed of the player is shown in the HUD, including [https://www.mkw-sp.com/assets/som-moving-road.png moving road] and [https://www.mkw-sp.com/assets/som-moving-water.png moving water]. Split-screen [https://www.mkw-sp.com/assets/som-split-screen.png is supported]. The “SPEED” label has been translated into 4 languages. | ||
|- | |- | ||
| Additional Ghost Metadata | | Additional Ghost Metadata | ||
− | | stebler, [[Chadderz]], [[MrBean35000vr]], [[CLF78]] | + | | [[stebler]], [[Chadderz]], [[MrBean35000vr]], [[CLF78]] |
| The sha-1 of the track, whether 200cc was enabled, more precise finish times and detected glitches are saved at the end of the ghost file. The first two properties are used to only show ghosts for the correct track and engine class. The equivalent fields can be read from CTGP ghosts for the same purpose. The sha-1 computation doesn’t take _Dif files into account, allowing for e.g. custom textures. | | The sha-1 of the track, whether 200cc was enabled, more precise finish times and detected glitches are saved at the end of the ghost file. The first two properties are used to only show ghosts for the correct track and engine class. The equivalent fields can be read from CTGP ghosts for the same purpose. The sha-1 computation doesn’t take _Dif files into account, allowing for e.g. custom textures. | ||
|- | |- | ||
| Pause Menu Improvements | | Pause Menu Improvements | ||
− | | stebler, [[Riidefi]] | + | | [[stebler]], [[Riidefi]] |
| Additional buttons have been added to the pause menus, notably one to change the settings and another to go back directly to the ghost selection. | | Additional buttons have been added to the pause menus, notably one to change the settings and another to go back directly to the ghost selection. | ||
|- | |- | ||
| Translations | | Translations | ||
− | | stebler, [[Translation Project|MK Translation Project]] | + | | [[stebler]], [[Translation Project|MK Translation Project]] |
| All languages (plus Dutch) are supported in all versions of the game. Some of the MKW-SP-specific strings are also translated. | | All languages (plus Dutch) are supported in all versions of the game. Some of the MKW-SP-specific strings are also translated. | ||
|- | |- | ||
Line 158: | Line 158: | ||
|- | |- | ||
| Rear View In Replay | | Rear View In Replay | ||
− | | stebler | + | | [[stebler]] |
| In ghost replay mode, cinematic view is [https://www.mkw-sp.com/assets/rear-view.png replaced by rear view]. | | In ghost replay mode, cinematic view is [https://www.mkw-sp.com/assets/rear-view.png replaced by rear view]. | ||
|- | |- | ||
| Hide HUD Labels | | Hide HUD Labels | ||
− | | stebler | + | | [[stebler]] |
| ''License setting.'' The TIME, LAP and SPEED HUD labels are hidden. | | ''License setting.'' The TIME, LAP and SPEED HUD labels are hidden. | ||
|- | |- | ||
Line 170: | Line 170: | ||
|- | |- | ||
| Mii Heads On Minimap | | Mii Heads On Minimap | ||
− | | stebler | + | | [[stebler]] |
| ''License setting.'' For local players and ghosts, the Mii replaces the character as minimap icon. | | ''License setting.'' For local players and ghosts, the Mii replaces the character as minimap icon. | ||
|- | |- | ||
Line 186: | Line 186: | ||
|- | |- | ||
| Ghost Sorting | | Ghost Sorting | ||
− | | stebler | + | | [[stebler]] |
| ''Time trial rule.'' In the selection UI and in race ghosts can be sorted by finish time or by creation date. | | ''Time trial rule.'' In the selection UI and in race ghosts can be sorted by finish time or by creation date. | ||
|- | |- | ||
| Ghost Tag Visibility | | Ghost Tag Visibility | ||
− | | stebler | + | | [[stebler]] |
| ''Time trial rule.'' Ghost tags can be shown for all, focused only or no ghost. | | ''Time trial rule.'' Ghost tags can be shown for all, focused only or no ghost. | ||
|- | |- | ||
| Ghost Tag Content | | Ghost Tag Content | ||
− | | stebler | + | | [[stebler]] |
| ''Time trial rule.'' Ghost tags can be either the Mii name, [https://www.mkw-sp.com/assets/tag-time.png finish time] or [https://www.mkw-sp.com/assets/tag-date.png creation date.] | | ''Time trial rule.'' Ghost tags can be either the Mii name, [https://www.mkw-sp.com/assets/tag-time.png finish time] or [https://www.mkw-sp.com/assets/tag-date.png creation date.] | ||
|- | |- | ||
| Solid Ghosts | | Solid Ghosts | ||
− | | stebler | + | | [[stebler]] |
| ''Time trial rule.'' Transparency can be disabled for all, focused only or no ghost. | | ''Time trial rule.'' Transparency can be disabled for all, focused only or no ghost. | ||
|- | |- | ||
| Ghost Sound | | Ghost Sound | ||
− | | stebler | + | | [[stebler]] |
| ''Time trial rule.'' Sound can be enabled for all, focused only or no ghost | | ''Time trial rule.'' Sound can be enabled for all, focused only or no ghost | ||
|} | |} |
Revision as of 20:31, 27 February 2022
Author: | stebler |
---|---|
Type: | Riivolution |
Version: | v0.1.2 |
Release: | 2022-02-27 |
Latest update: | 2022-02-27 |
Website: | mkw-sp.com |
Download: | GitHub |
Source Code: | GitHub |
Discord Server: | MKW-SP |
Overview
Mario Kart Wii - Service Pack (abbreviated MKW-SP) is an open source mod created by stebler. It features up to 6 different licenses, viewing up to 11 ghosts at a time, a custom speedometer, SD ghost saving, and more.
A quote from the author:
- MKW-SP is fully open-source and the code (including the whole history) and the issue tracker are available on Github, and so is my Ghidra repository. That means that anyone is free (and welcome) to implement new features. Feedback is also very appreciated and will be listened to.
Credits
- CLF78, for his help with the initial release.
- Lami, Riidefi, Seeky and StarMKWii for contributing on Github.
- All developers in the table below for creating code used in the mod.
Media
Version History
Version | Date of release | Information |
---|---|---|
v0.1 | 2022-02-27 | First release |
v0.1.1 | 2022-02-27 |
File management
Translations
Multi-ghost
Menus
HUD
Miscellaneous
|
v0.1.2 | 2022-02-27 |
Robustness and security
Miscellaneous
|
Features
Feature | Author | Information |
---|---|---|
Custom Save System | stebler | The rksys.dat format is replaced with a custom system that can support more than 4 licenses (for now the UI can handle up to 6) and additional settings. Ghosts are moved to separate files and everything is always unlocked. Riivolution’s redirect feature is used to store all files to the SD card (or equivalent) instead of the NAND. |
11-Way Multi-Ghost | stebler | It is possible to race against or watch up to 11 ghosts at once. One can switch between ghosts during a replay (similar to live view). The ghost selection UI has been accordingly remade from scratch. |
Tag Limit Increase | stebler | Up to 12 tags can be shown at once (from 3 in the vanilla game). |
Speedometer | stebler, Syara | The speed of the player is shown in the HUD, including moving road and moving water. Split-screen is supported. The “SPEED” label has been translated into 4 languages. |
Additional Ghost Metadata | stebler, Chadderz, MrBean35000vr, CLF78 | The sha-1 of the track, whether 200cc was enabled, more precise finish times and detected glitches are saved at the end of the ghost file. The first two properties are used to only show ghosts for the correct track and engine class. The equivalent fields can be read from CTGP ghosts for the same purpose. The sha-1 computation doesn’t take _Dif files into account, allowing for e.g. custom textures. |
Pause Menu Improvements | stebler, Riidefi | Additional buttons have been added to the pause menus, notably one to change the settings and another to go back directly to the ghost selection. |
Translations | stebler, MK Translation Project | All languages (plus Dutch) are supported in all versions of the game. Some of the MKW-SP-specific strings are also translated. |
My Stuff Folder | N.A. | Allows for file replacements such as custom tracks, custom music and so on. For tracks and UI files, it is possible to replace only certain U8 subfiles by adding the _Dif suffix to the archive name (e.g. koopa_course_Dif.szs or MenuSingle_E_Dif.szs). |
Automatic BRSAR Patching | Elias_ | The revo_kart.brsar file is automatically patched to prevent music from cutting off mid-race. |
Rear View In Replay | stebler | In ghost replay mode, cinematic view is replaced by rear view. |
Hide HUD Labels | stebler | License setting. The TIME, LAP and SPEED HUD labels are hidden. |
4:3 FOV in 16:9 | Brandondorf9999] | License setting. The wider 4:3 field-of-view is used in 16:9 mode |
Mii Heads On Minimap | stebler | License setting. For local players and ghosts, the Mii replaces the character as minimap icon. |
Instant Menu Transitions | Riidefi | License setting. This allows for much faster navigation. |
Input Display | Riidefi | License setting. The controller inputs are shown in the HUD. Split-screen and 200cc are supported. |
200cc | MrBean35000vr | VS and time trial rule. A speed class with a 1.5x speed multiplier, brake drifting and fast falling. |
Ghost Sorting | stebler | Time trial rule. In the selection UI and in race ghosts can be sorted by finish time or by creation date. |
Ghost Tag Visibility | stebler | Time trial rule. Ghost tags can be shown for all, focused only or no ghost. |
Ghost Tag Content | stebler | Time trial rule. Ghost tags can be either the Mii name, finish time or creation date. |
Solid Ghosts | stebler | Time trial rule. Transparency can be disabled for all, focused only or no ghost. |
Ghost Sound | stebler | Time trial rule. Sound can be enabled for all, focused only or no ghost |
Limitations and known bugs
- Ghost solidity is off by one frame when switching. See issue 44.
- VS and battle settings aren’t saved. See issue 50.
- Most gecko codes won’t work because of the different memory map. A warning is shown on the title screen if they are enabled. When memory protection is implemented, support will be dropped altogether.