Docs: Update main setup guide - #6329
Conversation
github-actions
Bot
added
is: documentation
| Run the exe file, and after accepting the license agreement you will be asked which components you would like to | ||
| install. |
There was a problem hiding this comment.
It's possible there will be optional components again in the future, but I think it's fine to get rid of for now since there's also a good chance it'll say like this.
| YAML is a format very similar to JSON however it is made to be more human-readable. You may check the validity of the | ||
| file by uploading it to the [check page](/check), however this only works for the [supported games](/games) on the | ||
| website. To validate YAML files for other worlds, you should follow the steps below to | ||
| [install the world](#playing-with-custom-worlds) and then run a test generation locally. |
There was a problem hiding this comment.
Almost think this part should just be removed from here since it's a bit out of place. Not sure exactly what to do with it otherwise though.
| In a multiworld there must be one YAML per world. Any number of players can play on each world using either the game's | ||
| native coop system or using Archipelago's coop support. Each world will hold one slot in the multiworld and will have a | ||
| slot name and, if the relevant game requires it, files to associate it with that multiworld. | ||
| native coop system if supported or using Archipelago's coop support. Each world will hold one slot in the multiworld to |
There was a problem hiding this comment.
I kind of feel like this should be changed since "there must be one YAML per world" is not actually true with multiple documents per file, weights, etc. I get that going over that specifically is probably too much detail for here, but currently this might give the misleading impression to hosts for instance about what they can expect from player yamls.
Also maybe a slight expansion of what "Archipelago's coop support" means here?
| After filling the `Players` folder, run`ArchipelagoGenerate.exe` or click `Generate` in the launcher. The output of | ||
| the generation is placed in the `output` folder (usually named something like `AP_XXXXX.zip`). | ||
| After filling the `Players` folder, run the `Generate` component in the launcher (or run the `ArchipelagoGenerate.exe` | ||
| directly). The output of the generation is placed in the `output` folder (usually named something like `AP_XXXXX.zip`). |
There was a problem hiding this comment.
Don't really love the duplication of the same information across multiple spots throughout here. I kind of feel like these should either just link back to the previous section and then only add whatever information is new, or that the whole thing should be reorganized so that it's not split by single player and multiplayer (which are largely the same for setup) and whatever additional information about that is just included as a note. I guess for now just the current edits are fine though.
| chosen here are baked into the `.archipelago` file that gets output with the other files after generation, so if you | ||
| are rolling locally, ensure this file is edited to your liking **before** rolling the seed. This file is overwritten | ||
| 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`. |
There was a problem hiding this comment.
Presumably since this last being updated, it seems like the installer actually keeps your current options in the host.yaml when installing and just adds whatever new ones are there. Therefore I think this part probably isn't needed anymore.
| The person who created the room becomes the "owner" of the room, and as such has access to the server console. Clearing | ||
| cookies (sometimes done automatically by certain browsers) will remove access to this console. To prevent this, you may | ||
| save your [session id](/session) which you can use to restore your session later if it is lost. Otherwise, it will be | ||
| impossible to restore access afterwards. |
There was a problem hiding this comment.
Felt like a worthwhile addition.
| 3. Slot Name | ||
| 4. Download link for data files | ||
| 5. Link to tracker page for this player | ||
| 6. Server console (only shown for room owner) |
There was a problem hiding this comment.
I think this is worth pointing out here, and the prior image also felt like it could be updated anyway.
| When a multiworld seed is generated, the multidata will be output as a `.archipelago`. If the game was generated locally, | ||
| a compressed folder will be in `/output` and will contain the `.archipelago`, the spoiler log, and any relevant files | ||
| for the generated games. | ||
|
|
There was a problem hiding this comment.
I don't really see the relevance of this part here.
2 participants
What is this fixing or adding?
Trying to make some various updates for clarity in the main Archipelago setup guide, plus a couple style things. Left some comments on specific things.
How was this tested?
Viewing on local webhost, checking links and overall displaying properly.
If this makes graphical changes, please attach screenshots.
Look at
example_room.png.