Skip to content

Convert Spell Details to Markdown Tables#19

Merged
nschimme merged 6 commits into
MUME:mainfrom
nschimme:reformat-spells-tables-17638550133989786345
May 7, 2026
Merged

Convert Spell Details to Markdown Tables#19
nschimme merged 6 commits into
MUME:mainfrom
nschimme:reformat-spells-tables-17638550133989786345

Conversation

@nschimme
Copy link
Copy Markdown
Contributor

@nschimme nschimme commented May 7, 2026

Description

Improves readability of spells by moving them into tables. Updates Spells_list.md with main MUME helpfile

Related Issue

Checklist

  • Wiki Rules: I have followed the Content Rules (mortal knowledge only) and Spoiler Rules (using ::: details Spoiler) as defined in the Contributing Guide.
  • Content Accuracy: I have verified the information added/changed is accurate to the game.
  • Visual Check: I have verified that the page renders correctly (no broken tables, lists, or styling).
  • Local Build: (For coders) Ran docker compose up --build wiki (or npm run docs:build) and verified changes locally.
  • Index Pages: Updated top-level index pages (e.g., docs/guides.md, docs/classes.md) if a major new page was added.

Summary by Sourcery

Reformat and standardize spell documentation to use structured property tables and align spell metadata and spell lists with the main MUME helpfile.

Enhancements:

  • Convert numerous spell help pages from inline syntax descriptions to consistent property/value tables while preserving and clarifying narrative text.
  • Update spell levels, mana costs, syntax, and related metadata to match the main MUME helpfile across mage, cleric, shaman, and special spells.
  • Refresh Spell_list and shared spell index to link to individual spell pages and include the Corrupt special spell.
  • Tidy cross-references and "See also" sections, fixing link text and formatting for related spells and abilities.

Documentation:

  • Add a new Corrupt spell page documenting the corruption ceremony and link it into the special spells documentation.

nschimme and others added 4 commits May 7, 2026 13:31
- Replaced mangled technical details in 73 spell pages with standardized Markdown tables.
- Cleaned up descriptive text and fixed line breaks in spell pages.
- Updated spell levels and mana costs to match the live MUME site (e.g., Identify moved to level 18).
- Added missing Corrupt spell page.
- Updated central Spell_list.md and navigation includes.
- Replaced mangled technical details in 73 spell pages with standardized Markdown tables.
- Cleaned up descriptive text and fixed line breaks in spell pages.
- Updated spell levels and mana costs to match the live MUME site (e.g., Identify moved to level 18).
- Added missing Corrupt spell page.
- Updated central Spell_list.md and navigation includes.
- Escaped HTML special characters in tables to ensure VitePress build compatibility.
Updated the class for the Energy Drain spell from Cleric to Shaman.
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 7, 2026

Reviewer's Guide

Refactors multiple spell help pages to standardize their syntax metadata into Markdown tables, aligns spell levels/mana costs with the main spell list, and updates spell indexes to cross-link individual spell pages and add the new Corrupt spell.

File-Level Changes

Change Details Files
Refactor individual spell help pages to use a consistent "Property/Value" Markdown table for syntax and mechanical metadata while keeping narrative text below.
  • Replaced inline 'Syntax :' and related metadata lines with a two-column Markdown table describing syntax, type, accumulative flag, duration, casting time, position, level, class, mana cost, and example usage.
  • Ensured existing descriptive prose for each spell remains but is moved below the new table and lightly reflowed to single-paragraph style.
  • Fixed minor formatting issues (e.g., list bullets, see-also link formatting, escaping of example commands).
docs/pages/Portal.md
docs/pages/Breath_of_Briskness.md
docs/pages/Identify.md
docs/pages/Charm.md
docs/pages/Detect_Magic.md
docs/pages/Locate.md
docs/pages/Enchant.md
docs/pages/Darkness.md
docs/pages/Black_Breath.md
docs/pages/Blindness.md
docs/pages/Control_Weather.md
docs/pages/Detect_Evil.md
docs/pages/Fireball.md
docs/pages/Bless.md
docs/pages/Block_Door.md
docs/pages/Create_Focus.md
docs/pages/Shroud.md
docs/pages/Word_of_Recall.md
docs/pages/Summon.md
docs/pages/Call_Familiar.md
docs/pages/Heal.md
docs/pages/Lightning_Bolt.md
docs/pages/Remove_Poison.md
docs/pages/Sleep_Spell.md
docs/pages/Transfer.md
docs/pages/Create_Food.md
docs/pages/Create_Water.md
docs/pages/Cure_Light.md
docs/pages/Detect_Poison.md
docs/pages/Teleport.md
docs/pages/Armour_Spell.md
docs/pages/Cure_Blindness.md
docs/pages/Sense_Life.md
docs/pages/Cure_Serious.md
docs/pages/Curse.md
docs/pages/Divination.md
docs/pages/Fear.md
docs/pages/Night_Vision.md
docs/pages/Sanctuary.md
docs/pages/Silence.md
docs/pages/Dispel_Evil.md
docs/pages/Locate_Life.md
docs/pages/Protection_From_Evil.md
docs/pages/Strength_Spell.md
docs/pages/Watch_Room.md
docs/pages/Call_Lightning.md
docs/pages/Chill_Touch.md
docs/pages/Harm.md
docs/pages/Locate_Magic.md
docs/pages/Magic_Missile.md
docs/pages/Poison.md
docs/pages/Burning_Hands.md
docs/pages/Colour_Spray.md
docs/pages/Create_Light.md
docs/pages/Hold_Spell.md
docs/pages/Shield_Spell.md
docs/pages/Shocking_Grasp.md
docs/pages/Cure_Critic.md
docs/pages/Detect_Invisibility.md
docs/pages/Energy_Drain.md
docs/pages/Raise_Dead.md
docs/pages/Remove_Curse.md
docs/pages/Cure_Disease.md
docs/pages/Dispel_Magic.md
docs/pages/Smother.md
docs/pages/Find_the_Path.md
docs/pages/Magic_Blast.md
docs/pages/Scry.md
docs/pages/Store.md
docs/pages/Earthquake.md
docs/pages/Ventriloquate.md
docs/pages/Break_Door.md
Align spell metadata (levels, mana costs, classes, etc.) with the canonical spell list and adjust inconsistencies.
  • Updated some spell levels and classes (e.g., Identify to level 18 mage, Divination to level 17 cleric, Magic Blast to level 15 mage, Hold to level 16 shaman, Remove Curse to level 11 cleric, Energy Drain to shaman-only) to match the central spell list.
  • Standardized descriptions and notes (e.g., NOTE blocks, incantations) around the new table layouts without altering game mechanics.
  • Ensured examples and syntax strings reflect the canonical argument order and optional parameters described in the main spell helpfiles.
docs/pages/Identify.md
docs/pages/Divination.md
docs/pages/Magic_Blast.md
docs/pages/Hold_Spell.md
docs/pages/Remove_Curse.md
docs/pages/Energy_Drain.md
docs/pages/Locate.md
docs/pages/Locate_Magic.md
docs/pages/Teleport.md
docs/pages/Control_Weather.md
docs/pages/Poison.md
docs/pages/Create_Water.md
docs/pages/Create_Focus.md
Update global spell index and spell list to include links and the new Corrupt spell.
  • Converted the main spell list table to link each spell name to its specific spell page and reordered/paired spells to match the game helpfile ordering.
  • Added Corrupt as a special spell in both the spell list and the shared spells include, alongside Create Focus.
  • Created a new Corrupt spell help page describing syntax, requirements, and related spells, and wired it into the shared include navigation.
docs/pages/Spell_list.md
docs/includes/Spells.md
docs/pages/Corrupt.md
Improve cross-linking and see-also sections for related spells.
  • Normalized "See also" sections to use inline links on a single line rather than wrapped bullet lists with manual line breaks.
  • Fixed capitalisation and naming consistency in cross-links (e.g., Protection From Evil, Night Vision).
docs/pages/Detect_Magic.md
docs/pages/Bless.md
docs/pages/Darkness.md
docs/pages/Detect_Poison.md
docs/pages/Night_Vision.md
docs/pages/Detect_Invisibility.md
docs/pages/Curse.md
docs/pages/Hold_Spell.md
docs/pages/Raise_Dead.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@nschimme nschimme changed the title Reformat spells tables 17638550133989786345 Convert Spell Details to Markdown Tables May 7, 2026
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 5 issues, and left some high level feedback:

  • Energy Drain is now tagged and described as a Shaman-only spell, but it still appears in the Cleric spell list in Spells.md and Spell_list.md; please align the class listings so the spell consistently belongs to the intended class.
  • In Dispel_Magic.md the frontmatter description contains an unescaped <victim | object> which may be interpreted as HTML and stripped; consider escaping the angle brackets as &lt;...&gt; for consistent rendering.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Energy Drain is now tagged and described as a Shaman-only spell, but it still appears in the Cleric spell list in `Spells.md` and `Spell_list.md`; please align the class listings so the spell consistently belongs to the intended class.
- In `Dispel_Magic.md` the frontmatter `description` contains an unescaped `<victim | object>` which may be interpreted as HTML and stripped; consider escaping the angle brackets as `&lt;...&gt;` for consistent rendering.

## Individual Comments

### Comment 1
<location path="docs/pages/Breath_of_Briskness.md" line_range="28" />
<code_context>
+
+The spell is always cast without a target and will affect the caster and automatically everyone who is both in the same group and in the same room. This includes any mobs, such as [mounts](./Mount.md), charmies, or mercenaries.
+
+The first effect is an immideate distribution of movement points. At higher levels this can be roughly 50 points which are distributed to all eligible targets. So the number of points for each individual will be roghly 50/group size.
+
+The second effect is to boost move point regeneration. This effect is not reduced by the number of targets, so everyone will receive the full effect regardless of group size. At higher levels the boost can last up to 6 minutes and will be slightly stronger than the boost of a forest green cloak. The effect will stack with any other move regen boosts, such as equipment like the mentioned cloak, walking and travelling herblores, and rest and sleep.
</code_context>
<issue_to_address>
**issue (typo):** Fix spelling of “immideate” and “roghly”.

Please update “immideate” → “immediate” and “roghly” → “roughly” in this paragraph.

```suggestion
The first effect is an immediate distribution of movement points. At higher levels this can be roughly 50 points which are distributed to all eligible targets. So the number of points for each individual will be roughly 50/group size.
```
</issue_to_address>

### Comment 2
<location path="docs/pages/Identify.md" line_range="25" />
<code_context>
+
+When cast on a [mobile](./Mobile.md) or player, it provides a locate key but does not provide additional information (see also: [Divination](./Divination.md)).
+
+NOTE: It is strongly suggested not to reveal the exact [statistics](./Statistic.md) of items you identify. Saying that "sword X is slighly better at parrying than sword Y, but you need to be very strong in order to use it efficiently" is acceptable.
+
+Publishing tables of item statistics, either via boards or by web or by any other means, is highly frowned upon by the management. Please refrain from doing so.
</code_context>
<issue_to_address>
**issue (typo):** Spelling: “slighly” should be “slightly”.

In this sentence, update “slighly better” to “slightly better”.

```suggestion
NOTE: It is strongly suggested not to reveal the exact [statistics](./Statistic.md) of items you identify. Saying that "sword X is slightly better at parrying than sword Y, but you need to be very strong in order to use it efficiently" is acceptable.
```
</issue_to_address>

### Comment 3
<location path="docs/pages/Teleport.md" line_range="22" />
<code_context>
-N/A Duration : No Casting : Very long Position : Standing, Fighting
-Level : Level 8 Class : Magic User Min. Mana : 35 Example: \> cast
-'teleport' whiqueboza This spell can be learned from:
+**Teleport** is a [level](./Level.md) 8 [mage](./Mage.md) [spell](./Spell.md) that allows the caster to instantly transport themselves to a target [room](./room.md). To use teleport you need to aquire magical keys for rooms. The keys are obtained by either using the [Locate Life](./Locate_Life.md) spell or the [Locate](./Locate.md) spell.
+
+This spell can be learned from:
</code_context>
<issue_to_address>
**issue (typo):** Spelling: “aquire” should be “acquire”.

Please update the phrase to “acquire magical keys.”

```suggestion
**Teleport** is a [level](./Level.md) 8 [mage](./Mage.md) [spell](./Spell.md) that allows the caster to instantly transport themselves to a target [room](./room.md). To use teleport you need to acquire magical keys. The keys are obtained by either using the [Locate Life](./Locate_Life.md) spell or the [Locate](./Locate.md) spell.
```
</issue_to_address>

### Comment 4
<location path="docs/pages/Transfer.md" line_range="23" />
<code_context>
-N/A Duration : No Casting : Extremely long Position : Standing Level :
-Level 14 Class : Cleric Min. Mana : 50 Example: \> cast 'transfer'
-Aschit
+Wearing a [ring](./Ring.md) (or collar for shape-shifting bears) can protect against being transfered involuntarily.

 This spell can be learned from:
</code_context>
<issue_to_address>
**issue (typo):** Spelling: “transfered” should be “transferred”.

```suggestion
Wearing a [ring](./Ring.md) (or collar for shape-shifting bears) can protect against being transferred involuntarily.
```
</issue_to_address>

### Comment 5
<location path="docs/pages/Sanctuary.md" line_range="21" />
<code_context>
-Syntax : cast 'sanctuary' \[recipient Type : Defensive Accumulative:
-No Duration : Yes Casting : Extremely long Position : Standing Level :
-Level 18 Class : Cleric Min. Mana : 50 Example: \> cast 'sanctuary'
+**Sanctuary** (often abbreviated *sanc*) is a level 18 [cleric](./Cleric.md) [spell](./Spell.md). If cast on a player it limits the maximum hit point damage that the player can suffer per hit. It is primarily used to protect players when attacking very dangerous and hard hitting mobs. The maximum hit point damage is dependant upon the casters wisdom and the target's willpower, but is usually a bit under 20 points of damage.

 This spell can be learned from:
</code_context>
<issue_to_address>
**issue (typo):** Fix “dependant” and add apostrophe in “casters wisdom”.

Please change “dependant” to “dependent” and “casters wisdom” to “caster’s wisdom” to correct the spelling and grammar.

```suggestion
**Sanctuary** (often abbreviated *sanc*) is a level 18 [cleric](./Cleric.md) [spell](./Spell.md). If cast on a player it limits the maximum hit point damage that the player can suffer per hit. It is primarily used to protect players when attacking very dangerous and hard hitting mobs. The maximum hit point damage is dependent upon the caster's wisdom and the target's willpower, but is usually a bit under 20 points of damage.
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread docs/pages/Breath_of_Briskness.md Outdated
Comment thread docs/pages/Identify.md Outdated
Comment thread docs/pages/Teleport.md Outdated
Comment thread docs/pages/Transfer.md Outdated
Comment thread docs/pages/Sanctuary.md Outdated
nschimme and others added 2 commits May 7, 2026 10:07
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@nschimme nschimme merged commit b3fd91f into MUME:main May 7, 2026
2 checks passed
@nschimme nschimme deleted the reformat-spells-tables-17638550133989786345 branch May 7, 2026 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant