forked from ArchipelagoMW/Archipelago
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update instructions
- Loading branch information
Showing
2 changed files
with
67 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,76 @@ | ||
# AM2R Archipelago Setup Guide | ||
|
||
## Required Software | ||
[comment]: <> (Change this reference before release) | ||
- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases/tag/latest) | ||
- [AM2R Multiworld Mod](https://github.com/DodoBirby/AM2R-Multiworld-Mod/releases/latest) | ||
- [AM2R Launcher](https://github.com/AM2R-Community-Developers/AM2RLauncher/releases) | ||
- Your copy of AM2R 1.1 for the launcher | ||
- [AM2R Launcher](https://github.com/AM2R-Community-Developers/AM2RLauncher/releases/latest) | ||
- Your self provided copy of AM2R 1.1 for the launcher | ||
|
||
## Installation Process | ||
|
||
Download the latest release of [AM2R Launcher](https://github.com/AM2R-Community-Developers/AM2RLauncher/releases) and | ||
then using your AM2R 1.1 set up the launcher once the launcher is set up you can install the mod | ||
### Installing Multiworld Mod | ||
|
||
## installing `am2r.apworld` | ||
Download and set up the latest release of [AM2R Launcher](https://github.com/AM2R-Community-Developers/AM2RLauncher/releases) using your copy of AM2R 1.1 then in the launcher you can | ||
under the `Mod Settings` tab, hit the `ADD NEW MOD` button, and select Multiworld mod `.zip` file from [AM2R Multiworld Mod](https://github.com/DodoBirby/AM2R-Multiworld-Mod/releases/latest) | ||
finally from the `Play` tab select the `Multiworld` profile and hit `Install` and then play to load up the mod. | ||
|
||
inside you standard 0.4.4 or newer installation of Archipelago, you will need to navigate to the `/lib/worlds` folder | ||
and add the `am2r.apworld` into there | ||
|
||
From there you can use the Archipelago launcher to find the AM2R client that is required to connect to the game and the server | ||
### Installing `am2r.apworld` | ||
|
||
After downloading the `am2r.apworld` file you will need to move it to your standard 0.4.4 or newer installation of | ||
[Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases/tag/latest), | ||
you will need to navigate to the `/lib/worlds` folder of the Archipelago installation and add the `am2r.apworld` file into there. | ||
|
||
From there you can use the `Archipelago Launcher` to find and open `AM2R Client` in the future steps. | ||
|
||
## Hosting a Multiworld Session | ||
|
||
After collecting all the players `.yaml` files and placing them into the `/players` folder you can run `Archipelago Generate` | ||
at which point it may ask you for roms if needed. If you do not have the roms you cannot generate the seed, and you will | ||
need somebody else with all the roms to generate the seed for the group. | ||
|
||
After the generation is complete there will be a `.zip` file in the `/output` folder of the Archipelago installation | ||
that you can then upload directly to the [Archipelago Website](https://archipelago.gg/uploads) to host the session, or | ||
you can utilize the `Archipelago Server` to host the session yourself. | ||
|
||
## Joining a Multiworld Session | ||
|
||
### Creating a `.yaml` file | ||
|
||
In the `Archipelago Launcher` hit the `Generate Template Settings` button and Which will generate a default `.yaml` file | ||
for all your currently installed worlds, this will add a `am2r.yaml` file to the `/players/templates` folder of the | ||
Archipelago installation. | ||
|
||
The `.yaml` file is a special text file that can be edited in any text editor including your OS's default text editor. | ||
I would recommend installing at least [Sublime Text](https://www.sublimetext.com/) or [Notepad++](https://notepad-plus-plus.org/downloads/) | ||
for the easiest experience. | ||
|
||
The `.yaml` file will look something like this: | ||
```yaml | ||
AM2R: | ||
setting 1: | ||
option 1: 50 | ||
option 2: 0 | ||
option 3: 0 | ||
option 4: 0 | ||
|
||
setting 2: | ||
option 1: 50 | ||
option 2: 25 | ||
option 3: 10 | ||
option 4: 0 | ||
``` | ||
To make a setting guaranteed it needs to be the only one with any value other than 0 but if you wanted it to be random | ||
you can add values to multiple options, and it will pick one at random with the formula of `option_value/total_setting_values`. | ||
So for `setting 1` it would always pick `option 1` and for `setting 2` it would pick `option 1` `50/85` of the time, `option 2` `25/85` of the time, and `option 3` `10/85` of the time. | ||
|
||
After setting up the `.yaml` file you can save it and then send it to the host. | ||
|
||
### Joining the Session | ||
|
||
After the host has generated the seed and has given you the connection information you can use the `Archipelago Launcher` | ||
to run the `AM2R Client` after that run the AM2R Multiworld Mod and go to the settings to find the `Multiworld` menu to enter | ||
the slot name (player name) and hit `Connect to Python Client` the client will then show `Successfully Connected to AM2R` | ||
at which pont you can run /connect [ip]:[port] or use the address bar at the top with the same formatting to connect to the | ||
multiworld session at which point you can start a new save file or continue a save file. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters