docs(base.yaml): document custom substitution settings (06 of 06) - #7528
Open
MahtraDR wants to merge 2 commits into
Open
docs(base.yaml): document custom substitution settings (06 of 06)#7528MahtraDR wants to merge 2 commits into
MahtraDR wants to merge 2 commits into
Conversation
Companion to elanthia-online/lich-5 PRs 01-05, which add Lich::DragonRealms::CustomSubstitutions and the settings keys that let players extend Lich's built-in scroll/creature/box/trash/summoned-weapon/flavor-text substitution lists without a Lich release. This documents those OPTIONAL keys in base.yaml (as commented examples, so behavior is unchanged) for discoverability: custom_scroll_substitutions, custom_creature_normalizations, custom_box_woods, custom_box_containers, custom_box_substitutions, custom_trash_storage, custom_summoned_weapons_adjectives, and custom_flavor_text_patterns. The keys work with or without this change (core Lich reads them straight from settings); this only helps users find them. Independent of the lich-5 PRs. Tests: spec/valid_yaml_spec.rb passes (base.yaml still parses). ASCII-only. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…view) Peer review of elanthia-online#7528: - The "picked up on a Lich restart or ;reload" line promised a ;reload that doesn't exist; the companion lich-5 change now clears CustomSubstitutions' cache in DRInfomon.post_startup_checks (per login), so the accurate statement is "picked up the next time you log in." - Three examples duplicated built-in defaults verbatim (the scale scroll, 'lesser naga', ['ironwood','iron']), so uncommenting them was a silent no-op after CustomSubstitutions' .uniq. Swapped for values that aren't defaults ('tattered goblin-hide scroll', 'razorclaw wolverine', ['driftwood','drift']) so a curious player who uncomments one sees it actually take effect. profiles/base.yaml still parses (valid_yaml_spec: 1 example, 0 failures). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The lich-5 series lets players extend Lich's built-in scroll / creature / box / trash / summoned-weapon / flavor-text substitution lists from their own settings, without a Lich release. But a player won't know those keys exist unless they're documented in the sample profile.
Fix
Document the OPTIONAL keys in
profiles/base.yamlas commented examples (so behavior is unchanged):custom_scroll_substitutionscustom_creature_normalizationscustom_box_woods,custom_box_containers,custom_box_substitutionscustom_trash_storagecustom_summoned_weapons_adjectivescustom_flavor_text_patternsEach entry explains its type and shows a copy-pasteable example. The keys work with or without this change (core Lich reads them straight from settings, merging on top of its built-in defaults); this just helps users find them.
Tests
spec/valid_yaml_spec.rbpasses (base.yaml still parses). Addition is ASCII-only.🤖 Generated with Claude Code