Skip to content

Ixrec/NineSolsArchipelagoRandomizer

Repository files navigation

Nine Sols Archipelago Randomizer

A Nine Sols mod for the Archipelago multi-game randomizer system.

Status (as of November 2025)

Playable, stable, and regularly played.

Feature Completeness: Nearly halfway. All of the content we want to randomize is randomized, and major features we've already shipped include alternate spawns, shuffling wall climb/grapple/ledge grab, random jade costs, Universal Tracker map pages and trick logic. Major features I still want to implement include entrance randomization, shop rando and skill tree rando.

Contact

For questions, feedback, or discussion related to the randomizer, please visit the "Nine Sols" thread in the Archipelago Discord server, or the "Archipelago Randomizer" thread in the Nine Sols Modding Discord server, or message me (ixrec) directly on Discord.

What is an "Archipelago Randomizer", and why would I want one?

Let's say I'm playing Nine Sols, and my friend is playing Ocarina of Time. When I pick up the item dropped by Baichang, I find my friend's Hookshot, allowing them to reach several OoT chests they couldn't before. In one of those chests they find my Cloud Leap, allowing me to reach the Grotto of Scriptures. I retrieve the Shanhai 1000's map chip, and find my friend's Ocarina. This continues until we both find enough of our items to finish our games.

In essence, a multi-game randomizer system like Archipelago allows a group of friends to each bring whatever games they want (if they have an Archipelago mod) and smush them all together into one big cooperative multiplayer experience.

What This Mod Changes

Instead of the usual intro sequence in Peach Blossom Village, the randomizer will put you immediately into the Four Seasons Pavilion, with power already on and Shuanshuan and Shennong already there. The FSP's front door will be "jammed" (i.e. the exit load zone is disabled), so you won't have immediate access to Central Hall. Instead, Teleport will be immediately unlocked, along with one other root node for you to teleport to.

Many more details can be found in the .yaml options file and the randomizer's loading screen tips. Since the loading screen tips are hard to read if you have good load times, and some first-time players may prefer to read them all now, here they are:

Randomizer Loading Screen Tips

"Press F1 to access settings for all your Nine Sols mods, including this randomizer."

"Reaching Eigong requires only Sol Seal items. There's no need to visit Tianhuo Research Institute."

"Chiyou moves into Four Seasons Pavilion after you raise the factory bridge and talk to him.
Kuafu moves in after you use his vital sanctum, just like vanilla."

"This randomizer depends on the TeleportFromAnywhere mod because an important item may end up randomly placed in a "dead end" you can only escape by teleporting."

"Shennong will become sick only after you acquire your first poison item."

"The randomizer's "logic" assumes:
- Jiequan requires Charged Strike
- Lady Ethereal requires Air Dash
- Ji requires Tai-Chi Kick
- Eigong requires Air Dash or Cloud Leap"

"There are 5 mutants who drop an item when permanently killed with Super Mutant Buster. 2 in ED (Living Area), 2 in ED (Sanctum), and 1 in TRC."

"The Peach Blossom Village rescue can be done as soon as you find the Abandoned Mines Access Token. It's no longer tied to escaping Prison and being rescued by Chiyou."

"Since talking to Ji at Daybreak Tower is a location, in this randomizer Ji becomes one of the few NPCs who can talk to you after his own death. I consider this a feature."

"All "Limitless Realm" segments are disabled and skipped in this randomizer."

"If Apeman Facility (Monitoring) was not your first root node, then that node will be automatically unlocked when you enter AF(M), because the upper part of AF(M) is unreachable without it."

"The large spike ball in Grotto (East) will never land in Grotto (Entry) in this randomizer, since it would block critical paths if we let it."

"This randomizer doesn't touch the items that are only reachable after the "Point of no Return", or after giving Shennong all poisons. You're free to replay that content or ignore it."

Installation

Prerequisites

  • Make sure you have Nine Sols installed
    • The "speedrun branch" is not supported. Current/latest patch only.
  • Install r2modman
  • Install the core Archipelago tools (at least version 0.6.4, but preferably the latest version) from Archipelago's Github Releases page. On that page, scroll down to the "Assets" section for the release you want, click on the appropriate installer for your system to start downloading it (for most Windows users, that will be the file called Setup.Archipelago.X.Y.Z.exe), then run it.
  • Go to the Releases page of this repository and look at the latest release. There should be three files: A .zip, an .apworld and a .yaml. Download the .apworld and the .yaml.

Archipelago tools setup

  • Go to your Archipelago installation folder. Typically that will be C:\ProgramData\Archipelago.
  • Put the Nine.Sols.yaml file in Archipelago\Players. You may leave the .yaml unchanged to play on default settings, or use your favorite text editor to read and change the settings in it.
  • Double click on the nine_sols.apworld file. Archipelago should display a popup saying it installed the apworld. Optionally, you can double-check that there's now an nine_sols.apworld file in Archipelago\custom_worlds\.

I've never used Archipelago before. How do I generate a multiworld?

Let's create a randomized "multiworld" with only a single Nine Sols world in it.

  • Make sure Nine.Sols.yaml is the only file in Archipelago\Players (subfolders here are fine).
  • Double-click on Archipelago\ArchipelagoGenerate.exe. You should see a console window appear and then disappear after a few seconds.
  • In Archipelago\output\ there should now be a file with a name like AP_95887452552422108902.zip.
  • Open https://archipelago.gg/uploads in your favorite web browser, and upload the output .zip you just generated. Click "Create New Room".
  • The room page should give you a hostname and port number to connect to, e.g. "archipelago.gg:12345".

For a more complex multiworld, you'd put one .yaml file in the \Players folder for each world you want to generate. You can have multiple worlds of the same game (each with different options), as well as several different games, as long as each .yaml file has a unique player/slot name. It also doesn't matter who plays which game; it's common for one human player to play more than one game in a multiworld.

Modding and Running Nine Sols

  • In r2modman, create a profile and select the Nine Sols game. Then go to the "Mods" > "Online" section and search for "Archipelago Randomizer". Click on it to expand the listing, and click the Download button that appears (if you were wondering about the .zip file we didn't download earlier, that's what r2modman is installing).
  • Now click the "Start modded" button in the top left corner. Note that you must launch Nine Sols through r2modman in order for the mods to be applied; launching from Steam won't work.
  • Once you're at the main menu of Nine Sols itself, click "Start Game", click on an empty save slot, and you will be asked for connection info such as the hostname and port number. Unless you edited Nine.Sols.yaml (or used multiple .yamls), your slot/player name will be "Solarian1". And by default, archipelago.gg rooms have no password.

What if I want to run a pre-release version for testing, or downgrade to an older version of this mod (so I can finish a longer async)?

Click here to show instructions

To use an older or pre-release version, you'll need to install a Ixrec-ArchipelagoRandomizer-X.Y.Z.zip manually. This repo's Releases page should have all the .zips for different versions of the mod.

Once you have the .zip you want:

  • In r2modman, go to "Other" > "Settings"
  • Scroll down to "Import local mod" and click on it
  • Click "Select file" and navigate to the mod .zip

Client/Mod Settings

The client-side settings currently in the randomizer mod are:

  • Boss Scaling
  • Force True Eigong
  • Death Link
  • Flowerless Death Link
  • Show AP Messages
  • Filter By Player

More details can be found in the settings menu tooltips. Press F1 in-game to bring up the settings menu for all of your Nine Sols mods, including the randomizer. This F1 menu comes from the BepinExConfigurationManager mod.

Other Suggested Mods and Tools

Universal Tracker is fully supported by nine_sols.apworld, including yaml-less support, Map Pages, auto-switching between Map Pages, and glitched logic.

UniversalTrackerShowcase

For now, UT is also the only supported tracker, so it's very highly recommended. See the pinned messages in its Discord thread for details.

My CutsceneSkip mod does exactly what it sounds like.

N00byKing's NineSolsTracker mod may help with finding items and chests in-game.

If you're good enough at the combat to want harder-than-vanilla fights, it's worth noting these mods add not only more difficulty but also more randomness:

  • MicheliniDev's EigongPrime lifts a lot of the usual rules about which attacks Eigong can do when, making it feel more random which moves she chooses to perform. Especially if you enable the "IsRandom" setting.
  • Gogas1's BossChallengeMod offers "random modifiers" on bosses, minibosses and regular enemies. This is compatible with EigongPrime. Personally, I like to set Max deaths to 2 (for bosses, minibosses and regulars), enable Modifiers, set Modifiers Start Death to 0, and disable the Damage Buildup modifier (since that one tends to turn all enemy attacks into one-hit kills).

Credits

  • GameWyrm, Gregório, Hopop, Juanba, mynameis, XDrotkon and others in various Nine Sols and Archipelago-related Discord servers for feedback, discussion and encouragement
  • dubi steinkek, yuki.kako, N00byKing and others from the "Nine Sols Modding" Discord server for help modding Nine Sols and for creating the other Nine Sols mods that this randomizer relies on or is often played with
  • Flitter for talking me into trying out Archipelago randomizers in the first place
  • All the Archipelago contributors who made that great multi-randomizer system
  • Everyone at Red Candle Games who made this great game

About

A Nine Sols mod for the Archipelago multi-game randomizer system

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages