2021-05-03 03:26:35 -07:00
|
|
|
# Minecraft Randomizer Setup Guide
|
|
|
|
|
|
2021-08-09 00:46:29 -07:00
|
|
|
## Required Software
|
2021-05-03 03:26:35 -07:00
|
|
|
|
2021-12-31 14:12:22 -05:00
|
|
|
- Minecraft Java Edition from
|
|
|
|
|
the [Minecraft Java Edition Store Page](https://www.minecraft.net/en-us/store/minecraft-java-edition) (update 1.17.1)
|
|
|
|
|
- Archipelago from the [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
|
|
|
|
|
- (select `Minecraft Client` during installation.)
|
2021-05-03 03:26:35 -07:00
|
|
|
|
|
|
|
|
## Configuring your YAML file
|
|
|
|
|
|
|
|
|
|
### What is a YAML file and why do I need one?
|
2021-12-31 14:12:22 -05:00
|
|
|
|
|
|
|
|
See the guide on setting up a basic YAML at the Archipelago setup
|
2022-04-14 23:21:36 +02:00
|
|
|
guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)
|
2021-05-03 03:26:35 -07:00
|
|
|
|
|
|
|
|
### Where do I get a YAML file?
|
2021-12-31 14:12:22 -05:00
|
|
|
|
2021-12-19 22:53:06 -05:00
|
|
|
You can customize your settings by visiting the [Minecraft Player Settings Page](/games/Minecraft/player-settings)
|
2021-05-03 03:26:35 -07:00
|
|
|
|
|
|
|
|
## Joining a MultiWorld Game
|
|
|
|
|
|
2021-12-02 20:04:44 -05:00
|
|
|
### Obtain Your Minecraft Data File
|
2021-12-31 14:12:22 -05:00
|
|
|
|
2021-05-03 03:26:35 -07:00
|
|
|
**Only one yaml file needs to be submitted per minecraft world regardless of how many players play on it.**
|
|
|
|
|
|
2021-12-31 14:12:22 -05:00
|
|
|
When you join a multiworld game, you will be asked to provide your YAML file to whoever is hosting. Once that is done,
|
|
|
|
|
the host will provide you with either a link to download your data file, or with a zip file containing everyone's data
|
|
|
|
|
files. Your data file should have a `.apmc` extension.
|
2021-05-03 03:26:35 -07:00
|
|
|
|
2021-12-31 14:12:22 -05:00
|
|
|
Double-click on your `.apmc` file to have the Minecraft client auto-launch the installed forge server. Make sure to
|
|
|
|
|
leave this window open as this is your server console.
|
2021-05-03 03:26:35 -07:00
|
|
|
|
|
|
|
|
### Connect to the MultiServer
|
2021-12-31 14:12:22 -05:00
|
|
|
|
MC: 1.17 support (#120)
* MC: add death_link option
* Minecraft: 1.17 advancements and logic support
* Update Minecraft tracker to 1.17
* Minecraft: add tests for new advancements
* removed jdk/forge download install out of iss and into MinecraftClient.py using flag --install
* Add required_bosses option
choices are none, ender_dragon, wither, both
postgame advancements are set according to the required boss for completion
* fix docstring for PostgameAdvancements
* Minecraft: add starting_items
List of dicts: item, amount, nbt
* Update descriptions for AdvancementGoal and EggShardsRequired
* Minecraft: fix tests for required_bosses attribute
* Minecraft: updated logic for various dragon-related advancements
Split the logic into can_respawn and can_kill dragon
Free the End, Monsters Hunted, The End Again still require both respawn and kill, since the player needs to kill and be credited with the kill
You Need a Mint and Is It a Plane now require only respawn, since the dragon need only be alive; if killed out of logic, it's ok
The Next Generation only requires kill, since the egg spawns regardless of whether the player was credited with the kill or not
* Minecraft client: ignore prereleases unless --prerelease flag is on
* explicitly state all defaults
change structure shuffle and structure compass defaults to true
update install tutorial to point to player-settings page, as well as removing instructions for manual install
* Minecraft client: add Minecraft version check
Adds a minecraft_version field in the apmc, and downloads only mods which contain that version in the name of the .jar file.
This ensures that the client remains compatible even if new mods are released for later versions, since they won't download a mod for a later version than the apmc says.
Co-authored-by: Kono Tyran <Kono.Tyran@gmail.com>
2021-11-30 20:37:11 -05:00
|
|
|
Using minecraft 1.17.1 connect to the server `localhost`.
|
2021-05-03 03:26:35 -07:00
|
|
|
|
2021-12-31 14:12:22 -05:00
|
|
|
Once you are in game type `/connect <AP-Address> (Port) (Password)` where `<AP-Address>` is the address of the
|
|
|
|
|
Archipelago server. `(Port)` is only required if the Archipelago server is not using the default port of
|
2022-01-09 14:57:00 -05:00
|
|
|
|
2021-12-31 14:12:22 -05:00
|
|
|
38281. `(Password)` is only required if the Archipelago server you are using has a password set.
|
2021-05-03 03:26:35 -07:00
|
|
|
|
|
|
|
|
### Play the game
|
2021-12-19 22:41:05 -05:00
|
|
|
|
2021-12-31 14:12:22 -05:00
|
|
|
When the console tells you that you have joined the room, you're all set. Congratulations on successfully joining a
|
|
|
|
|
multiworld game! At this point any additional minecraft players may connect to your forge server. To start the game once
|
|
|
|
|
everyone is ready use the command `/start`.
|
2021-08-09 00:46:29 -07:00
|
|
|
|
MC: 1.17 support (#120)
* MC: add death_link option
* Minecraft: 1.17 advancements and logic support
* Update Minecraft tracker to 1.17
* Minecraft: add tests for new advancements
* removed jdk/forge download install out of iss and into MinecraftClient.py using flag --install
* Add required_bosses option
choices are none, ender_dragon, wither, both
postgame advancements are set according to the required boss for completion
* fix docstring for PostgameAdvancements
* Minecraft: add starting_items
List of dicts: item, amount, nbt
* Update descriptions for AdvancementGoal and EggShardsRequired
* Minecraft: fix tests for required_bosses attribute
* Minecraft: updated logic for various dragon-related advancements
Split the logic into can_respawn and can_kill dragon
Free the End, Monsters Hunted, The End Again still require both respawn and kill, since the player needs to kill and be credited with the kill
You Need a Mint and Is It a Plane now require only respawn, since the dragon need only be alive; if killed out of logic, it's ok
The Next Generation only requires kill, since the egg spawns regardless of whether the player was credited with the kill or not
* Minecraft client: ignore prereleases unless --prerelease flag is on
* explicitly state all defaults
change structure shuffle and structure compass defaults to true
update install tutorial to point to player-settings page, as well as removing instructions for manual install
* Minecraft client: add Minecraft version check
Adds a minecraft_version field in the apmc, and downloads only mods which contain that version in the name of the .jar file.
This ensures that the client remains compatible even if new mods are released for later versions, since they won't download a mod for a later version than the apmc says.
Co-authored-by: Kono Tyran <Kono.Tyran@gmail.com>
2021-11-30 20:37:11 -05:00
|
|
|
## Manual Installation
|
2021-12-31 14:12:22 -05:00
|
|
|
|
|
|
|
|
It is highly recommended to ues the Archipelago installer to handle the installation of the forge server for you.
|
|
|
|
|
support will not be given for those wishing to manually install forge. For those of you who know how, and wish to do so,
|
|
|
|
|
the following links are the versions of the software we use.
|
2021-08-09 00:46:29 -07:00
|
|
|
|
MC: 1.17 support (#120)
* MC: add death_link option
* Minecraft: 1.17 advancements and logic support
* Update Minecraft tracker to 1.17
* Minecraft: add tests for new advancements
* removed jdk/forge download install out of iss and into MinecraftClient.py using flag --install
* Add required_bosses option
choices are none, ender_dragon, wither, both
postgame advancements are set according to the required boss for completion
* fix docstring for PostgameAdvancements
* Minecraft: add starting_items
List of dicts: item, amount, nbt
* Update descriptions for AdvancementGoal and EggShardsRequired
* Minecraft: fix tests for required_bosses attribute
* Minecraft: updated logic for various dragon-related advancements
Split the logic into can_respawn and can_kill dragon
Free the End, Monsters Hunted, The End Again still require both respawn and kill, since the player needs to kill and be credited with the kill
You Need a Mint and Is It a Plane now require only respawn, since the dragon need only be alive; if killed out of logic, it's ok
The Next Generation only requires kill, since the egg spawns regardless of whether the player was credited with the kill or not
* Minecraft client: ignore prereleases unless --prerelease flag is on
* explicitly state all defaults
change structure shuffle and structure compass defaults to true
update install tutorial to point to player-settings page, as well as removing instructions for manual install
* Minecraft client: add Minecraft version check
Adds a minecraft_version field in the apmc, and downloads only mods which contain that version in the name of the .jar file.
This ensures that the client remains compatible even if new mods are released for later versions, since they won't download a mod for a later version than the apmc says.
Co-authored-by: Kono Tyran <Kono.Tyran@gmail.com>
2021-11-30 20:37:11 -05:00
|
|
|
### Manual install Software links
|
2021-12-31 14:12:22 -05:00
|
|
|
|
2021-12-19 22:53:06 -05:00
|
|
|
- [Minecraft Forge Download Page](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.17.1.html)
|
|
|
|
|
- [Minecraft Archipelago Randomizer Mod Releases Page](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases)
|
2022-01-09 14:57:00 -05:00
|
|
|
- **DO NOT INSTALL THIS ON YOUR CLIENT**
|
2021-12-19 22:53:06 -05:00
|
|
|
- [Java 16 Download Page](https://docs.aws.amazon.com/corretto/latest/corretto-16-ug/downloads-list.html)
|
2021-08-09 00:46:29 -07:00
|
|
|
|