[Funky port] Salvage ruins by Terkala · Pull Request #5 · syndicate-ss14/macrocosm

Terkala · 2026-03-16T20:44:37Z

About the PR

Added the Salvage Ruins system that has been live on Funky for several months.

This is intended to replace the Debris magnet option, but nothing about this breaks the debris system, it's simply disabled in the YML config of the magnet.

Why / Balance

Salvage Debris are boring RNG of random walls and floors. This system makes it much more dynamic looking, and makes it look like actual pieces of space stations.

There are a number of YML settings to configure the ruins to either spawn smaller, or have better/worse loot, or to use your own specific server's maps for the ruins. It reloads the map on server startup, so if a downstream repo changes the ruin_maps.yml to their own specific server's maps, it will make ruins that look like their own server's destroyed stations. And stay up to date automatically with any map updates.

Technical details

Calling out here that this code IS slightly different from Funky's salvage magnet code. Funky's code also redefines the loot table mechanics a lot, and I left that out here. I also had to change a bit of the back end code about how it generates due to Funky's version still being based on our old pre-Macrocosm codebase. Just wanted to call it out.

A lot was done on the back end to make this performant and not lag the server. Here's the path flow for how the code works:

At server startup, it loads the maps to be used for ruins into memory and builds a costmap from the raw YML of each of the maps. This is essentially an X/Y grid with markers for if there's a wall, window, floor, etc. It ignores any of the items or entities on the map.
When the salvage magnet pulls a ruin, it performs a floodfill on this costmap. The floodfill expands out to mark what floors/walls to load from the map. It then goes to an outer edge of this floodfill (at random) and performs another floodfill. It repeats this 5 times. This gives somewhat irregularly-shaped ruins, due to performing many smaller floodfills rather than one big one.
Next it decides if a wall/window/floor is destroyed, based on RNG when spawning them. Each tile has a chance to spawn broken, which makes it not built onto the map-in-memory of what floor tiles it's going to spawn.
Then it spawns loot/mobs on open floor tiles using the odds system in YML.
Then it spawns the actual grid using normal magnet logic.

This system was 100% created by me, and I specifically am licensing it under MIT for my effort porting it here to Macrocosm.

Media

Requirements

I have read and am following the Macrocosm Pull Request Conventions .
I have added media to this PR or it does not require an in-game showcase.

Breaking changes

Changelog

🆑 Terkala

add: Added Salvage Ruins

kipdotnet

* [x]  I have added media to this PR or it does not require an in-game showcase.

Please dont check this box if you havent added media. This PR is significant enough to need a media showcase

Terkala · 2026-03-16T22:00:52Z

This implementation had a bit of a frame hitch when grabbing the ruins. Updated to hopefully fix that and add an image to showcase.

Terkala · 2026-03-16T22:03:24Z

It's worth noting that this in its current version spawns it a bit far away from the station, and spawns bigger ruins. But those are both parameters controlled via YAML if people want it to spawn smaller ruins or spawn them closer so salvage has an easier time getting to them.

taydeo · 2026-03-16T22:40:23Z

_Macro or _MACRO?

Terkala · 2026-03-16T23:18:13Z

_Macro or _MACRO?

I thought it was supposed to be '_Macro'. Well crap. Fixed. Also Github hates renaming folders

mqole

hefty review. sorry

in general, im definitely still a bit ignorant on what lotsa this does, but my general observations are that the cs should definitely be broken down a lot more. its a touch spaghetti in there and using helper methods to break some of this code up would do a lot to make it easier to read.

im not too familiar with the use cases here (uploading map files to make ruins out of i assume? only put that together at the end oops) but it does seem like a bad idea to have so much about what prototypes are defined as what tiles being hardcoded. it would be really nice if there was the potential for people to have an easy time modifying the list of what is considered to be in each category.

take all my other comments with spoonfuls of salt

Content.Server/Procedural/DungeonJob/DungeonJob.Biome.cs

mqole · 2026-03-17T09:00:43Z

Content.Client/Salvage/UI/SalvageMagnetBoundUserInterface.cs

                    break;
+                // Macro start - Adding RuinOffering to the salvage system
+                case RuinOffering ruin:
+                    option.Title = Loc.GetString("salvage-magnet-ruin");


asking someone smarter than me. how do we feel about hardcoded string here. is it worth

I could make it fancier and have it show the name of the station (it actually does that in funky, but I left it out for simplicity/consistency sake, since this pattern makes it look more like the other magnet options). But this is just the link to the FTL file.

mqole · 2026-03-17T09:01:05Z

Content.Server/_MACRO/Salvage/SalvageRuinGenerator.cs

+using Robust.Shared.Serialization.Markdown.Value;
+using Robust.Shared.Utility;
+
+namespace Content.Server.Salvage;


Suggested change

namespace Content.Server.Salvage;

namespace Content.Server._MACRO.Salvage;

Content.Server/_MACRO/Salvage/SalvageRuinGenerator.cs

mqole · 2026-03-17T09:33:13Z

Content.Shared/Parallax/Biomes/SharedBiomeSystem.cs

remind me to go over these comments a bit later with a fine tooth comb. i definitely want to make sure there is some more clarity on the minutae of what is being changed because i am insane from doing upmerges, but i also dont want to step on toes & this is getting to be a chunky review lol

Content.Shared/Salvage/SharedSalvageSystem.Magnet.cs

mqole · 2026-03-17T09:34:16Z

Resources/Locale/en-US/salvage/salvage-magnet.ftl

macro dir pls

mqole · 2026-03-17T09:35:48Z

Resources/Prototypes/_MACRO/Procedural/ruin_maps.yml

+# Ruin maps that can be used for salvage magnet ruin offerings.
+# These maps are used to extract floor and wall tiles using flood-fill.
+# Recommended to keep the total number of maps 5 or less. More maps will slow server startup. Make sure the maps selected are mostly station-like
+# Avoid any stations that have large amounts of asteroid walls or xeno-walls. The ruin system was not designed to parse those types of maps. 


yeah this is what i mean with like, allowing people to define their own walls. makes for a quick and easy customisation

Added the ability for people to define their own walls. I'll still keep the customization notes here, since it relies on people properly understanding the system before setting their own maps that don't match this pattern.

mqole · 2026-03-17T09:37:26Z

Resources/Prototypes/_MACRO/Procedural/salvage_magnet_ruin_config.yml

+
+- type: salvageMagnetRuinConfig
+  id: Default
+  floodFillPoints: 25 #if you increase this, also increase the ruinSpawnDistance, otherwise the ruins will spawn ontop of the magnet


it would be nice if cs for distance had some clamps so the computer did the work of increasing distance for you instead of having to do it manual

The problem is that both the floodFillPoints and the floodFillStages combined to make a differently sized magnet pull. And I couldn't figure out a good equation that would approximate the size, since the system is so random (partly by design, because well, it's supposed to have a lot of variation)

Terkala · 2026-03-18T17:04:18Z

Pretty sure build error is unrelated

hivehum · 2026-03-18T21:19:09Z

Pretty sure build error is unrelated

i'm rerunning it but i'm pretty certain that test fail is related

mqole

quick glance before i leave for work

mqole · 2026-03-19T01:07:39Z

Content.Server/_MACRO/Salvage/SalvageRuinGenerator.cs

+    /// Parameters: CostMap, CoordinateMap, WallEntities, WindowEntities
+    /// CostMap: A dictionary of Vector2i and int. The Vector2i is the position of the tile, and the int is the cost of the tile.
+    /// CoordinateMap: A dictionary of Vector2i and string. The Vector2i is the position of the tile, and the string is the prototype id of the tile.
+    /// WallEntities: A list of (Vector2i, string PrototypeId). The Vector2i is the position of the wall, and the string PrototypeId is the prototype id of the wall.
+    /// WindowEntities: A list of (Vector2i, string PrototypeId, Angle Rotation). The Vector2i is the position of the window, the string PrototypeId is the prototype id of the window, and the Angle Rotation is the rotation of the window.


theres a way to do this in syntax for the summary block. i forget what exactly. @FancyPlanks will be able to tell you

Content.Server/_MACRO/Salvage/SalvageRuinGenerator.cs

mqole · 2026-03-19T01:10:07Z

Content.Server/Salvage/SalvageSystem.Magnet.cs

                break;
            case SalvageOffering wreck:
                var salvageProto = wreck.SalvageMap;
-


Content.Shared/Salvage/SharedSalvageSystem.Magnet.cs

portfiend · 2026-03-25T08:30:49Z

i'd appreciate if this PR had a clearer description of what is actually added by it! would help with voting

Terkala added 4 commits March 16, 2026 13:21

Base Implementation

3f20541

Basic functionality. Bugfixing starts here

a997fdc

Seems to be working well

d109b88

adding comments

15e5461

github-actions bot added size/L S: Needs Review labels Mar 16, 2026

Terkala added 2 commits March 16, 2026 16:30

Making yaml linter happy

fb53bcb

YAML linter, my most hated foe

92a3a3d

Terkala changed the title ~~Salvage ruins~~ [Funky port] Salvage ruins Mar 16, 2026

Changing the All tag

9a62cb0

kipdotnet requested changes Mar 16, 2026

View reviewed changes

Cache Noise, reduce hitching

8adf7dd

Terkala added 2 commits March 16, 2026 18:16

The stupid things you have to do to rename folder capitalization

7fd0c5f

folder names fixed

8b301db

mqole requested changes Mar 17, 2026

View reviewed changes

mqole added Licensed All code in this PR is licensed under MIT with permission obtained from all authors. S: Awaiting Changes and removed S: Needs Review labels Mar 17, 2026

hivehum added the Category A: Universally Desired all microcosms want this feature. voting must be unanimous agreement label Mar 17, 2026

Updates per mqole code review

5ba3524

mqole reviewed Mar 19, 2026

View reviewed changes

hivehum added the IMP approval This PR has been voted on and approved by IMPstation. label Mar 24, 2026

	namespace Content.Server.Salvage;
	namespace Content.Server._MACRO.Salvage;

Conversation

Terkala commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

About the PR

Why / Balance

Technical details

Media

Requirements

Breaking changes

Uh oh!

kipdotnet left a comment

Choose a reason for hiding this comment

Uh oh!

Terkala commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Terkala commented Mar 16, 2026

Uh oh!

taydeo commented Mar 16, 2026

Uh oh!

Terkala commented Mar 16, 2026

Uh oh!

mqole left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Terkala commented Mar 18, 2026

Uh oh!

hivehum commented Mar 18, 2026

Uh oh!

mqole left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

portfiend commented Mar 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Terkala commented Mar 16, 2026 •

edited

Loading

Terkala commented Mar 16, 2026 •

edited

Loading