Skip to content

Commit ceb67d8

Browse files
BrandonKowalskiBrandonKowalski
committed
docs: add Allium and Onion platform mapping tables
Generate platform.md docs from existing JSON mappings. Add both to mkdocs nav and gen-platforms tool.
1 parent bc4ed1b commit ceb67d8

4 files changed

Lines changed: 168 additions & 4 deletions

File tree

‎docs/platforms/allium.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Allium Platform Mappings
2+
3+
This table shows the mappings of RomM Fs Slug to Allium's platform folders.
4+
5+
| Platform Name | RomM Fs Slug | Folder(s) |
6+
|-------------------------------|----------------------------|-------------------------------------------------|
7+
| 3DO Interactive Multiplayer | 3do | *(none)* |
8+
| Amiga | amiga | AMIGA |
9+
| Amstrad CPC | acpc | CPC |
10+
| Arcade | arcade | ARCADE |
11+
| Arduboy | arduboy | ARDUBOY |
12+
| Atari 2600 | atari2600 | ATARI |
13+
| Atari 5200 | atari5200 | FIFTYTWOHUNDRED |
14+
| Atari 7800 | atari7800 | SEVENTYEIGHTHUNDRED |
15+
| Atari Jaguar | jaguar | *(none)* |
16+
| Atari Lynx | lynx | LYNX |
17+
| Atari ST/STE | atari-st | ATARIST |
18+
| Cave Story | cave-story | *(none)* |
19+
| ColecoVision | colecovision | COLECO |
20+
| Commodore 128 | c128 | *(none)* |
21+
| Commodore C64/128/MAX | c64 | COMMODORE |
22+
| Commodore PET | cpet | *(none)* |
23+
| Commodore VIC-20 | vic-20 | VIC20 |
24+
| DOS | dos | *(none)* |
25+
| Dreamcast | dc | DC |
26+
| Fairchild Channel F | fairchild-channel-f | FAIRCHILD |
27+
| Family Computer | famicom | FC |
28+
| Family Computer Disk System | fds | FDS |
29+
| Galaksija | galaksija | *(none)* |
30+
| Game & Watch | g-and-w | GW |
31+
| Game Boy | gb | GB |
32+
| Game Boy Advance | gba | GBA |
33+
| Game Boy Color | gbc | GBC |
34+
| Intellivision | intellivision | INTELLIVISION |
35+
| J2ME | j2me | *(none)* |
36+
| Mega Duck/Cougar Boy | mega-duck-slash-cougar-boy | *(none)* |
37+
| MSX | msx | MSX |
38+
| Neo Geo AES | neogeoaes | *(none)* |
39+
| Neo Geo CD | neo-geo-cd | NEOCD |
40+
| Neo Geo MVS | neogeomvs | *(none)* |
41+
| Neo Geo Pocket | neo-geo-pocket | NGP |
42+
| Neo Geo Pocket Color | neo-geo-pocket-color | NGPC |
43+
| Nintendo 3DS | 3ds | *(none)* |
44+
| Nintendo 64 | n64 | N64 |
45+
| Nintendo DS | nds | NDS |
46+
| Nintendo Entertainment System | nes | FC |
47+
| Odyssey | odyssey | ODYSSEY |
48+
| OpenBOR | openbor | OPENBOR |
49+
| PC Engine SuperGrafx | supergrafx | SGFX |
50+
| PC-8000 | pc-8000 | *(none)* |
51+
| PC-9800 Series | pc-9800-series | *(none)* |
52+
| PC-FX | pc-fx | *(none)* |
53+
| Philips CD-i | philips-cd-i | *(none)* |
54+
| PICO-8 | pico | PICO8, FAKE08 |
55+
| PICO-8 | pico-8 | PICO8, FAKE08 |
56+
| PlayStation | psx | PS |
57+
| PlayStation 2 | ps2 | PS2 |
58+
| PlayStation Portable | psp | PSP |
59+
| Pokemon Mini | pokemon-mini | POKE |
60+
| Sega 32X | sega32 | THIRTYTWOX |
61+
| Sega CD | segacd | SEGACD |
62+
| Sega Game Gear | gamegear | GG |
63+
| Sega Genesis | genesis | MD |
64+
| Sega Master System | sms | MS |
65+
| Sega Saturn | saturn | *(none)* |
66+
| SG-1000 | sg1000 | SEGASGONE |
67+
| Sharp X1 | x1 | *(none)* |
68+
| Sharp X68000 | sharp-x68000 | X68000 |
69+
| Super Famicom | sfam | SFC |
70+
| Super Nintendo | snes | SFC |
71+
| Supervision | supervision | SUPERVISION |
72+
| TIC-80 | tic-80 | TIC |
73+
| TurboGrafx-16 | tg16 | PCE |
74+
| TurboGrafx-CD | turbografx-cd | PCECD |
75+
| Vectrex | vectrex | VECTREX |
76+
| Virtual Boy | virtualboy | VB |
77+
| WonderSwan | wonderswan | WS |
78+
| WonderSwan Color | wonderswan-color | WSC |
79+
| ZX Spectrum | zxs | ZXS |
80+
| ZX81 | zx81 | *(none)* |

‎docs/platforms/onion.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Onion Platform Mappings
2+
3+
This table shows the mappings of RomM Fs Slug to Onion's platform folders.
4+
5+
| Platform Name | RomM Fs Slug | Folder(s) |
6+
|-------------------------------|----------------------------|-------------------------------------------------|
7+
| 3DO Interactive Multiplayer | 3do | *(none)* |
8+
| Amiga | amiga | AMIGA |
9+
| Amstrad CPC | acpc | CPC |
10+
| Arcade | arcade | ARCADE |
11+
| Arduboy | arduboy | ARDUBOY |
12+
| Atari 2600 | atari2600 | ATARI |
13+
| Atari 5200 | atari5200 | FIFTYTWOHUNDRED |
14+
| Atari 7800 | atari7800 | SEVENTYEIGHTHUNDRED |
15+
| Atari Jaguar | jaguar | *(none)* |
16+
| Atari Lynx | lynx | LYNX |
17+
| Atari ST/STE | atari-st | ATARIST |
18+
| Cave Story | cave-story | *(none)* |
19+
| ColecoVision | colecovision | COLECO |
20+
| Commodore 128 | c128 | *(none)* |
21+
| Commodore C64/128/MAX | c64 | COMMODORE |
22+
| Commodore PET | cpet | *(none)* |
23+
| Commodore VIC-20 | vic-20 | VIC20 |
24+
| DOS | dos | DOS |
25+
| Dreamcast | dc | DC |
26+
| Fairchild Channel F | fairchild-channel-f | FAIRCHILD |
27+
| Family Computer | famicom | FC |
28+
| Family Computer Disk System | fds | FDS |
29+
| Galaksija | galaksija | *(none)* |
30+
| Game & Watch | g-and-w | GW |
31+
| Game Boy | gb | GB |
32+
| Game Boy Advance | gba | GBA |
33+
| Game Boy Color | gbc | GBC |
34+
| Intellivision | intellivision | INTELLIVISION |
35+
| J2ME | j2me | *(none)* |
36+
| Mega Duck/Cougar Boy | mega-duck-slash-cougar-boy | MEGADUCK |
37+
| MSX | msx | MSX |
38+
| Neo Geo AES | neogeoaes | NEOGEO |
39+
| Neo Geo CD | neo-geo-cd | NEOCD |
40+
| Neo Geo MVS | neogeomvs | NEOGEO |
41+
| Neo Geo Pocket | neo-geo-pocket | NGP |
42+
| Neo Geo Pocket Color | neo-geo-pocket-color | NGPC |
43+
| Nintendo 3DS | 3ds | *(none)* |
44+
| Nintendo 64 | n64 | N64 |
45+
| Nintendo DS | nds | NDS |
46+
| Nintendo Entertainment System | nes | FC |
47+
| Odyssey | odyssey | ODYSSEY |
48+
| OpenBOR | openbor | OPENBOR |
49+
| PC Engine SuperGrafx | supergrafx | SGFX |
50+
| PC-8000 | pc-8000 | *(none)* |
51+
| PC-9800 Series | pc-9800-series | *(none)* |
52+
| PC-FX | pc-fx | *(none)* |
53+
| Philips CD-i | philips-cd-i | *(none)* |
54+
| PICO-8 | pico | PICO8, FAKE08 |
55+
| PICO-8 | pico-8 | PICO8, FAKE08 |
56+
| PlayStation | psx | PS |
57+
| PlayStation 2 | ps2 | PS2 |
58+
| PlayStation Portable | psp | PSP |
59+
| Pokemon Mini | pokemon-mini | POKE |
60+
| Sega 32X | sega32 | THIRTYTWOX |
61+
| Sega CD | segacd | SEGACD |
62+
| Sega Game Gear | gamegear | GG |
63+
| Sega Genesis | genesis | MD |
64+
| Sega Master System | sms | MS |
65+
| Sega Saturn | saturn | *(none)* |
66+
| SG-1000 | sg1000 | SEGASGONE |
67+
| Sharp X1 | x1 | *(none)* |
68+
| Sharp X68000 | sharp-x68000 | X68000 |
69+
| Super Famicom | sfam | SFC |
70+
| Super Nintendo | snes | SFC |
71+
| Supervision | supervision | SUPERVISION |
72+
| TIC-80 | tic-80 | TIC |
73+
| TurboGrafx-16 | tg16 | PCE |
74+
| TurboGrafx-CD | turbografx-cd | PCECD |
75+
| Vectrex | vectrex | VECTREX |
76+
| Virtual Boy | virtualboy | VB |
77+
| WonderSwan | wonderswan | WS |
78+
| WonderSwan Color | wonderswan-color | WSC |
79+
| ZX Spectrum | zxs | ZXS |
80+
| ZX81 | zx81 | *(none)* |

‎mkdocs.yml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,15 @@ nav:
8080
- Settings Reference: usage/settings.md
8181
- Save Sync: usage/save-sync.md
8282
- CFW Specific Info:
83-
- muOS: platforms/muos.md
83+
- Allium: platforms/allium.md
84+
- Batocera: platforms/BATOCERA.md
8485
- Knulli: platforms/knulli.md
86+
- muOS: platforms/muos.md
87+
- NextUI: platforms/nextui.md
88+
- Onion: platforms/onion.md
8589
- ROCKNIX: platforms/rocknix.md
8690
- Spruce: platforms/spruce.md
87-
- NextUI: platforms/nextui.md
8891
- TrimUI: platforms/trimui.md
89-
- Batocera: platforms/BATOCERA.md
9092
- Contributing:
9193
- contributing/index.md
9294
- Development Guide: contributing/development.md

‎tools/gen-platforms/main.go‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,12 @@ import (
1818
)
1919

2020
var cfwMapping = map[string]string{
21+
"ALLIUM": "allium",
2122
"BATOCERA": "batocera",
2223
"KNULLI": "knulli",
2324
"MUOS": "muos",
2425
"NEXTUI": "nextui",
26+
"ONION": "onion",
2527
"ROCKNIX": "rocknix",
2628
"SPRUCE": "spruce",
2729
"TRIMUI": "trimui",
@@ -34,7 +36,7 @@ func main() {
3436
arg := strings.ToUpper(os.Args[1])
3537
if _, ok := cfwMapping[arg]; !ok {
3638
fmt.Fprintf(os.Stderr, "Unknown CFW: %s\n", os.Args[1])
37-
fmt.Fprintf(os.Stderr, "Valid options: batocera, knulli, muos, nextui, rocknix, spruce, trimui\n")
39+
fmt.Fprintf(os.Stderr, "Valid options: allium, batocera, knulli, muos, nextui, onion, rocknix, spruce, trimui\n")
3840
os.Exit(1)
3941
}
4042
targets = []string{arg}

0 commit comments

Comments
 (0)