HK: use rich_text_options_doc to make webhost formatting look better (#4079)

This commit is contained in:
qwint 2025-01-06 09:21:44 -05:00 committed by GitHub
parent daf94fcdb2
commit aadcb4c903
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 3 deletions

View File

@ -213,6 +213,7 @@ class MaximumEssencePrice(MinimumEssencePrice):
class MinimumEggPrice(Range): class MinimumEggPrice(Range):
"""The minimum rancid egg price in the range of prices that an item should cost from Jiji. """The minimum rancid egg price in the range of prices that an item should cost from Jiji.
Only takes effect if the EggSlotShops option is greater than 0.""" Only takes effect if the EggSlotShops option is greater than 0."""
rich_text_doc = False
display_name = "Minimum Egg Price" display_name = "Minimum Egg Price"
range_start = 1 range_start = 1
range_end = 20 range_end = 20
@ -222,6 +223,7 @@ class MinimumEggPrice(Range):
class MaximumEggPrice(MinimumEggPrice): class MaximumEggPrice(MinimumEggPrice):
"""The maximum rancid egg price in the range of prices that an item should cost from Jiji. """The maximum rancid egg price in the range of prices that an item should cost from Jiji.
Only takes effect if the EggSlotShops option is greater than 0.""" Only takes effect if the EggSlotShops option is greater than 0."""
rich_text_doc = False
display_name = "Maximum Egg Price" display_name = "Maximum Egg Price"
default = 10 default = 10
@ -265,6 +267,7 @@ class RandomCharmCosts(NamedRange):
Set to -1 or vanilla for vanilla costs. Set to -1 or vanilla for vanilla costs.
Set to -2 or shuffle to shuffle around the vanilla costs to different charms.""" Set to -2 or shuffle to shuffle around the vanilla costs to different charms."""
rich_text_doc = False
display_name = "Randomize Charm Notch Costs" display_name = "Randomize Charm Notch Costs"
range_start = 0 range_start = 0
range_end = 240 range_end = 240
@ -437,6 +440,7 @@ class Goal(Choice):
class GrubHuntGoal(NamedRange): class GrubHuntGoal(NamedRange):
"""The amount of grubs required to finish Grub Hunt. """The amount of grubs required to finish Grub Hunt.
On 'All' any grubs from item links replacements etc. will be counted""" On 'All' any grubs from item links replacements etc. will be counted"""
rich_text_doc = False
display_name = "Grub Hunt Goal" display_name = "Grub Hunt Goal"
range_start = 1 range_start = 1
range_end = 46 range_end = 46
@ -446,7 +450,7 @@ class GrubHuntGoal(NamedRange):
class WhitePalace(Choice): class WhitePalace(Choice):
""" """
Whether or not to include White Palace or not. Note: Even if excluded, the King Fragment check may still be Whether or not to include White Palace or not. Note: Even if excluded, the King Fragment check may still be
required if charms are vanilla. required if charms are vanilla.
""" """
display_name = "White Palace" display_name = "White Palace"
@ -483,6 +487,7 @@ class DeathLinkShade(Choice):
** Self-death shade behavior is not changed; if a self-death normally creates a shade in vanilla, it will override ** Self-death shade behavior is not changed; if a self-death normally creates a shade in vanilla, it will override
your existing shade, if any. your existing shade, if any.
""" """
rich_text_doc = False
option_vanilla = 0 option_vanilla = 0
option_shadeless = 1 option_shadeless = 1
option_shade = 2 option_shade = 2
@ -497,6 +502,7 @@ class DeathLinkBreaksFragileCharms(Toggle):
** Self-death fragile charm behavior is not changed; if a self-death normally breaks fragile charms in vanilla, it ** Self-death fragile charm behavior is not changed; if a self-death normally breaks fragile charms in vanilla, it
will continue to do so. will continue to do so.
""" """
rich_text_doc = False
display_name = "Deathlink Breaks Fragile Charms" display_name = "Deathlink Breaks Fragile Charms"
@ -515,6 +521,7 @@ class CostSanity(Choice):
These costs can be in Geo (except Grubfather, Seer and Eggshop), Grubs, Charms, Essence and/or Rancid Eggs These costs can be in Geo (except Grubfather, Seer and Eggshop), Grubs, Charms, Essence and/or Rancid Eggs
""" """
rich_text_doc = False
option_off = 0 option_off = 0
alias_no = 0 alias_no = 0
option_on = 1 option_on = 1

View File

@ -134,7 +134,9 @@ shop_cost_types: typing.Dict[str, typing.Tuple[str, ...]] = {
class HKWeb(WebWorld): class HKWeb(WebWorld):
setup_en = Tutorial( rich_text_options_doc = True
setup_en = Tutorial(
"Mod Setup and Use Guide", "Mod Setup and Use Guide",
"A guide to playing Hollow Knight with Archipelago.", "A guide to playing Hollow Knight with Archipelago.",
"English", "English",
@ -143,7 +145,7 @@ class HKWeb(WebWorld):
["Ijwu"] ["Ijwu"]
) )
setup_pt_br = Tutorial( setup_pt_br = Tutorial(
setup_en.tutorial_name, setup_en.tutorial_name,
setup_en.description, setup_en.description,
"Português Brasileiro", "Português Brasileiro",