Difference between revisions of "Rom Mapping"

From RocketLauncher Wiki
Jump to navigation Jump to search
Line 20: Line 20:
 
You simply want to use another rom's naming schema that doesn't match HyperList's No-Intro style and that naming schema uses the same exact filename inside and out of the archive.
 
You simply want to use another rom's naming schema that doesn't match HyperList's No-Intro style and that naming schema uses the same exact filename inside and out of the archive.
  
<code>[Sega Rally 2 (USA)]
+
<pre style="color:green;">[Sega Rally 2 (USA)]
 
+
Alternate_Archive_Name=Sega Rally 2 v1.003 (1999)(Sega)(NTSC)(US)[!]</pre>
Alternate_Archive_Name=Sega Rally 2 v1.003 (1999)(Sega)(NTSC)(US)[!]</code>
 
  
  
Line 29: Line 28:
 
You want to use another rom's naming schema that doesn't match HyperList's No-Intro style and that naming schema uses a different filename inside the archive than what the archive filename uses.
 
You want to use another rom's naming schema that doesn't match HyperList's No-Intro style and that naming schema uses a different filename inside the archive than what the archive filename uses.
  
<code>[Sega Rally 2 (USA)]
+
<pre style="color:green;">[Sega Rally 2 (USA)]
 
 
 
Alternate_Archive_Name=Sega Rally 2 v1.003 (1999)(Sega)(NTSC)(US)[!]
 
Alternate_Archive_Name=Sega Rally 2 v1.003 (1999)(Sega)(NTSC)(US)[!]
 
+
Alternate_Rom_Name=Sega Rally 2 (Sega)(NTSC)(US)[!]</pre>
Alternate_Rom_Name=Sega Rally 2 (Sega)(NTSC)(US)[!]</code>
 
  
  
Line 40: Line 37:
 
Remap your database name to an uncompressed rom name. You do not need to define an Alternate_Archive_Name, simply define an Alternate_Rom_Name instead:
 
Remap your database name to an uncompressed rom name. You do not need to define an Alternate_Archive_Name, simply define an Alternate_Rom_Name instead:
  
<code>[Sega Rally 2 (USA)]
+
<pre style="color:green;">[Sega Rally 2 (USA)]
 
+
Alternate_Rom_Name=Sega Rally 2 (Sega)(NTSC)(US)[!]</pre>
Alternate_Rom_Name=Sega Rally 2 (Sega)(NTSC)(US)[!]</code>
 
  
  
Line 48: Line 44:
  
 
You want to build a specific list of roms for the launch menu. Set Show_All_Roms_In_Archive to false and create a detailed section like this:
 
You want to build a specific list of roms for the launch menu. Set Show_All_Roms_In_Archive to false and create a detailed section like this:
 
+
<pre style="color:green;">[Super Mario World (USA)]
<code>[Super Mario World (USA)]
 
 
 
 
Alternate_Archive_Name=Super Mario World
 
Alternate_Archive_Name=Super Mario World
 
 
Alternate_Rom_Name_1=Super Mario World (1991)(Nintendo)(US)[b]
 
Alternate_Rom_Name_1=Super Mario World (1991)(Nintendo)(US)[b]
 
 
Alternate_Rom_Name_2=Super Mario World (1991)(Nintendo)(US)
 
Alternate_Rom_Name_2=Super Mario World (1991)(Nintendo)(US)
 
 
Alternate_Rom_Name_3=Super Mario World (1991)(Nintendo)(US)[h]
 
Alternate_Rom_Name_3=Super Mario World (1991)(Nintendo)(US)[h]
 
 
Alternate_Rom_Name_4=Super Mario World (1991)(Nintendo)(US)[h2]
 
Alternate_Rom_Name_4=Super Mario World (1991)(Nintendo)(US)[h2]
 
 
Alternate_Rom_Name_5=Super Mario World (1991)(Nintendo)(US)[t]
 
Alternate_Rom_Name_5=Super Mario World (1991)(Nintendo)(US)[t]
 
 
Alternate_Rom_Name_6=Super Mario World (1991)(Nintendo)(US)[tr de]
 
Alternate_Rom_Name_6=Super Mario World (1991)(Nintendo)(US)[tr de]
 
+
Alternate_Rom_Name_7=Super Mario World (1991)(Nintendo)(US)[tr el]</pre>
Alternate_Rom_Name_7=Super Mario World (1991)(Nintendo)(US)[tr el]</code>
 
  
  
Line 72: Line 59:
 
You want to show a list of all roms available inside the Alternate_Archive_Name for the launch menu. Set Show_All_Roms_In_Archive to true and create a simple section like this:
 
You want to show a list of all roms available inside the Alternate_Archive_Name for the launch menu. Set Show_All_Roms_In_Archive to true and create a simple section like this:
  
<code>[Super Mario World (USA)]
+
<pre style="color:green;">[Super Mario World (USA)]
 
+
Alternate_Archive_Name=Super Mario World</pre>
Alternate_Archive_Name=Super Mario World</code>
 
  
  
Line 82: Line 68:
 
This method also allows you to show a list of alternate roms along with the rom listed in your database.
 
This method also allows you to show a list of alternate roms along with the rom listed in your database.
  
<code>[puckman]
+
<pre style="color:green;">[puckman]
 
 
 
Alternate_Rom_Name_1=pacmanbl
 
Alternate_Rom_Name_1=pacmanbl
 
 
Alternate_Rom_Name_2=pacmanbla
 
Alternate_Rom_Name_2=pacmanbla
 
 
Alternate_Rom_Name_3=pacheart
 
Alternate_Rom_Name_3=pacheart
 
 
Alternate_Rom_Name_4=pacman
 
Alternate_Rom_Name_4=pacman
 
+
Alternate_Rom_Name_5=pacmod</pre>
Alternate_Rom_Name_5=pacmod</code>
 
  
 
<u>Note:</u> The romExtension that gets sent to the module is the same one sent to HyperLaunch at launch. If your rom was a zip, the clone extension will be zip. It is impossible to look for an extension when this method does not look for another rom file. If you need to assign a different extension, it needs to be done in the module.
 
<u>Note:</u> The romExtension that gets sent to the module is the same one sent to HyperLaunch at launch. If your rom was a zip, the clone extension will be zip. It is impossible to look for an extension when this method does not look for another rom file. If you need to assign a different extension, it needs to be done in the module.
Line 100: Line 81:
  
 
Use normal artwork and database names for ZiNc while still launching the emu correctly. Roms must still be named with numbers:
 
Use normal artwork and database names for ZiNc while still launching the emu correctly. Roms must still be named with numbers:
 
+
<pre style="color:green;">[Aqua Rush]
<code>[Aqua Rush]
+
Alternate_Archive_Name=63</pre>
 
 
Alternate_Archive_Name=63</code>
 
  
  

Revision as of 18:14, 8 June 2015

Description

  • This feature allows you to use alternate rom and/or archive filenames, different than what's defined in your database (xml).
  • Main use of this is so you can use an official HyperList xml and match it up with your, using Tosec as an example, tosec-named ISOs
  • With the Launch Menu enabled, you can present the user with a choice of slightly different versions of roms to choose from. For example, USA, Spanish, Translated-Japanese, hacked, etc.
  • Backgrounds for the menu are pulled from your "Media\Backgrounds" folders.

Rom Mapping ini(s)

  • Found at ".\Settings\SystemName\Rom Mapping\*.ini". Ini(s) can be named whatever you want.
  • You need to create the ini file(s) if you want to use this feature. HyperLaunch will not create these for you. I suggest one ini file for each naming schema (tosec, trurip, redump, custom, etc..)
  • Rom_Extension still needs to include the extension of the rom inside the archive (ex. iso) and the extension of the archive (ex. 7z)
  • For each rom you want to remap, create a [Section] in this ini. The name of the section must match the game name sent to HyperLaunch (your rom name in your xml).
  • The Alternate_Archive_Name should point to the filename (w/o the extension) of the rom you want to load instead.
  • If you only want to define one alternate rom to look for, create a key Alternate_Rom_Name
  • If you need to define multiple rom names to look for, create multiple keys like this: Alternate_Rom_Name_1, Alternate_Rom_Name_2, Alternate_Rom_Name_3, etc.
  • Be careful, the more inis you have in your folder, the longer it will take to create the table as it has to scan each one and verify any matching sections and every alternate name will have an I/O check if it exists on your drive.


Scenario 1:

You simply want to use another rom's naming schema that doesn't match HyperList's No-Intro style and that naming schema uses the same exact filename inside and out of the archive.

[Sega Rally 2 (USA)]
Alternate_Archive_Name=Sega Rally 2 v1.003 (1999)(Sega)(NTSC)(US)[!]


Scenario 2:

You want to use another rom's naming schema that doesn't match HyperList's No-Intro style and that naming schema uses a different filename inside the archive than what the archive filename uses.

[Sega Rally 2 (USA)]
Alternate_Archive_Name=Sega Rally 2 v1.003 (1999)(Sega)(NTSC)(US)[!]
Alternate_Rom_Name=Sega Rally 2 (Sega)(NTSC)(US)[!]


Scenario 3:

Remap your database name to an uncompressed rom name. You do not need to define an Alternate_Archive_Name, simply define an Alternate_Rom_Name instead:

[Sega Rally 2 (USA)]
Alternate_Rom_Name=Sega Rally 2 (Sega)(NTSC)(US)[!]


Scenario 4:

You want to build a specific list of roms for the launch menu. Set Show_All_Roms_In_Archive to false and create a detailed section like this:

[Super Mario World (USA)]
Alternate_Archive_Name=Super Mario World
Alternate_Rom_Name_1=Super Mario World (1991)(Nintendo)(US)[b]
Alternate_Rom_Name_2=Super Mario World (1991)(Nintendo)(US)
Alternate_Rom_Name_3=Super Mario World (1991)(Nintendo)(US)[h]
Alternate_Rom_Name_4=Super Mario World (1991)(Nintendo)(US)[h2]
Alternate_Rom_Name_5=Super Mario World (1991)(Nintendo)(US)[t]
Alternate_Rom_Name_6=Super Mario World (1991)(Nintendo)(US)[tr de]
Alternate_Rom_Name_7=Super Mario World (1991)(Nintendo)(US)[tr el]


Scenario 5:

You want to show a list of all roms available inside the Alternate_Archive_Name for the launch menu. Set Show_All_Roms_In_Archive to true and create a simple section like this:

[Super Mario World (USA)]
Alternate_Archive_Name=Super Mario World


Scenario 6:

You want to show a list of all MAME Clone roms that don't actually exist in a folder or their names are not known in the launch menu and your front end is only showing parents. Set 7z_Enabled to false, SkipChecks to Rom Only, Rom Mapping to true, and Launch Menu to true. Now for each Parent game, list all the alternate roms as the clones. This method also allows you to show a list of alternate roms along with the rom listed in your database.

[puckman]
Alternate_Rom_Name_1=pacmanbl
Alternate_Rom_Name_2=pacmanbla
Alternate_Rom_Name_3=pacheart
Alternate_Rom_Name_4=pacman
Alternate_Rom_Name_5=pacmod

Note: The romExtension that gets sent to the module is the same one sent to HyperLaunch at launch. If your rom was a zip, the clone extension will be zip. It is impossible to look for an extension when this method does not look for another rom file. If you need to assign a different extension, it needs to be done in the module.


Bonus Scenario (same as 1):

Use normal artwork and database names for ZiNc while still launching the emu correctly. Roms must still be named with numbers:

[Aqua Rush]
Alternate_Archive_Name=63


Ini Keys

(These keys can be found in the Global HyperLaunch.ini and the system's HyperLaunch.ini)

Key Default Value Description
Rom_Mapping_Enabled false If true, will look in your Settings\SYSTEM\Rom Mapping folder for inis containing mapping information on what your actual rom files are called.
  • Will add a small lag to launch depending on your PC Hardware because it has to scan your ini files and create the table that contains your roms.
Rom_Mapping_Launch_Menu_Enabled false If true, will show a Menu with choices of roms to load upon selecting your game in your Frontend.
  • The choices in the menu are determined by what you have in your Rom Mapping inis.
  • Choices in menu can be further filtered by applying filters. To see filtered mode by default, change Default_Menu_List to filtered.
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3
row 2, cell 1 row 2, cell 2 row 2, cell 3


The Rom Mapping Filter