Skip to content

docs(config): say which retired folder keys RomM still accepts #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gantoine wants to merge 1 commit into from
Closed

docs(config): say which retired folder keys RomM still accepts #157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/reference/configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,9 @@

<!-- prettier-ignore -->
!!! warning "`roms_folder` and `firmware_folder` were retired"
Each named one path segment that a template now spells out, so RomM refuses to start while either is set, printing the template that reproduces the layout. `roms_folder: "my_roms"` becomes `default: "my_roms/{platform}/{game}"`, and `firmware_folder: "firmware"` becomes `firmware: "firmware/{platform}"`.
Each named one path segment that a template now spells out. RomM ignores a leftover key, with a warning to remove it, when its value matches the default layout (`roms_folder: roms`, `firmware_folder: bios`) or when the matching `structure` key is already declared. Older releases wrote both defaults into `config.yml`, so most upgraded instances start without changes.

Any other value stops RomM at startup, and the log prints the template that reproduces the layout. `roms_folder: "my_roms"` becomes `default: "my_roms/{platform}/{game}"`, and `firmware_folder: "firmware"` becomes `firmware: "firmware/{platform}"`. With a Structure B `default` such as `"{platform}/roms/{game}"`, firmware used to sit beside each platform's ROMs, so `firmware_folder: bios` without a declared `firmware` stops startup and asks for `firmware: "{platform}/bios"`.

Check notice on line 172 in docs/reference/configuration-file.md

View workflow job for this annotation

GitHub Actions / Trunk Check

markdownlint(MD046) 

[new] Code block style

### `filesystem.skip_hash_calculation`

Expand Down
Loading