Seldom-SE / archipelago_terraria_client

This is the client for my Archipelago integration for Terraria! Locations are boss kills, and items are permanent changes to the world.
MIT License
3 stars 6 forks source link

Archipelago Terraria Client

Not to be confused with prior implementations:

Archipelago is a multiworld randomizer, which is a sort of multi-game mod that shuffles things between games. So, for example, when you kill Skeletron in your Terraria game, your friend might get Mothwing Cloak in their Hollow Knight game. But you can't enter the Dungeon until your friend picks up the item at Vengeful Spirit's location in their game. Archipelago has support for a lot of games. Learn more on its website.

This implementation uses boss kills and event clears as checks. The items are the permanent changes to the world that bosses and events reward in vanilla. Things like "Post-Plantera" and "Hardmode". Bosses still drop their original loot, though. Optionally, you may also include achievement checks and item rewards.

Because this mod adds an extra layer of multiplayer, there are many ways to use it:

Usage

For the Terraria player

Switch to the 1.4.3-Legacy branch for tModLoader. Subscribe to the mod at its Steam page. In Workshop > Manage Mods, edit Archipelago Randomizer (Seldom's Implementation)'s settings. If you're using archipelago.gg to host, leave the server address as "archipelago.gg". If you're hosting, the address will probably be "localhost" and the server should tell you the port. If not, whoever's hosting should know.

You may use as many worlds as you like. When you're ready, run /apstart to enable sending and receiving checks. You may open your world in multiplayer for others to join. Use /ap to use the Archipelago console, and /apflags to check what boss and event flags you have.

Linux currently is not supported. This should be resolved when the mod is updated for 1.4.4.

For the host, if you have any Terraria players

You can host easily on archipelago.gg.

For shorter runs, if this mod has upcoming content, and if it's up, you can use Archipelago's beta site.

Or, if you know how to use them, you can run locally with Terraria's .apworld. Check the #terraria channel on Archipelago's Discord for the latest .apworld if there is one.

Alternatively, if you have the technical knowledge, you can run from source. Run Archipelago (or a branch on my fork) from source (see this guide). You will need to run Generate.py and MultiServer.py. To create the yaml files, you can run WebHost.py. This will run a website, so watch the console for an address including localhost, and go there on your browser. Terraria players have to setup their yaml files from this website, but other games should work fine from the official site. You may instead host the game with WebHost.py, if you prefer.

Future Work

License

Archipelago Terraria Client is licensed under MIT. The Archipelago logo, by Krista Corkos and Chistopher Wilson, is licensed under CC BY-NC 4.0. The logo used by this mod is a modified version of the Archipelago logo, made to fit Terraria's style.