mister-devel/MkDocs_MiSTer
1
0
Fork 0
mirror of https://github.com/MiSTer-devel/MkDocs_MiSTer.git synced 2026-05-24 03:04:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #22 from wizzomafizzo/main

Browse Source 
Update MGL page
This commit is contained in:
birdybro
2022-09-22 08:33:33 -06:00
committed by GitHub
parent f465cedf0d 97af0132af
commit d8b2e43864
1 changed files with 75 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
docs/advanced/mgl.md
View File

@@ -1,76 +1,105 @@
MGL files are used as a custom method to load ROMs directly from the MiSTer FPGA's Menu core.
MGL files are used as a custom method to load games directly from the MiSTer FPGA's Menu core.
## MGL files run games automatically
They can be placed in the root of the SD card to show up in the top of the menu, or in a menu folder. A menu folder is a regular folder with an underscore (`_`) in front that will display in the menu. You can create your own menu folders.
You can add your favorite games to the main menu (below the Arcade, Computer, Console etc. folders) - or - e.g. inside a folder for instance called 'Favorites'. It needs to be named _Favorites in the file system to show up in the menu.
Each of your favorite games must have an MGL file to be accessible in the menu.
At the time of writing (late February 2022) MGL is not supported on the Atari ST, Minimig, Archie and Sharp cores.
Not all cores support MGL files, though all the most popular cores do. Console support is good, but computer cores generally don't work well with them.
## MGL Format
Examples:
MGLs are simple XML files with the file extension `.mgl`. Whatever name you give to an MGL file (excluding the extension) is what will be shown for its entry in the menu. E.g. `My Favorite Game.mgl` will display in the menu as `My Favorite Game`.
Example MGL files:
```xml
<mistergamedescription>
<rbf>_console/snes</rbf>
<file delay="2" type="f" index="0" path="dummy.snes"/>
<file delay="2" type="f" index="0" path="puzzles/dummy.sfc"/>
</mistergamedescription>
```
```xml
<mistergamedescription>
<rbf>_console/gameboy</rbf>
<file delay="1" type="f" index="1" path="dummy.gbc"/>
<rbf>_console/psx</rbf>
<file delay="1" type="s" index="1" path="dummy.chd"/>
</mistergamedescription>
```
```xml
<mistergamedescription>
<rbf>_Computer/C64</rbf>
<file delay="1" type="f" index="1" path="dummy.prg"/>
<file delay="1" type="f" index="1" path="some/other.zip/path/dummy.prg"/>
</mistergamedescription>
```
* `<rbf>`: path to the core and its name. If the core is outside the _console folder just its name.
* `<file delay=` amount of seconds to wait before load/mount (e.g. 1:turbografx16, neogeo, gba, gameboy, genesis, c64 and 2:snes).
* `type=` f: load file. s: mount
* `index=` 0 for most console cores but 1 for e.g. the NeoGeo and Gameboy cores.
* `path=` path to game file inside the core's games folder. E.g. Puzzles/Dummy.bin
```xml
<mistergamedescription>
<rbf>_Console/SMS</rbf>
<setname>GameGear</setname>
<file delay="1" type="f" index="2" path="dummy.gg"/>
</mistergamedescription>
```
All parameters must be present.
* `rbf`: Relative path to the core's RBF file from the SD root, excluding its file extension and timestamp.
* `setname`: Sets a core's name to this value, changing its games folder and config file.
* `file`: The file to be loaded into the core and its launch arguments.
* `delay` Amount of seconds to wait before load/mount.
* `type` Either `f` for load file to memory or `s` for mount file.
* `index` Pointer to slot where file is loaded in core.
* `path` Path to game file relative to the core's games folder.
If a core pops up the OSD menu after loading the game or the game doesn't load try increasing the delay. It could also be due to wrong the index number, file type or game file path so check those too.
The `rbf` and `file` tags must be present.
## MiSTer Core Index Numbers and File Types for MGL
The `setname` tag is optional. It will make a core temporarily point to a different games folder and config file. Useful for cores which play multiple systems, or often need to toggle between different configurations.
Here is a list with the MGL values for some cores:
The `type` and `index` attributes depend on what values were configured by the core's developer. See below for [how to check those](#finding-mgl-arguments).
| System | Corename | Delay | Index | Type |
| ------------------- | ------------ | :---: | :-----: | :--: |
| Arcade | Arcade | - | Use MRA | - |
| Atari 2600 | ATARI7800 | 1 | 0 | f |
| Atari 5200 | ATARI5200 | 1 | 1 | f |
| Atari 7800 | ATARI7800 | 1 | 1 | f |
| Atari Lynx | AtariLynx | 1 | 1 | f |
| Commodore 64 | C64 | 1 | 1 | f |
| Famicom Disk System | NES | 2 | 0 | f |
| Game Boy | GAMEBOY | 2 | 0 | f |
| Game Boy Color | GAMEBOY | 2 | 0 | f |
| Game Boy Advance | GBA | 2 | 0 | f |
| Genesis | Genesis | 1 | 0 | f |
| Game Gear | SMS | 1 | 2 | f |
| Mega CD | MegaCD | 1 | 0 | s |
| Neo Geo | NEOGEO | 1 | 1 | f |
| NES | NES | 2 | 0 | f |
| Sega 32X | S32X | 1 | 0 | f |
| Master System | SMS | 1 | 1 | f |
| Super NES | SNES | 2 | 0 | f |
| TurboGrafx 16 | TurboGrafx16 | 1 | 0 | f |
| TurboGrafx 16 CD | TurboGrafx16 | 1 | 0 | s |
| Playstation | PSX | 1 | 1 | s |
If a core pops up the OSD menu after loading the game or the game doesn't load, try increasing the `delay` value.
If the core you are looking for isn't in this list you can either test out the combinations yourself, or you can look at the code on GitHub for the core to figure out the values directly.
## MGL Arguments
For example, to get the values for the **TurboGrafx-16** core you can take a look at the file [TurboGrafx16.sv](https://github.com/MiSTer-devel/TurboGrafx16_MiSTer/blob/master/TurboGrafx16.sv){target=_blank} on GitHub to find the index numbers and file types supported by that core. First find the section that starts with `parameter CONF_STR` and in that section look for the ROM type you are loading/mounting. In this case it will be `"S0,CUECHD,Insert CD;"`. Notice the S0, that is the "s" type with index of 0.
Some MGL arguments for common cores:
| System | RBF | Delay | Index | Type |
| ------------------- | --------------------- | :---: | :-----: | :--: |
| Atari 2600/7800 | _Console/Atari7800 | 1 | 1 | f |
| Atari 5200 | _Console/Atari5200 | 1 | 1 | s |
| Atari Lynx | _Console/AtariLynx | 1 | 1 | f |
| Commodore 64 | _Computer/C64 | 1 | 1 | f |
| Famicom Disk System | _Console/NES | 2 | 1 | f |
| Game Boy (Color) | _Console/Gameboy | 2 | 1 | f |
| Game Boy Advance | _Console/GBA | 2 | 1 | f |
| Game Gear | _Console/SMS | 1 | 2 | f |
| Genesis | _Console/Genesis | 1 | 1 | f |
| Master System | _Console/SMS | 1 | 1 | f |
| Sega CD | _Console/MegaCD | 1 | 0 | s |
| Neo Geo | _Console/NeoGeo | 1 | 1 | f |
| NES | _Console/NES | 2 | 1 | f |
| Playstation | _Console/PSX | 1 | 1 | s |
| Sega 32X | _Console/S32X | 1 | 1 | f |
| SNES | _Console/SNES | 2 | 0 | f |
| TurboGrafx-16 | _Console/TurboGrafx16 | 1 | 0 | f |
| TurboGrafx-16 CD | _Console/TurboGrafx16 | 1 | 0 | s |
A more comprehensive list of MGL argments can be found [here](https://github.com/wizzomafizzo/mrext/blob/main/docs/systems.md).
## Arcade Cores
Arcade cores cannot be launched using MGL files. If you want to make a shortcut to an arcade core elsewhere in the menu, you'll instead have to *symlink* it there.
For example, either through SSH or the console (press `F9` from the menu):
```
# ln -s /media/fat/_Arcade/dummy.mra /media/fat
# ln -s /media/fat/_Arcade/cores /media/fat
```
This would make a shortcut to an arcade core in the root of the MiSTer menu. It can also be done with menu subfolders.
Take note of the second line, symlinking the `cores` folder. You have to do this once for each folder you want to symlink MRA files into.
## Finding MGL Arguments
If the core you are looking for isn't in these lists, you can either test out the combinations yourself, or you can look at the code on GitHub for the core to figure out the values directly.
For example, to get the values for the **TurboGrafx-16**, core you can take a look at the file [TurboGrafx16.sv](https://github.com/MiSTer-devel/TurboGrafx16_MiSTer/blob/master/TurboGrafx16.sv){target=_blank} on GitHub to find the index numbers and file types supported by that core. First find the section that starts with `parameter CONF_STR` and in that section look for the file type you are launching. In this case it will be `"S0,CUECHD,Insert CD;"`. Notice the S0, that is the "s" type with index of 0.
See the [Core Configuration String](../developer/conf_str.md) page for detailed information on this format.