Skip to content

Commit ea2e4e6

Browse files
committed
fix most errors
1 parent 3a8c79f commit ea2e4e6

10 files changed

Lines changed: 98 additions & 88 deletions

File tree

.github/resources/social-preview.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/API-and-Development/API-Reference.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ RomM automatically generates interactive API documentation using OpenAPI (Swagge
1010
- **ReDoc**: Available at `http://your-instance:3000/api/redoc`
1111

1212
These interactive docs allow you to:
13+
1314
- Browse all available endpoints
1415
- View request/response schemas
1516
- Test API calls directly from your browser
@@ -19,6 +20,7 @@ These interactive docs allow you to:
1920
## Base URL
2021

2122
The API base URL is typically:
23+
2224
```text
2325
http://your-instance:3000/api
2426
```
@@ -39,6 +41,7 @@ When using OAuth2, you'll need to obtain a token from `/api/token` endpoint and
3941
The API uses OAuth2 scopes to control access to different resources:
4042

4143
**Read Scopes:**
44+
4245
- `me.read` - View your profile
4346
- `roms.read` - View ROMs
4447
- `platforms.read` - View platforms
@@ -49,6 +52,7 @@ The API uses OAuth2 scopes to control access to different resources:
4952
- `users.read` - View users
5053

5154
**Write Scopes:**
55+
5256
- `me.write` - Modify your profile
5357
- `assets.write` - Modify assets
5458
- `roms.user.write` - Modify user-rom properties
@@ -64,12 +68,14 @@ The API uses OAuth2 scopes to control access to different resources:
6468
The RomM API provides comprehensive endpoints for managing all aspects of your ROM collection:
6569

6670
### Core Resources
71+
6772
- **Platforms** - Manage and configure gaming platforms
6873
- **ROMs** - Full CRUD operations for ROM files with extensive filtering, searching, and metadata matching
6974
- **Collections** - Create and manage ROM collections, smart collections, and virtual collections
7075
- **Users** - User management, authentication, invite links, and profiles
7176

7277
### Supporting Features
78+
7379
- **Authentication** - OAuth2 token management, OIDC login, password resets
7480
- **Search** - Metadata provider search for ROMs and covers
7581
- **Tasks** - Background task management and execution
@@ -121,22 +127,22 @@ rom = response.json()
121127
### Using JavaScript/Node.js
122128

123129
```javascript
124-
const axios = require('axios');
130+
const axios = require("axios");
125131

126132
// Setup authentication
127133
const api = axios.create({
128-
baseURL: 'http://your-instance:3000/api',
129-
auth: {
130-
username: 'username',
131-
password: 'password'
132-
}
134+
baseURL: "http://your-instance:3000/api",
135+
auth: {
136+
username: "username",
137+
password: "password",
138+
},
133139
});
134140

135141
// Get all libraries
136-
const libraries = await api.get('/libraries');
142+
const libraries = await api.get("/libraries");
137143

138144
// Get a specific ROM
139-
const rom = await api.get('/roms/123');
145+
const rom = await api.get("/roms/123");
140146
```
141147

142148
## OpenAPI Specification
@@ -157,4 +163,3 @@ For API-specific questions or issues:
157163
2. Review the code in the [RomM repository](https://github.com/rommapp/romm)
158164
3. Open an issue on [GitHub](https://github.com/rommapp/romm/issues)
159165
4. Join the [Discord community](https://discord.com/invite/romm)
160-

docs/API-and-Development/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,3 @@ Welcome to the RomM API & Development documentation. This section contains resou
1212
- **[API Reference](API-Reference.md)** - Complete API documentation with endpoints, schemas, and examples
1313
- **[Contributing](Contributing.md)** - Guidelines for contributing code, translations, and documentation
1414
- **[Development Setup](Development-Setup.md)** - How to set up your development environment
15-

docs/Getting-Started/Configuration-File.md

Lines changed: 62 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Exclude entire platforms (folders) from being scanned.
1717

1818
```yaml
1919
exclude:
20-
platforms: ["ps", "ngc", "gba"]
20+
platforms: ["ps", "ngc", "gba"]
2121
```
2222
2323
### ROMs
@@ -35,10 +35,10 @@ Applies to ROMs that are single files (not in subfolders).
3535
3636
```yaml
3737
exclude:
38-
roms:
39-
single_file:
40-
extensions: ["xml", "txt"]
41-
names: ["info.txt", "._*", "*.nfo"]
38+
roms:
39+
single_file:
40+
extensions: ["xml", "txt"]
41+
names: ["info.txt", "._*", "*.nfo"]
4242
```
4343
4444
#### Multi-File ROMs
@@ -53,12 +53,12 @@ Applies to ROMs stored as folders (multi-disc, with DLC, etc.).
5353
5454
```yaml
5555
exclude:
56-
roms:
57-
multi_file:
58-
names: ["final fantasy VII", "DLC"]
59-
parts:
60-
names: ["data.xml", "._*"]
61-
extensions: ["xml", "txt"]
56+
roms:
57+
multi_file:
58+
names: ["final fantasy VII", "DLC"]
59+
parts:
60+
names: ["data.xml", "._*"]
61+
extensions: ["xml", "txt"]
6262
```
6363
6464
---
@@ -67,17 +67,17 @@ exclude:
6767
6868
Customize how RomM interprets your folder and platform names.
6969
70-
### Platforms
70+
### Custom Folder Names
7171
7272
Map your custom folder names to RomM's recognized platform names.
7373
7474
**Example:**
7575
7676
```yaml
7777
system:
78-
platforms:
79-
gc: "ngc" # Treats 'gc' folder as GameCube
80-
psx: "ps" # Treats 'psx' folder as PlayStation
78+
platforms:
79+
gc: "ngc" # Treats 'gc' folder as GameCube
80+
psx: "ps" # Treats 'psx' folder as PlayStation
8181
```
8282
8383
### Versions
@@ -88,8 +88,8 @@ Associate a platform with its main version. This also tells RomM to fetch metada
8888
8989
```yaml
9090
system:
91-
versions:
92-
naomi: "arcade"
91+
versions:
92+
naomi: "arcade"
9393
```
9494
9595
---
@@ -104,7 +104,7 @@ If your ROMs folder is named `my_roms` instead of `roms`:
104104

105105
```yaml
106106
filesystem:
107-
roms_folder: "my_roms"
107+
roms_folder: "my_roms"
108108
```
109109

110110
---
@@ -137,11 +137,11 @@ Controls metadata provider priority order.
137137

138138
```yaml
139139
scan:
140-
priority:
141-
metadata:
142-
- "igdb"
143-
- "ss"
144-
- "moby"
140+
priority:
141+
metadata:
142+
- "igdb"
143+
- "ss"
144+
- "moby"
145145
```
146146

147147
#### Artwork
@@ -154,11 +154,11 @@ Controls artwork provider priority order for cover art and screenshots.
154154

155155
```yaml
156156
scan:
157-
priority:
158-
artwork:
159-
- "igdb"
160-
- "ss"
161-
- "moby"
157+
priority:
158+
artwork:
159+
- "igdb"
160+
- "ss"
161+
- "moby"
162162
```
163163

164164
#### Region
@@ -171,11 +171,11 @@ Sets preferred region for cover art and game title (Screenscraper only).
171171

172172
```yaml
173173
scan:
174-
priority:
175-
region:
176-
- "us"
177-
- "eu"
178-
- "jp"
174+
priority:
175+
region:
176+
- "us"
177+
- "eu"
178+
- "jp"
179179
```
180180

181181
#### Language
@@ -188,11 +188,11 @@ Sets preferred language for cover art and game title (Screenscraper only).
188188

189189
```yaml
190190
scan:
191-
priority:
192-
language:
193-
- "en"
194-
- "es"
195-
- "fr"
191+
priority:
192+
language:
193+
- "en"
194+
- "es"
195+
- "fr"
196196
```
197197

198198
### Media
@@ -217,11 +217,11 @@ Configures which media assets to download (Screenscraper and ES-DE gamelist.xml
217217

218218
```yaml
219219
scan:
220-
media:
221-
- box2d
222-
- screenshot
223-
- manual
224-
- bezel
220+
media:
221+
- box2d
222+
- screenshot
223+
- manual
224+
- bezel
225225
```
226226

227227
---
@@ -238,7 +238,7 @@ Enable debug mode to log available options to the browser console.
238238

239239
```yaml
240240
emulatorjs:
241-
debug: true
241+
debug: true
242242
```
243243

244244
### Cache Limit
@@ -249,7 +249,7 @@ Cache limit per ROM in bytes. Set to `null` for unlimited.
249249

250250
```yaml
251251
emulatorjs:
252-
cache_limit: 52428800 # 50 MB
252+
cache_limit: 52428800 # 50 MB
253253
```
254254

255255
### Settings
@@ -260,13 +260,13 @@ Configure core-specific settings. Use `default` to apply settings to all cores.
260260

261261
```yaml
262262
emulatorjs:
263-
settings:
264-
parallel_n64: # Use the exact core name
265-
vsync: disable
266-
snes9x:
267-
snes9x_region: ntsc
268-
default: # These settings apply to all cores
269-
fps: show
263+
settings:
264+
parallel_n64: # Use the exact core name
265+
vsync: disable
266+
snes9x:
267+
snes9x_region: ntsc
268+
default: # These settings apply to all cores
269+
fps: show
270270
```
271271

272272
### Controls
@@ -277,16 +277,16 @@ Map keyboard and controller controls for each player.
277277

278278
```yaml
279279
emulatorjs:
280-
controls:
281-
snes9x:
282-
0: # Player 1
283-
0: # Button mapping
284-
value: x # Keyboard mapping
285-
value2: BUTTON_2 # Controller mapping
286-
1: # Player 2
287-
0:
288-
value: /
289-
value2: BUTTON_2
280+
controls:
281+
snes9x:
282+
0: # Player 1
283+
0: # Button mapping
284+
value: x # Keyboard mapping
285+
value2: BUTTON_2 # Controller mapping
286+
1: # Player 2
287+
0:
288+
value: /
289+
value2: BUTTON_2
290290
```
291291

292292
See [EmulatorJS documentation](https://emulatorjs.org/docs4devs/control-mapping/) for control mapping details.

docs/Getting-Started/Environment-Variables.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ This is a complete list of available environment variables; required variables a
5555
| REDIS_USERNAME | Username for Redis/Valkey instance | | |
5656
| REDIS_PASSWORD | Password for Redis/Valkey instance | | |
5757
| REDIS_DB | Database number for Redis/Valkey instance | | `0` |
58-
| REDIS_SSL | Enable SSL for Redis/Valkey instance | | `false` |
58+
| REDIS_SSL | Enable SSL for Redis/Valkey instance | | `false` |
5959
| SENTRY_DSN | DSN for Sentry error tracking | | |
6060

6161
## Metadata providers
@@ -73,8 +73,8 @@ This is a complete list of available environment variables; required variables a
7373
| LAUNCHBOX_API_ENABLED | Enable LaunchBox API integration | | `false` |
7474
| PLAYMATCH_API_ENABLED | Enable PlayMatch API integration | | `false` |
7575
| HASHEOUS_API_ENABLED | Enable Hasheous API integration | | `false` |
76-
| FLASHPOINT_API_ENABLED | Enable Flashpoint API integration | | `false` |
77-
| HLTB_API_ENABLED | Enable HowLongToBeat API integration | | `false` |
76+
| FLASHPOINT_API_ENABLED | Enable Flashpoint API integration | | `false` |
77+
| HLTB_API_ENABLED | Enable HowLongToBeat API integration | | `false` |
7878

7979
## Authentication
8080

docs/Getting-Started/Metadata-Providers.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Here are some combinations you can use based on your needs:
2222

2323
- Supports 125+ popular systems
2424
- ScreenScraper provides titles, descriptions, cover art, screenshots and manuals
25-
- With the option for 3D boxes and CD/cartridge covers
25+
- With the option for 3D boxes and CD/cartridge covers
2626
- Retroachievements provides achievement progress
2727
- **Use this if you want to avoid Twitch/Amazon products**
2828

@@ -137,17 +137,17 @@ EmulationStation, and it's modern successor ES-DE, use a custom XML format to st
137137

138138
```yaml
139139
library/
140-
└─ roms/
140+
└─ roms/
141141
└─ gba/
142-
├─ game_1.gba
143-
├─ game_2.gba
144-
├─ gamelist.xml
145-
├─ 3dboxes/
146-
│ ├─ game_1.png
147-
│ └─ game_2.png
148-
├─ covers/
149-
├─ screenshots/
150-
└─ etc...
142+
├─ game_1.gba
143+
├─ game_2.gba
144+
├─ gamelist.xml
145+
├─ 3dboxes/
146+
│ ├─ game_1.png
147+
│ └─ game_2.png
148+
├─ covers/
149+
├─ screenshots/
150+
└─ etc...
151151
```
152152

153153
## Metadata Tags in Filenames

0 commit comments

Comments
 (0)