Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: Adding instructions about how to add external apworlds #4490

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions WebHostLib/templates/supportedGames.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@
{% include 'header/oceanHeader.html' %}
<div id="games" class="markdown">
<h1>Currently Supported Games</h1>
<p>Below are the games that are currently included with the Archipelago software. To play a game that is not on
this page, please refer to <a href="/tutorial/Archipelago/setup/en#adding-new-worlds">this
section of the setup guide</a>.</p>
<div class="js-only">
<label for="game-search">Search for your game below!</label><br />
<div class="page-controls">
Expand Down
19 changes: 19 additions & 0 deletions worlds/generic/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,25 @@ are rolling locally, ensure this file is edited to your liking **before** rollin
when running the Archipelago Installation software. If you have changed settings in this file, and would like to retain
them, you may rename the file to `options.yaml`.

### Adding new worlds

If you are generating locally, you can play with worlds that are not included in the Archipelago installation.
The worlds are packaged as `.apworld` files. To add a world to your installation, click the "Install APWorld" button in
the launcher and select the `.apworld` file you wish to install. Alternatively, you can drag the `.apworld` file onto the
launcher, manually add the `.apworld` file to the `custom_worlds` folder of your Archipelago Installation, or double-click
the file itself. After adding a new world, it will function like the worlds that are already packaged with
Archipelago.

We strongly recommend that you make sure that the source of the `.apworld` is safe and trustworthy before playing with a
custom world.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would suggest a bit more clarity here that you should make sure it's trustworthy because it can run code on your pc, the same as any executable file would.


#### Adding alternate versions of included worlds

If you want to play with an alternate version of a game that is already included in Archipelago, you will need to manually
replace the original `.apworld`. To do so, go to your Archipelago installation folder and navigate to the `lib/worlds`
directory. Then, create a backup of the `.apworld` or the folder corresponding to the game you want to play an alternate
version of. Finally, replace the base `.apworld` (or folder) with the alternate `.apworld`. If you want to play the original
again, replace the alternate version with your backup.

## Hosting an Archipelago Server

Expand Down