Difference between revisions of "Riivolution"

From Custom Mario Kart
Jump to navigation Jump to search
(Added full author list, source link, FAQ, v1.0 link. Corrected the page saying it uses files on the SD, and made Riifs easier to find.)
(Cleanup.)
Line 1: Line 1:
 
{| class="textbox float-right grid"
 
{| class="textbox float-right grid"
 
|+ {{PAGENAME}}
 
|+ {{PAGENAME}}
! Creators:
+
! Author:
| Aaron "[https://wiibrew.org/wiki/User:AerialX AerialX]", tueidj, Tempus, [https://www.wiibrew.org/wiki/User:Megazig megazig]
+
| Aaron "[https://wiibrew.org/wiki/User:AerialX AerialX]", tueidj, Tempus, [https://wiibrew.org/wiki/User:Megazig megazig]
 
|-
 
|-
 
! Version:
 
! Version:
Line 11: Line 11:
 
|-
 
|-
 
! Download:
 
! Download:
| [https://riivolution.github.io/wiki/Riivolution/ Riivolution Archive]
+
| [https://riivolution.github.io/wiki/Riivolution GitHub (Riivolution Archive)]
 
|-
 
|-
! Source Code:  
+
! Source code:  
 
| [https://github.com/AerialX/rawksd GitHub]
 
| [https://github.com/AerialX/rawksd GitHub]
 
|}
 
|}
 
  
 
== Overview ==
 
== Overview ==
'''Riivolution''' is an on-the-fly game patcher created by [https://wiibrew.org/wiki/User:AerialX AerialX], tueidj, Tempus, and [https://www.wiibrew.org/wiki/User:Megazig megazig] for use with retail discs. It allows users to place content on their SD or USB devices, as well as on a [[RiiFS]] server, which will be read by the game during regular play. It is used by several [[custom track distribution]]s in order to run modified tracks without a patched ISO. Riivolution is supported on console and Dolphin since version 5.0-15407. For older versions of Dolphin, you will need to patch your ISO.
+
'''Riivolution''' is an on-the-fly game patcher created by [https://wiibrew.org/wiki/User:AerialX AerialX], tueidj, Tempus, and [https://wiibrew.org/wiki/User:Megazig megazig] for use with retail discs. It allows users to place content on their SD or USB devices, as well as on a [[RiiFS]] server, which will be read by the game during regular play. It is used by several [[custom track distribution]]s in order to run modified tracks without a patched ISO. Riivolution is supported on console and Dolphin since version 5.0-15407. For older versions of Dolphin, you will need to patch your ISO.
  
 
== Usage ==
 
== Usage ==
Riivolution uses XML files to load custom content from an external filesystem. To use this, have your XML point to a folder with all the custom content inside and place the XML in the "riivolution" folder. The format of these XML files is described [https://riivolution.github.io/wiki/Patch_Format/ here], and templates are available [https://riivolution.github.io/wiki/Patch_Templates/ here]
+
Riivolution uses XML files to load custom content from an external filesystem. To use this, have your XML point to a folder with all the custom content inside and place the XML in the "riivolution" folder. The format of these XML files is described [https://riivolution.github.io/wiki/Patch_Format here], and templates are available [https://riivolution.github.io/wiki/Patch_Templates here].
 
{{youtube-box|tutorial|xxr_R1tCwKY|Riivolution game patching tutorial}}
 
{{youtube-box|tutorial|xxr_R1tCwKY|Riivolution game patching tutorial}}
 
{{youtube-box|tutorial|WGdW97o60U4|How to run Riivolution mods on Dolphin (For builds prior to 5.0-15407)}}
 
{{youtube-box|tutorial|WGdW97o60U4|How to run Riivolution mods on Dolphin (For builds prior to 5.0-15407)}}
  
 
== FAQ ==
 
== FAQ ==
''' Does Riivolution work with my backups or USB loaders? '''
+
'''Does Riivolution work with my backups or USB loaders?'''
  
No. And that's not a bug.
+
''No. And that's not a bug.''
  
''' Does Riivolution work with my PAL/NTSC/JAP Wii/game? '''
+
'''Does Riivolution work with my PAL/NTSC/JAP Wii/game?'''
  
Yes.
+
''Yes.''
  
''' Does Riivolution work on my Wii U? '''
+
'''Does Riivolution work on my Wii U?'''
  
It does now! In vWii mode (it does not work with Wii U games) Riivolution can be run or installed through Smash Stack, other game exploits, or the Homebrew Channel if it's already installed.
+
''It does now! In vWii mode (it does not work with Wii U games) Riivolution can be run or installed through Smash Stack, other game exploits, or the Homebrew Channel if it's already installed.''
  
''' What IOS does it need installed? '''
+
'''What IOS does it need installed?'''
  
Riivolution requires an updated IOS37; if you're on System Menu 4.2 or 4.3 you don't need to do anything.
+
''Riivolution requires an updated IOS37; if you're on System Menu 4.2 or 4.3 you don't need to do anything. If it's not installed or the proper version it will be installed the first time Riivolution is run.''
If it's not installed or the proper version it will be installed the first time Riivolution is run.
 
  
Alternatively, you can also use NUSD or DOP-IOS to install it - with all patches disabled.
+
''Alternatively, you can also use NUSD or DOP-IOS to install it - with all patches disabled.''
  
''' Does Riivolution work with Game X? '''
+
'''Does Riivolution work with Game X?'''
  
I probably haven't played it, but yes, it should; try it. If it doesn't work, report it - some games known to reload IOS will require specific patches to work.
+
''I probably haven't played it, but yes, it should; try it. If it doesn't work, report it - some games known to reload IOS will require specific patches to work.''
  
Games that have specifically been tested include Fatal Frame 4, Super Smash Bros. Brawl, New Super Mario Bros. Wii, Rock Band, among others.
+
''Games that have specifically been tested include Fatal Frame 4, Super Smash Bros. Brawl, New Super Mario Bros. Wii, Rock Band, among others.''
  
''' What does the "Install" button do? '''
+
'''What does the "Install" button do?'''
  
It will install a Riivolution channel onto your System Menu for easy access. This can always be uninstalled.
+
''It will install a Riivolution channel onto your System Menu for easy access. This can always be uninstalled.''
  
''' Can I use Ocarina / Gecko codes with it? '''
+
'''Can I use Ocarina / Gecko codes with it?'''
  
Normally, Riivolution just supports direct memory patches. However, Riivolution supports a patching method that can be used with the Gecko OS code handler.
+
''Normally, Riivolution just supports direct memory patches. However, Riivolution supports a patching method that can be used with the Gecko OS code handler.''
  
Read more about that [https://riivolution.github.io/wiki/Ocarina_Codes here].
+
''Read more about that [https://riivolution.github.io/wiki/Ocarina_Codes here].''
  
''' Uhh, how do I use this? '''
+
'''Uhh, how do I use this?'''
  
As a user, you need to either download patch packages made by someone else or make your own.
+
''As a user, you need to either download patch packages made by someone else or make your own.''
  
A basic template and packages for common games can be found at the [https://riivolution.github.io/wiki/Patch_Templates patch templates] section.
+
''A basic template and packages for common games can be found at the [https://riivolution.github.io/wiki/Patch_Templates patch templates] section. For a more detailed explanation about Riivolution's patch XML files, check out the [https://riivolution.github.io/wiki/Patch_Format instructions].''
For a more detailed explanation about Riivolution's patch XML files, check out the [https://riivolution.github.io/wiki/Patch_Format instructions].
 
  
''' Network support? Awesome, how do I use it? '''
+
'''Network support? Awesome, how do I use it?'''
  
Read more about all of Riivolution's [https://riivolution.github.io/wiki/Network network features].
+
''Read more about all of Riivolution's [https://riivolution.github.io/wiki/Network network features].''
  
 
== Version History ==
 
== Version History ==
Line 119: Line 116:
 
* This update provides behind-the-scenes fixes that will not affect features but will improve the overall system performance.
 
* This update provides behind-the-scenes fixes that will not affect features but will improve the overall system performance.
 
* Added System Menu 4.3v2 compatibility (September 8th, 2010 update).
 
* Added System Menu 4.3v2 compatibility (September 8th, 2010 update).
* New savefile redirection feature.
+
* Added new savefile redirection feature.
 
|-
 
|-
 
| [https://riivolution.github.io/riivolution/riivolution-1.05.zip v1.05]
 
| [https://riivolution.github.io/riivolution/riivolution-1.05.zip v1.05]
Line 125: Line 122:
 
|
 
|
 
* The Wii U (Virtual Wii Menu) is now supported.
 
* The Wii U (Virtual Wii Menu) is now supported.
* New Wii Remote Plus remotes are now properly supported.
+
* Added new Wii Remote Plus remotes are now properly supported.
 
|-
 
|-
 
| [https://riivolution.github.io/riivolution/riivolution-1.06.zip v1.06]
 
| [https://riivolution.github.io/riivolution/riivolution-1.06.zip v1.06]
Line 134: Line 131:
 
== Known Bugs ==
 
== Known Bugs ==
 
In a distribution via Riivolution, the game can freeze when a player completes a lap. This occurs for some [[Wii]] users.
 
In a distribution via Riivolution, the game can freeze when a player completes a lap. This occurs for some [[Wii]] users.
 
 
  
 
[[Category:Software]]
 
[[Category:Software]]

Revision as of 02:07, 31 January 2023

Riivolution
Author: Aaron "AerialX", tueidj, Tempus, megazig
Version: v1.06
Date of latest version: 2013-12-18
Download: GitHub (Riivolution Archive)
Source code: GitHub

Overview

Riivolution is an on-the-fly game patcher created by AerialX, tueidj, Tempus, and megazig for use with retail discs. It allows users to place content on their SD or USB devices, as well as on a RiiFS server, which will be read by the game during regular play. It is used by several custom track distributions in order to run modified tracks without a patched ISO. Riivolution is supported on console and Dolphin since version 5.0-15407. For older versions of Dolphin, you will need to patch your ISO.

Usage

Riivolution uses XML files to load custom content from an external filesystem. To use this, have your XML point to a folder with all the custom content inside and place the XML in the "riivolution" folder. The format of these XML files is described here, and templates are available here.

Riivolution game patching tutorial
How to run Riivolution mods on Dolphin (For builds prior to 5.0-15407)

FAQ

Does Riivolution work with my backups or USB loaders?

No. And that's not a bug.

Does Riivolution work with my PAL/NTSC/JAP Wii/game?

Yes.

Does Riivolution work on my Wii U?

It does now! In vWii mode (it does not work with Wii U games) Riivolution can be run or installed through Smash Stack, other game exploits, or the Homebrew Channel if it's already installed.

What IOS does it need installed?

Riivolution requires an updated IOS37; if you're on System Menu 4.2 or 4.3 you don't need to do anything. If it's not installed or the proper version it will be installed the first time Riivolution is run.

Alternatively, you can also use NUSD or DOP-IOS to install it - with all patches disabled.

Does Riivolution work with Game X?

I probably haven't played it, but yes, it should; try it. If it doesn't work, report it - some games known to reload IOS will require specific patches to work.

Games that have specifically been tested include Fatal Frame 4, Super Smash Bros. Brawl, New Super Mario Bros. Wii, Rock Band, among others.

What does the "Install" button do?

It will install a Riivolution channel onto your System Menu for easy access. This can always be uninstalled.

Can I use Ocarina / Gecko codes with it?

Normally, Riivolution just supports direct memory patches. However, Riivolution supports a patching method that can be used with the Gecko OS code handler.

Read more about that here.

Uhh, how do I use this?

As a user, you need to either download patch packages made by someone else or make your own.

A basic template and packages for common games can be found at the patch templates section. For a more detailed explanation about Riivolution's patch XML files, check out the instructions.

Network support? Awesome, how do I use it?

Read more about all of Riivolution's network features.

Version History

Version Date of release Information
v1.0 2010-03-20 First release
v1.01 2010-03-22
  • Memory patch improvements.
  • Mounted disk improvements.
  • Added network support.
v1.02 2010-03-28
  • Added disc file support.
  • More memory patch improvements.
  • Added network hostname lookups.
  • Network stability improvements.
  • Games will now connect to the network alongside RiiFS.
  • Added foreign character support in XMLs (Latin-1).
v1.03 2010-06-28
  • Added System Menu 4.3 compatibility.
  • Added Wii slot light filesystem indicator.
  • Stability fixes for all filesystems.
  • Files now close after a few seconds to allow them to be replaced over RiiFS.
  • Supported NetBEUI hostname lookups.
  • Improved channel install.
    • It no longer requires SD/USB.
  • RiiFS improvements.
    • Native C++ Server.
    • Connects automatically on a LAN without needing SD/USB.
v1.04 2010-09-22
  • This update provides behind-the-scenes fixes that will not affect features but will improve the overall system performance.
  • Added System Menu 4.3v2 compatibility (September 8th, 2010 update).
  • Added new savefile redirection feature.
v1.05 2013-06-10
  • The Wii U (Virtual Wii Menu) is now supported.
  • Added new Wii Remote Plus remotes are now properly supported.
v1.06 2013-12-18 Fixed Wii Remote disconnection issues (Smash Bros. Brawl strap screen crash).

Known Bugs

In a distribution via Riivolution, the game can freeze when a player completes a lap. This occurs for some Wii users.