You are viewing a potentially older version of this package. View all versions.
kking117-Railroad-1.3.0 icon

Railroad

(Config Update MAugust) Configure the flow of runs with portals after certain key points. Allowing for endless looping.

Date uploaded 2 weeks ago
Version 1.3.0
Download link kking117-Railroad-1.3.0.zip
Downloads 188
Dependency string kking117-Railroad-1.3.0

This mod requires the following mods to function

bbepis-BepInExPack-5.4.2117 icon
bbepis-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.2117
RiskofThunder-R2API_Core-5.3.0 icon
RiskofThunder-R2API_Core

Core R2API module

Preferred version: 5.3.0

README

Overview

DISCLAIMER: I highly suggest you check the configurations after launching the game with the mod the first time.

Gives a degree of configuration on how runs flow, mainly portals and end stage bosses. It's pretty much Nuxlar's Looper but catered for my specific wants.

Allows spawning of portals and item rewards when completing:

  • Mithrix fight on Commencement.
  • Voidling fight on Planetarium.
  • False Son fight on Prime Meridian.
  • Solus Heart fight in Solus Web.
  • Twisted Scavenger fight on A Moment, Whole.

Also allows control over the following:

  • Time Flowing in Void Fields and Planetarium.
  • Spawning of the Void Portal after completing Void Fields.
  • Spawning of the Void Outro Portal after completing the Voidling fight.
  • Spawning of the Rebirth Shrine after the False Son fight.
  • Spawning of the Encrypted Portal after the False Son fight.
  • Requiring Beads of Fealty to enter A Moment, Whole.
  • Removing the Colossus Portal from the Gilded Coast.
  • Making the Gilded Coast always spawn a Colossus Portal that takes you straight to Prime Meridian.
  • When the Celestial Orb is allowed to appear, including on Eclipse Runs.
  • Allowing Bead of Fealty to appear in Eclipse Runs.

Other misc features include:

  • Replacing the Teleporter wth the Primordial Teleporter while looping.
  • Enable specific Artifacts upon looping.

Additional Notes

  • The mod does check for DLC when spawning certain portals.

Here's the supported Portal list:

  • Shop = Blue Portal (Takes you to the Bazaar Between Time)
  • MS = Celestial Portal (Takes you to A Moment, Fractured)
  • Null = Null Portal (Takes you to the next map, used to exit Void Fields)
  • Void = Void Portal (Takes you to the Void Locus, requires SOTV)
  • DeepVoid = Deep Void Portal (Takes you to the Planetarium, requires SOTV)
  • VoidOutro = Portal? (Fate Unknown.., used to finish the game at the Planetarium, requires SOTV)
  • GoldShores = Gold Portal (Takes you to the Gilded Coast)
  • Colossus = Colossus Portal (Takes you to the Prime Meridian, requires SOTS)
  • Destination = Destination Portal (Used after clearing Prime Meridian, takes you back to the main path, requires SOTS)
  • HardwareProg = Encrypted Portal (Takes you to the Conduit Canyon, requires AC)
  • HardwareProg_Haunt = Encrypted Portal (Takes you to the Solutional Haunt, requires AC)
  • SolusShop = Virtual Portal (Takes you to the Computational Exchange, requires AC)
  • SolusBackout = Virtual Portal (Used to leave the Solus Shop and go back to the main path, requires AC)
  • SolusWeb = Decrypted Portal (Takes you to the Solus Web, requires AC)

Certain configurations can also take Run Flags/Portal Tags, these control when the configuration takes effect. The current list is:

  • PreLoop/PostLoop
  • PreMithrix/PostMithrix
  • PreTwistedScavenger/PostTwistedScavenger
  • PreVoidling/PostVoidling
  • PreFalseSon/PostFalseSon
  • PreSolusWing/PostSolusWing
  • PreSolusHeart/PostSolusHeart
  • PreVoidFields/PostVoidFields

The mod itself also includes a configuration that lists these (Railroad_InputHelp.cfg) and an example of how they work, some configuration may also be using these by default.

Actually Planned Features

  • Adding an extra portal to the Bazaar after completing Void Fields.
  • More ways to define stage requirements for certain configurations (such as the Celestial Orb).
  • Add Run Flag support to run ending configurations such as the Rebirth Shrine and Purging Solus Heart.

Future Possibilities

  • Add Run Flag and Stage Number configuration support to mid-run Artifact configuration.
  • Configuration to force the run path through Commencement until Mithrix is defeated.
  • Toggle spawning of the Gold Portal on Gilded Coast.

Known Issues

  • Not multiplayer tested.
  • Null Portals and Decrypted Portals spawned by this mod may not work in multiplayer.
  • SolusBackout Portals hang lower than others, nothing wrong but it looks bad.
  • Apparently portals can spawn without their respective DLC enabled, I personally haven't seen this myself but if anyone has encountered this I'd like to know more about the setup.
  • The current configurations for Celestial Orb spawning cannot be set up in a way that replicates vanilla behaviour, at best it can spawn them on Stage 3s when looping which should be close enough for now.

Credits

  • Nuxlar - Mod is based on Looper in concept with some hyperspecifc configurations I wanted, it wouldn't exist without this.

Contact

You can find me as kking117#0370 on discord. You can also contact me through the GitHub link near the top of this mod page.

CHANGELOG

1.3.0

This update has been planned for a while and is mostly near completion. The mod has undergone large changes to how it functions but is working "good enough" to release as is. I've been dragging my feet working on it and hope that releasing it will help me figure out what's left to do and what could be improved or fixed and any major incompatibilities. Ideally I want this version to be in a more refined state before Hallowed Concepts.

- Proper Save Support!
- Proper Save is now supported to retain memory of certain run achievements (mainly boss defeats) when loading a save.

- Glass Frog configs:
- Configure the amount of times to pet the frog, the portal it spawns and the currency required.

- Eclipse configs:
- Added "Allow Beads of Fealty", allows Beads of Fealty to appear during Eclipse runs.

- Planetarium:
- Spawns the Void Outro Portal somewhere inaccessible if disabled, so that the boss music finishes properly. (Top Tier Jank)

- Celestial Orb:
- Added configurations to change when this portal orb appears.

- General Changes:
- Removed randomness from how multiple portals are placed, any randomness left is likely from the director.
- Added tags for most config portal spawns, tags are mostly major boss defeats so you can have certain portals spawn or not spawn based on run progress.
- Separated a large set of configs into Eclipse and Non-Eclipse runs.

- Probably a few more small things I forgot about.

1.2.1

- Stages
- Fixed Planetarium portals using the Commencement Portal configuration.

1.2.0

Changes made will require you to review your configs. Biggest of note is that multiple completion portals can be spawned now, spawning is a bit off but it's functional for now.

- Looping
- "Loop Artifacts" configuration now also accepts English names with the spaces removed, along with internal names.
^ Example: Artifact of Honor can be represented as "EliteOnly" (Internal Name) or "ArtifactofHonor" (English, space removed name).

- Stages
- "Completion Portal" configurations have been renamed to "Completion Portals" and will now accept a list of multiple portals.
- Added configurations for Solus Web that include: "Completion Portals", "Completion Reward" and "Allow Decompile".

1.1.0

No Solus Web and Solutional Haunt configs yet because I'm lazy.

- Updated DLLs for Alloyed Collective.
- Added five portals from Alloyed Collective to the available portal choices.
- Renamed configuration files so they're easier to find in Gale's config editor.

- Looping
- Removed "Min Stage Clears" configuration from "!LoopDefinition".
^ The game checks for loops slightly differently now so this shouldn't be needed anymore.
- Removed "Enable Honor" configuration in favour of the new "Loop Artifacts" configuration.

- Stages
- Added measures to prevent the extra portal being hard to reach in the Planetarium.
- Planetarium's item reward now uses Void Potentials containing a choice of Legendary items.
- Added "Time Flow" configurations for Void Fields and Planetarium, may refine these settings and extend them to similar stages in the future.

1.0.4

- Fixed Commencement item rewards clumping together.

1.0.3

- Fixed "Allow On Eclipse" configuration doing the opposite.
- Fixed "Completion Portal" for "Prime Meridian" configuration not respecting the "Allow On Eclipse" configuration.

1.0.2

- Same mistake twice, shame on me.

1.0.1

- Minor config mistake, I lose.

1.0.0

- Public release.