Skip to content

Supermatter guidebook entry - #5429

Merged
Rinary1 merged 14 commits into
ss14Starlight:starlight-devfrom
sir-lutz:SM-guidebook-entry
Aug 13, 2026
Merged

Supermatter guidebook entry#5429
Rinary1 merged 14 commits into
ss14Starlight:starlight-devfrom
sir-lutz:SM-guidebook-entry

Conversation

@sir-lutz

@sir-lutz sir-lutz commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Short description

So new players can lookup what the Supermatter does, and give some hints how it works.

Media (Video/Screenshots)

grafik

Checks

  • I do not require assistance to complete the PR.
  • Before posting/requesting review of a PR, I have verified that the changes work.
  • I have added screenshots/videos of the changes, or this PR does not change in-game mechanics.
  • I affirm that my changes are licensed under the MIT License and grant permission for use in this repository under its conditions.

Changelog

🆑 SirLutz

  • add: Supermatter guidebook entry.
  • add: Supermatter guidebook hints for valid setups.

@sir-lutz
sir-lutz requested a review from a team July 31, 2026 13:04
@github-actions github-actions Bot added Changes: No C# Changes: Prototypes Changes: Guidebook S: Needs Review Status: Requires additional reviews before being fully accepted. Not to be replaced by S: Approved. S: Untriaged Status: Indicates an item has not been triaged and doesn't have appropriate labels. size/M labels Jul 31, 2026
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The guidebook now includes localized Supermatter entries, engineering prototype wiring, and XML pages for crystal operation, stability, structural recovery, delamination response, and advanced handling research.

Changes

Supermatter Guidebook Addition

Layer / File(s) Summary
Guide labels and prototype wiring
Resources/Locale/en-US/guidebook/guides.ftl, Resources/Prototypes/Guidebook/engineering.yml
Adds localized labels and registers the Supermatter guide entries with their XML resources.
Core operation, stability, and recovery guidance
Resources/ServerInfo/Guidebook/Engineering/Supermatter.xml, Resources/ServerInfo/Guidebook/Engineering/SupermatterStability.xml, Resources/ServerInfo/Guidebook/Engineering/SupermatterStructuralRecovery.xml
Documents Supermatter operation, power and gas harvesting, operating requirements, stability warnings, environmental hazards, damage, decomposition, and structural recovery.
Delamination emergency procedures
Resources/ServerInfo/Guidebook/Engineering/SupermatterDelamination.xml
Documents delamination progression, emergency response, evacuation, containment, equipment, and cascade-crystal cleanup.
Advanced handling and research archive
Resources/ServerInfo/Guidebook/Engineering/SupermatterAdvancedSupermatterHandling.xml
Adds authorization and safety requirements and three research records with chamber configurations, cooling systems, operating limits, findings, and redactions.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Suggested reviewers: rinary1

🚥 Pre-merge checks | ✅ 8
✅ Passed checks (8 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: adding Supermatter guidebook content.
Description check ✅ Passed The description explains the Supermatter guidebook additions and their purpose for new players.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
No Magic Numbers ✅ Passed The PR adds no executable system code; its numeric tokens occur only in guidebook prose, archive identifiers, or list markers, so it introduces no code magic numbers.
No Hardcoded Ecs Parameters ✅ Passed The change adds only FTL, YAML guide-entry data, and XML documentation; no ECS system or hardcoded ECS behavior parameter was added. This is a clean documentation-only update.
Avoid Service Locator ✅ Passed The change adds only FTL, YAML, and XML guidebook resources; searches found no IoCManager, Resolve, GetService, ServiceLocator, or Log calls.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
Resources/ServerInfo/Guidebook/Engineering/SupermatterAdvancedSupermatterHandling.xml (1)

32-32: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Solid lore content — tighten a few label/heading inconsistencies for polish.

The three experiment write-ups read well and the redacted-document flavor lands nicely. A few small terminology and formatting inconsistencies are worth a quick pass:

  • Line 98 uses ## Project SM-Zero, while the sibling entries use ## Experiment SM-T1 (line 32) and ## Experiment SM-ZS-LS (line 180). The body of the SM-Zero section itself still calls every field "Experiment ..." (Experiment Lead, Experiment Handler, Experiment Difficulty, Experiment Configuration, Experiment Results), so "Project" in the heading reads as a mismatch.
  • Line 198 uses [color=orange]Experimental Configuration[/color], while the same section header elsewhere reads [color=orange]Experiment Configuration[/color] (lines 49, 118).
  • Lines 148, 154, 157, 160, and 171 switch to sentence case ("Required automation:", "Safe emitter limit:", "Estimated safe emitter limit:", "Emitters used during testing:", "Maximum recorded output:"), while every other field label in the document uses Title Case (e.g. "Chamber Temperature:", "Pressure Supply:", "Coolant:").

None of this affects rendering, but fixing it keeps the same term used for the same concept throughout the archive.

📝 Suggested consistency fixes
-  ## Project SM-Zero
+  ## Experiment SM-Zero
-  [color=orange]Experimental Configuration[/color]
+  [color=orange]Experiment Configuration[/color]
-  Required automation:
+  Required Automation:
   - Pressure floor monitoring.
   - Temperature-sensitive emitter activation.

   [color=orange]Experiment Results[/color]

-  Safe emitter limit:
+  Safe Emitter Limit:
   Six emitters.

-  Estimated safe emitter limit:
+  Estimated Safe Emitter Limit:
   Sixteen emitters.

-  Emitters used during testing:
+  Emitters Used During Testing:
   Thirty-two emitters.

Also applies to: 49-49, 98-99, 118-118, 148-172, 180-181, 198-198

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In
`@Resources/ServerInfo/Guidebook/Engineering/SupermatterAdvancedSupermatterHandling.xml`
at line 32, Normalize the experiment headings and field labels in the guidebook:
rename the SM-Zero heading from “Project” to “Experiment,” change “Experimental
Configuration” to “Experiment Configuration,” and convert the sentence-case
labels around the SM-Zero section to Title Case while preserving their existing
wording and values.
Resources/ServerInfo/Guidebook/Engineering/SupermatterBehaviour.xml (1)

8-13: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Link the related sub-pages.

Nice short page, but the “Related Documentation” bullets make readers leave Supermatter Behaviour without a direct way back. Use the in-text link style already used in other guidebook pages, e.g. [textlink="Supermatter Structural Recovery" link="SupermatterStructuralRecovery"].

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@Resources/ServerInfo/Guidebook/Engineering/SupermatterBehaviour.xml` around
lines 8 - 13, Update the “Related Documentation” bullets in the Supermatter
Behaviour guidebook page to use in-text links for both “Supermatter Stability”
and “Supermatter Structural Recovery,” matching the existing [textlink] style
and their corresponding page identifiers.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@Resources/ServerInfo/Guidebook/Engineering/SupermatterDelamination.xml`:
- Around line 20-34: Update the Delamination Cleanup reference around the
existing cascade entity ID, replacing `cascade1` with the prototype identifier
`Cascad1`; preserve the surrounding guide content and formatting.

---

Nitpick comments:
In
`@Resources/ServerInfo/Guidebook/Engineering/SupermatterAdvancedSupermatterHandling.xml`:
- Line 32: Normalize the experiment headings and field labels in the guidebook:
rename the SM-Zero heading from “Project” to “Experiment,” change “Experimental
Configuration” to “Experiment Configuration,” and convert the sentence-case
labels around the SM-Zero section to Title Case while preserving their existing
wording and values.

In `@Resources/ServerInfo/Guidebook/Engineering/SupermatterBehaviour.xml`:
- Around line 8-13: Update the “Related Documentation” bullets in the
Supermatter Behaviour guidebook page to use in-text links for both “Supermatter
Stability” and “Supermatter Structural Recovery,” matching the existing
[textlink] style and their corresponding page identifiers.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 1b8c599f-14fc-40e0-b58c-74161b230c1d

📥 Commits

Reviewing files that changed from the base of the PR and between f7a4439 and 376df89.

📒 Files selected for processing (8)
  • Resources/Locale/en-US/guidebook/guides.ftl
  • Resources/Prototypes/Guidebook/engineering.yml
  • Resources/ServerInfo/Guidebook/Engineering/Supermatter.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterAdvancedSupermatterHandling.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterBehaviour.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterDelamination.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterStability.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterStructuralRecovery.xml

coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 31, 2026
Comment thread Resources/ServerInfo/Guidebook/Engineering/Supermatter.xml Outdated
Comment thread Resources/ServerInfo/Guidebook/Engineering/Supermatter.xml Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@Resources/ServerInfo/Guidebook/Engineering/SupermatterStability.xml`:
- Around line 4-59: Update the Supermatter stability guide’s “Sources of Stress”
thresholds to match implementation: temperature above 473.15 K, pressure below
33 kPa, or pressure above 363.9 kPa. Revise the pressure-regulator guidance to
state that regulators do not automatically prevent overpressure; players must
configure the inlet threshold, which defaults to 0, and include the configured
threshold in SOP guidance if retaining that recommendation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 706c27e7-aa23-4c5e-9359-0c7e64427661

📥 Commits

Reviewing files that changed from the base of the PR and between 2ef691f and 1335eff.

📒 Files selected for processing (5)
  • Resources/ServerInfo/Guidebook/Engineering/Supermatter.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterAdvancedSupermatterHandling.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterDelamination.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterStability.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterStructuralRecovery.xml
🚧 Files skipped from review as they are similar to previous changes (2)
  • Resources/ServerInfo/Guidebook/Engineering/Supermatter.xml
  • Resources/ServerInfo/Guidebook/Engineering/SupermatterDelamination.xml

Comment thread Resources/ServerInfo/Guidebook/Engineering/SupermatterStability.xml Outdated
coderabbitai[bot]
coderabbitai Bot previously approved these changes Aug 1, 2026
Comment thread Resources/Locale/en-US/guidebook/guides.ftl Outdated
@starlightgithub starlightgithub Bot added S: Awaiting Changes Status: Changes are required before another review can happen and removed S: Needs Review Status: Requires additional reviews before being fully accepted. Not to be replaced by S: Approved. labels Aug 1, 2026
@sir-lutz

sir-lutz commented Aug 1, 2026

Copy link
Copy Markdown
Contributor Author

@redmushie if you want i can remove the whole experiment section. i want to give idea for setups, but dont want an list of steps to follow. So im unsure about what i should do.

coderabbitai[bot]
coderabbitai Bot previously approved these changes Aug 1, 2026
@redmushie redmushie self-assigned this Aug 1, 2026
@sir-lutz
sir-lutz requested a review from redmushie August 9, 2026 13:42
@github-actions github-actions Bot added S: Needs Review Status: Requires additional reviews before being fully accepted. Not to be replaced by S: Approved. and removed S: Awaiting Changes Status: Changes are required before another review can happen labels Aug 9, 2026
Comment thread Resources/Prototypes/Guidebook/engineering.yml Outdated
Comment thread Resources/Locale/en-US/guidebook/guides.ftl Outdated
@starlightgithub starlightgithub Bot added S: Awaiting Changes Status: Changes are required before another review can happen and removed S: Needs Review Status: Requires additional reviews before being fully accepted. Not to be replaced by S: Approved. labels Aug 10, 2026
@sir-lutz
sir-lutz requested a review from Rinary1 August 13, 2026 05:59
@github-actions github-actions Bot added S: Needs Review Status: Requires additional reviews before being fully accepted. Not to be replaced by S: Approved. and removed S: Awaiting Changes Status: Changes are required before another review can happen labels Aug 13, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Content + Integration Test Results

Tests 📝 Passed ✅ Failed ❌ Duration ⏱️
1681 1661 0 11m 1s

🎉 No failed tests in this run.

Github Test Reporter by CTRF 💚

@starlightgithub starlightgithub Bot added S: Approved Status: Reviewed and approved by at least one maintainer or dev; a PR may require another approval. and removed S: Needs Review Status: Requires additional reviews before being fully accepted. Not to be replaced by S: Approved. labels Aug 13, 2026
@Rinary1
Rinary1 enabled auto-merge August 13, 2026 13:57
@Rinary1
Rinary1 added this pull request to the merge queue Aug 13, 2026
Merged via the queue into ss14Starlight:starlight-dev with commit 623de9a Aug 13, 2026
20 checks passed
starlightgithub Bot added a commit that referenced this pull request Aug 13, 2026
Lukeb28 pushed a commit to Lukeb28/space-station-14 that referenced this pull request Aug 18, 2026
## Short description

So new players can lookup what the Supermatter does, and give some hints
how it works.

## Media (Video/Screenshots)

<img width="1407" height="1149" alt="grafik"
src="https://github.com/user-attachments/assets/b43f2b6f-bc99-4710-91ca-b30b5272b5b0"
/>


## Checks
<!-- check boxes for faster reviewing of your PR -->

- [x] I do not require assistance to complete the PR.
- [x] Before posting/requesting review of a PR, I have verified that the
changes work.
- [x] I have added screenshots/videos of the changes, or this PR does
not change in-game mechanics.
- [x] I affirm that my changes are licensed under the [MIT
License](https://github.com/ss14Starlight/space-station-14/blob/Starlight/LICENSE.TXT)
and grant permission for use in this repository under its conditions.

**Changelog**

:cl: SirLutz
- add: Supermatter guidebook entry.
- add: Supermatter guidebook hints for valid setups.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Changes: Guidebook Changes: No C# Changes: Prototypes S: Approved Status: Reviewed and approved by at least one maintainer or dev; a PR may require another approval. S: Untriaged Status: Indicates an item has not been triaged and doesn't have appropriate labels. size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants