Skip to content

Commit a739655

Browse files
committed
Add SYSTEMS.md
1 parent c48f178 commit a739655

File tree

2 files changed

+185
-1
lines changed

2 files changed

+185
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ All systems must be contained within the <systemList> tag.-->
148148
<!-- A "pretty" name, displayed in the menus and such. This one is optional. -->
149149
<fullname>Super Nintendo Entertainment System</fullname>
150150

151-
<!-- The path to start searching for ROMs in. '~' will be expanded to $HOME or %HOMEPATH%, depending on platform.
151+
<!-- The path to start searching for ROMs in. '~' will be expanded to $HOME or %HOMEPATH%, depending on platform.
152152
All subdirectories (and non-recursive links) will be included. -->
153153
<path>~/roms/snes</path>
154154

@@ -180,6 +180,7 @@ The following "tags" are replaced by ES in launch commands:
180180

181181
`%ROM_RAW%` - Replaced with the unescaped, absolute path to the selected ROM. If your emulator is picky about paths, you might want to use this instead of %ROM%, but enclosed in quotes.
182182

183+
See [SYSTEMS.md](SYSTEMS.md) for some live examples in EmulationStation.
183184

184185
gamelist.xml
185186
============

SYSTEMS.md

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# Systems
2+
3+
This outlines how to add support for many different systems into EmulationStation through configuration of `es_systems.cfg`.
4+
5+
## Nintendo Wii
6+
7+
### [Dolphin](http://dolphin-emu.org/)
8+
In Options → Configure → Interface, disable *Confirm to Stop*.
9+
``` xml
10+
<system>
11+
<name>wii</name>
12+
<fullname>Nintendo Wii</fullname>
13+
<path>/rom/path/here</path>
14+
<extension>.elf .dol .gcm .iso .wbfs .ciso .gcz .wad</extension>
15+
<command>dolphin-emu -b -e %ROM%</command>
16+
<platform>wii</platform>
17+
<theme>wii</theme>
18+
</system>
19+
```
20+
21+
22+
## [Nintendo GameCube](https://en.wikipedia.org/wiki/GameCube)
23+
24+
### [Dolphin](http://dolphin-emu.org/)
25+
In Options → Configure → Interface, disable *Confirm to Stop*.
26+
``` xml
27+
<system>
28+
<name>gc</name>
29+
<fullname>Nintendo GameCube</fullname>
30+
<path>/rom/path/here</path>
31+
<extension>.elf .dol .gcm .iso .wbfs .ciso .gcz .wad</extension>
32+
<command>dolphin-emu -b -e %ROM%</command>
33+
<platform>gc</platform>
34+
<theme>gc</theme>
35+
</system>
36+
```
37+
38+
39+
## Nintendo 64
40+
41+
### [RetroArch](http://libretro.com)
42+
Requires a [Nintendo N64 Core](http://wiki.libretro.com/index.php?title=Nintendo_N64_Core_Compatibility), like [`libretro-mupen64plus`](http://wiki.libretro.com/index.php?title=Mupen64Plus).
43+
``` xml
44+
<system>
45+
<name>n64</name>
46+
<fullname>Nintendo 64</fullname>
47+
<path>/path/to/roms</path>
48+
<extension>.z64 .zip .n64</extension>
49+
<command>retroarch --fullscreen -L /usr/lib/libretro/mupen64plus_libretro.so %ROM%</command>
50+
<platform>n64</platform>
51+
<theme>n64</theme>
52+
</system>
53+
```
54+
55+
### [Mupen64Plus](https://code.google.com/p/mupen64plus/)
56+
``` xml
57+
<system>
58+
<name>n64</name>
59+
<fullname>Nintendo 64</fullname>
60+
<path>/path/to/roms</path>
61+
<extension>.z64 .zip .n64</extension>
62+
<command>mupen64plus --nogui --noask --noosd --fullscreen %ROM%</command>
63+
<platform>n64</platform>
64+
<theme>n64</theme>
65+
</system>
66+
```
67+
68+
69+
## Nintendo Entertainment System
70+
71+
### [RetroArch](http://libretro.com)
72+
Requires a [Nintendo NES Core](http://wiki.libretro.com/index.php?title=Nintendo_NES_Core_Compatibility), like [`libretro-fceumm`](http://wiki.libretro.com/index.php?title=FCEUmm).
73+
``` xml
74+
<system>
75+
<name>nes</name>
76+
<fullname>Nintendo Entertainment System</fullname>
77+
<path>/path/to/roms</path>
78+
<extension>.nes .NES .zip</extension>
79+
<command>retroarch --fullscreen -L /usr/lib/libretro/fceumm_libretro.so %ROM%</command>
80+
<platform>nes</platform>
81+
<theme>nes</theme>
82+
</system>
83+
```
84+
85+
### [Mednafen](http://mednafen.sourceforge.net/)
86+
``` xml
87+
<system>
88+
<name>nes</name>
89+
<fullname>Nintendo Entertainment System</fullname>
90+
<path>/path/to/roms</path>
91+
<extension>.nes .NES .zip</extension>
92+
<command>mednafen -video.fs 1 %ROM%</command>
93+
<platform>nes</platform>
94+
<theme>nes</theme>
95+
</system>
96+
```
97+
98+
99+
## Super Nintendo Entertainment System
100+
101+
### [ZSNES](http://zsnes.com/)
102+
``` xml
103+
<system>
104+
<name>snes</name>
105+
<fullname>Super Nintendo Entertainment System</fullname>
106+
<path>/path/to/roms</path>
107+
<extension>.smc .sfc .swc .fig .mgd .mgh .ufo .bin .gd3 .gd7 .usa .eur .jap .aus .st .bs .dx2 .048 .058 .078 .1 .a .gz .zip .jma</extension>
108+
<command>zsnes -m %ROM%</command>
109+
<platform>snes</platform>
110+
<theme>snes</theme>
111+
</system>
112+
```
113+
114+
### [RetroArch](http://libretro.com)
115+
Requires a [Nintendo SNES Core](http://wiki.libretro.com/index.php?title=Nintendo_SNES_Core_Compatibility), like [`libretro-snes9x-next`](http://wiki.libretro.com/index.php?title=SNES9x_Next).
116+
``` xml
117+
<system>
118+
<name>snes</name>
119+
<fullname>Super Nintendo Entertainment System</fullname>
120+
<path>/path/to/roms</path>
121+
<extension>.smc .sfc .fig .bin .zip</extension>
122+
<command>retroarch --fullscreen -L /usr/lib/libretro/snes9x_next_libretro.so %ROM%</command>
123+
<platform>snes</platform>
124+
<theme>snes</theme>
125+
</system>
126+
```
127+
128+
## Atari 2600
129+
130+
### [Stella](http://stella.sourceforge.net/)
131+
``` xml
132+
<system>
133+
<name>atari2600</name>
134+
<fullname>Atari 2600</fullname>
135+
<path>/path/to/roms</path>
136+
<extension>.bin .zip</extension>
137+
<command>stella %ROM%</command>
138+
<platform>atari2600</platform>
139+
<theme>atari2600</theme>
140+
</system>
141+
```
142+
143+
## Nintendo GameBoy Advance
144+
145+
### [Mednafen](http://mednafen.sourceforge.net/)
146+
``` xml
147+
<system>
148+
<name>gba</name>
149+
<fullname>Nintendo GameBoy Advance</fullname>
150+
<path>/path/to/roms</path>
151+
<extension>.gba .zip</extension>
152+
<command>mednafen -video.fs 1 %ROM%</command>
153+
<platform>gba</platform>
154+
<theme>gba</theme>
155+
</system>
156+
```
157+
158+
### [VisualBoyAdvance](http://sourceforge.net/projects/vba/)
159+
``` xml
160+
<system>
161+
<name>gba</name>
162+
<fullname>Nintendo GameBoy Advance</fullname>
163+
<path>/path/to/roms</path>
164+
<extension>.gba .zip</extension>
165+
<command>VisualBoyAdvance -F %ROM%</command>
166+
<platform>gba</platform>
167+
<theme>gba</theme>
168+
</system>
169+
```
170+
171+
### [RetroArch](http://libretro.com)
172+
Requires a [Nintendo GameBoy Advance Core](http://wiki.libretro.com/index.php?title=Nintendo_Game_Boy_Advance_Core_Compatibility), like [`libretro-vba-next`](http://wiki.libretro.com/index.php?title=VBA_Next).
173+
``` xml
174+
<system>
175+
<name>gba</name>
176+
<fullname>Nintendo GameBoy Advance</fullname>
177+
<path>/path/to/roms</path>
178+
<extension>.gba .zip</extension>
179+
<command>retroarch --fullscreen -L /usr/lib/libretro/vba_next_libretro.so %ROM%</command>
180+
<platform>gba</platform>
181+
<theme>gba</theme>
182+
</system>
183+
```

0 commit comments

Comments
 (0)