Skip to content
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.

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

Already on GitHub? Sign in to your account

External option documentation #78242

Merged

Conversation

Procyonae
Copy link
Contributor

Summary

None

Purpose of change

External options aren't even mentioned in documentation
Loading comments and storing them twice is very dumb

Describe the solution

Renames game_balance.json to external_options.json bc most of them have nothing to do with game balance, all the external options randomly just got lumped into it at some point.
Adds simple documentation mainly pointing modders to /core/external_options.json
Changes the "info" comments to "//" comments and removes dupes in mods as they're unlikely to remain up to date

Describe alternatives you've considered

Make a table of id(name), type, default and a description of each external option rather than having the comments in the dda file but that felt redundant with how simple the type currently is, the file is pretty much already a table that doesn't need maintaining separately.

Testing

Game compiles and loads

Additional context

@github-actions github-actions bot added <Documentation> Design documents, internal info, guides and help. [JSON] Changes (can be) made in JSON Map / Mapgen Overmap, Mapgen, Map extras, Map display [C++] Changes (can be) made in C++. Previously named `Code` [Markdown] Markdown issues and PRs Character / World Generation Issues and enhancements concerning stages of creating a character or a world Mods: Aftershock Anything to do with the Aftershock mod Mods: Dark Days of the Dead Anything related to the DDotD mod (classic style zombies) Mods: MA Massachussetts mod. Cata in one state Mods: No Hope Relating to the mod No Hope Mods: Defense Mode Anything to do with the Defense Mode mod Mods: Innawood 🌲 Anything to do with Innawood mod Mods: TropiCataclysm 🌴 Having to do with the tropical region mod for DDA. Mods: Desert Region Anything relating to the Desert Region mod Mods: Backrooms Mods: Isolation Protocol ☣ The total conversion mod Isolation Protocol Tutorial astyled astyled PR, label is assigned by github actions json-styled JSON lint passed, label assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions labels Nov 29, 2024
@Night-Pryanik Night-Pryanik merged commit 549290b into CleverRaven:master Dec 1, 2024
22 of 29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
astyled astyled PR, label is assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions [C++] Changes (can be) made in C++. Previously named `Code` Character / World Generation Issues and enhancements concerning stages of creating a character or a world <Documentation> Design documents, internal info, guides and help. [JSON] Changes (can be) made in JSON json-styled JSON lint passed, label assigned by github actions Map / Mapgen Overmap, Mapgen, Map extras, Map display [Markdown] Markdown issues and PRs Mods: Aftershock Anything to do with the Aftershock mod Mods: Backrooms Mods: Dark Days of the Dead Anything related to the DDotD mod (classic style zombies) Mods: Defense Mode Anything to do with the Defense Mode mod Mods: Desert Region Anything relating to the Desert Region mod Mods: Innawood 🌲 Anything to do with Innawood mod Mods: Isolation Protocol ☣ The total conversion mod Isolation Protocol Mods: MA Massachussetts mod. Cata in one state Mods: No Hope Relating to the mod No Hope Mods: TropiCataclysm 🌴 Having to do with the tropical region mod for DDA. Tutorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants