From d518ef926976f1432f43952b7843871431c65f00 Mon Sep 17 00:00:00 2001 From: Kono Tyran Date: Sat, 1 May 2021 18:06:19 -0700 Subject: [PATCH 1/7] add minecraft randomizer usage/installation tutorial --- .../assets/tutorial/minecraft/minecraft_en.md | 118 ++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md diff --git a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md new file mode 100644 index 000000000000..5971cfd5dc30 --- /dev/null +++ b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md @@ -0,0 +1,118 @@ +# Minecraft Randomizer Setup Guide + +## Required Software + +### Server Host +- [Minecraft Forge Dedicated Server](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html) +- [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases) + +### Players +- [Minecraft](https://www.minecraft.net/en-us/) + +## Installation Procedures + +### Dedicated Server Setup +Only one person has to do this setup and host a dedicated server for everyone else playing to connect to. +1. Download the 1.16.5 **Minecraft Forge** installer from the link above, making sure to download the most recent recommended version. + +2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install server**. + - On this page you will also choose where to install the server to remember this directory its important in the next step. + +3. Navigate to where you installed the server and open `forge-1.16.5-xx.x.x-installer.jar` + - Upon first launch of the server it will close and ask you to accept Minecraft's EULA there should be a new file in that directory called `eula.txt` that contains a link to Minecraft's EULA and change a line that you need to change to `eula=true` in there to accept Minecraft's EULA + - This will create the appropriate directories for you to place the file in the following step. + +3. Place the `aprandomizer-x.x.x.jar` from the link above file into the `mods` folder of the above installation of your forge server. + - Once again run the server, it will load up and generate the required directory `APData` for when you are ready to play a game! + +### Basic Player Setup +- Purchace and Install Minecraft from the above link. + **Your Done**. + Players only need to have a Vanilla unmodified version of Minecraft to play! + +### Advanced Player Setup +***This is not required to play a randomized minecraft game.*** +however this recommended as it helps make the experience more enjoyable in the view of the developers. + +#### Recomended Mods +- [JourneyMap](https://www.curseforge.com/minecraft/mc-mods/journeymap) (Minimap) + + +1. Install and run Minecraft from the link above at least once. +2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install client**. + - Start Minecraft forge at least once to create the directories needed for the next steps. +3. Navigate to your minecraft install directory and place desired mods `.jar` files the mods in the `mods` directory + - The default install directories are as follows + - Windows `%APPDATA%\.minecraft\mods` + - macOS `~/Library/Application Support/minecraft\mods` + - Linux `~/.minecraft\mods` + +## Configuring your YAML file + +### What is a YAML file and why do I need one? +Your YAML file contains a set of configuration options which provide the generator with information about how +it should generate your game. Each player of a multiworld will provide their own YAML file. This setup allows +each player to enjoy an experience customized for their taste, and different players in the same multiworld +can all have different options. + +### Where do I get a YAML file? +A basic minecraft yaml will look like this. +```yaml +description: Template Name # Used to describe your yaml. Useful if you have multiple files +name: YourName # Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit +#{player} will be replaced with the player's slot number. +#{PLAYER} will be replaced with the player's slot number if that slot number is greater than 1. +#{number} will be replaced with the counter value of the name. +#{NUMBER} will be replaced with the counter value of the name if the counter value is greater than 1. +game: Minecraft +# Shared Options supported by all games: +accessibility: locations +progression_balancing: off # we recommend turning this off for minecraft, as it has a much smaller pool of items, as well as many more logic skips that can be done than other games. +# Minecraft Specific Options +advancement_goal: # Number of advancements required (out of 92 total) to spawn the Ender Dragon and complete the game. + few: 0 # 30 advancements + normal: 1 # 50 + many: 0 # 70 +combat_difficulty: # Modifies the level of items logically required for exploring dangerous areas and fighting bosses. + easy: 0 + normal: 1 + hard: 0 +include_hard_advancements: # Junk-fills certain RNG-reliant or tedious advancements with XP rewards. + on: 0 + off: 1 +include_insane_advancements: # Junk-fills extremely difficult advancements; this is only How Did We Get Here? and Adventuring Time. + on: 0 + off: 1 +include_postgame_advancements: # Some advancements require defeating the Ender Dragon; this will junk-fill them so you won't have to finish to send some items. + on: 0 + off: 1 +shuffle_structures: # CURRENTLY DISABLED; enables shuffling of villages, outposts, fortresses, bastions, and end cities. + on: 0 + off: 1 +``` + +## Joining a MultiWorld Game + +### Obtain your Minecraft data file +**Only one yaml file needs to be submitted per minecraft world regardless of how many players play on it.** + +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. + +Put your data file in your forge server `APData` folder. Make sure to remove any previous data file that was in +there all ready + +### Connect to the MultiServer +After having placed your data file in the `APData` folder, start the Forge server and make sure you have OP +status by typing `/op YourMinecraftUsername` in the forge server console then connecting in your Minecraft client. + +Once in game type `/connect ()` where `` is the address of the +Archipelago server and `` is the case-sensitive name that was in your YAML file. `()` +is only required if the Archipleago server you are using has a password set. + +### Play the game +When the console tells you that you have joined the room, you're ready to begin playing. Congratulations +on successfully joining a multiworld game! At this point any additional minecraft players may connect to your +forge server. + From bb0cfc8ce434ebad6ab694c86fef63dfa053c2f6 Mon Sep 17 00:00:00 2001 From: Kono Tyran Date: Sun, 2 May 2021 10:28:56 -0700 Subject: [PATCH 2/7] update tutorial to specify Java edition of Minecraft to avoid confusion. --- WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md index 5971cfd5dc30..57300db23d2e 100644 --- a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md +++ b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md @@ -7,7 +7,7 @@ - [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases) ### Players -- [Minecraft](https://www.minecraft.net/en-us/) +- [Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-edition) ## Installation Procedures From b106a21059210b5327b69f61bceea022b068f606 Mon Sep 17 00:00:00 2001 From: Kono Tyran Date: Mon, 3 May 2021 10:36:40 -0700 Subject: [PATCH 3/7] fixed some grammar and spelling in the minecraft_en.md tutorial --- .../assets/tutorial/minecraft/minecraft_en.md | 61 +++++++++---------- 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md index 57300db23d2e..0cc39794cfce 100644 --- a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md +++ b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md @@ -3,7 +3,7 @@ ## Required Software ### Server Host -- [Minecraft Forge Dedicated Server](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html) +- [Minecraft Forge](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html) - [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases) ### Players @@ -16,23 +16,25 @@ Only one person has to do this setup and host a dedicated server for everyone el 1. Download the 1.16.5 **Minecraft Forge** installer from the link above, making sure to download the most recent recommended version. 2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install server**. - - On this page you will also choose where to install the server to remember this directory its important in the next step. + - On this page you will also choose where to install the server to remember this directory it's important in the next step. 3. Navigate to where you installed the server and open `forge-1.16.5-xx.x.x-installer.jar` - - Upon first launch of the server it will close and ask you to accept Minecraft's EULA there should be a new file in that directory called `eula.txt` that contains a link to Minecraft's EULA and change a line that you need to change to `eula=true` in there to accept Minecraft's EULA - - This will create the appropriate directories for you to place the file in the following step. + - Upon first launch of the server it will close and ask you to accept Minecraft's EULA. There will be a new file called `eula.txt` that contains a link to Minecraft's EULA, and a line that you need to change to `eula=true` to accept Minecraft's EULA. + - This will create the appropriate directories for you to place the files in the following step. 3. Place the `aprandomizer-x.x.x.jar` from the link above file into the `mods` folder of the above installation of your forge server. - Once again run the server, it will load up and generate the required directory `APData` for when you are ready to play a game! ### Basic Player Setup -- Purchace and Install Minecraft from the above link. - **Your Done**. +- Purchase and install Minecraft from the above link. + + **You're Done**. + Players only need to have a Vanilla unmodified version of Minecraft to play! ### Advanced Player Setup ***This is not required to play a randomized minecraft game.*** -however this recommended as it helps make the experience more enjoyable in the view of the developers. +however this recommended as it helps make the experience more enjoyable. #### Recomended Mods - [JourneyMap](https://www.curseforge.com/minecraft/mc-mods/journeymap) (Minimap) @@ -41,11 +43,11 @@ however this recommended as it helps make the experience more enjoyable in the v 1. Install and run Minecraft from the link above at least once. 2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install client**. - Start Minecraft forge at least once to create the directories needed for the next steps. -3. Navigate to your minecraft install directory and place desired mods `.jar` files the mods in the `mods` directory - - The default install directories are as follows +3. Navigate to your minecraft install directory and place desired mods `.jar` file the in the `mods` directory. + - The default install directories are as follows. - Windows `%APPDATA%\.minecraft\mods` - - macOS `~/Library/Application Support/minecraft\mods` - - Linux `~/.minecraft\mods` + - macOS `~/Library/Application Support/minecraft/mods` + - Linux `~/.minecraft/mods` ## Configuring your YAML file @@ -58,39 +60,36 @@ can all have different options. ### Where do I get a YAML file? A basic minecraft yaml will look like this. ```yaml -description: Template Name # Used to describe your yaml. Useful if you have multiple files -name: YourName # Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit -#{player} will be replaced with the player's slot number. -#{PLAYER} will be replaced with the player's slot number if that slot number is greater than 1. -#{number} will be replaced with the counter value of the name. -#{NUMBER} will be replaced with the counter value of the name if the counter value is greater than 1. +description: Template Name +# Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit +name: YourName game: Minecraft -# Shared Options supported by all games: accessibility: locations -progression_balancing: off # we recommend turning this off for minecraft, as it has a much smaller pool of items, as well as many more logic skips that can be done than other games. -# Minecraft Specific Options -advancement_goal: # Number of advancements required (out of 92 total) to spawn the Ender Dragon and complete the game. - few: 0 # 30 advancements - normal: 1 # 50 - many: 0 # 70 -combat_difficulty: # Modifies the level of items logically required for exploring dangerous areas and fighting bosses. +progression_balancing: off +advancement_goal: + few: 0 + normal: 1 + many: 0 +combat_difficulty: easy: 0 normal: 1 hard: 0 -include_hard_advancements: # Junk-fills certain RNG-reliant or tedious advancements with XP rewards. +include_hard_advancements: on: 0 off: 1 -include_insane_advancements: # Junk-fills extremely difficult advancements; this is only How Did We Get Here? and Adventuring Time. +include_insane_advancements: on: 0 off: 1 -include_postgame_advancements: # Some advancements require defeating the Ender Dragon; this will junk-fill them so you won't have to finish to send some items. +include_postgame_advancements: on: 0 off: 1 -shuffle_structures: # CURRENTLY DISABLED; enables shuffling of villages, outposts, fortresses, bastions, and end cities. +shuffle_structures: #CURRENTLY DISABLED on: 0 off: 1 ``` +For more detail on what each setting does check the default `playerSettings.yaml` that comes with the Archipelago install. + ## Joining a MultiWorld Game ### Obtain your Minecraft data file @@ -100,8 +99,8 @@ When you join a multiworld game, you will be asked to provide your YAML file to 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. -Put your data file in your forge server `APData` folder. Make sure to remove any previous data file that was in -there all ready +Put your data file in your forge servers `APData` folder. Make sure to remove any previous data file that was in there +previously. ### Connect to the MultiServer After having placed your data file in the `APData` folder, start the Forge server and make sure you have OP From f152bcbf96c42ef0d4b3410a3c1bf0a0218fe6bf Mon Sep 17 00:00:00 2001 From: Kono Tyran Date: Sat, 1 May 2021 18:06:19 -0700 Subject: [PATCH 4/7] add minecraft randomizer usage/installation tutorial --- WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md index 57300db23d2e..5971cfd5dc30 100644 --- a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md +++ b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md @@ -7,7 +7,7 @@ - [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases) ### Players -- [Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-edition) +- [Minecraft](https://www.minecraft.net/en-us/) ## Installation Procedures From 26b109b6e4556cf02289873b67e06f701ae7b4fa Mon Sep 17 00:00:00 2001 From: Kono Tyran Date: Sun, 2 May 2021 10:28:56 -0700 Subject: [PATCH 5/7] update tutorial to specify Java edition of Minecraft to avoid confusion. --- WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md index 5971cfd5dc30..57300db23d2e 100644 --- a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md +++ b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md @@ -7,7 +7,7 @@ - [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases) ### Players -- [Minecraft](https://www.minecraft.net/en-us/) +- [Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-edition) ## Installation Procedures From c00b9b248c23d7c3382c7008f5379712af605eaf Mon Sep 17 00:00:00 2001 From: Kono Tyran Date: Mon, 3 May 2021 10:36:40 -0700 Subject: [PATCH 6/7] fixed some grammar and spelling in the minecraft_en.md tutorial --- .../assets/tutorial/minecraft/minecraft_en.md | 61 +++++++++---------- 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md index 57300db23d2e..0cc39794cfce 100644 --- a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md +++ b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md @@ -3,7 +3,7 @@ ## Required Software ### Server Host -- [Minecraft Forge Dedicated Server](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html) +- [Minecraft Forge](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html) - [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases) ### Players @@ -16,23 +16,25 @@ Only one person has to do this setup and host a dedicated server for everyone el 1. Download the 1.16.5 **Minecraft Forge** installer from the link above, making sure to download the most recent recommended version. 2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install server**. - - On this page you will also choose where to install the server to remember this directory its important in the next step. + - On this page you will also choose where to install the server to remember this directory it's important in the next step. 3. Navigate to where you installed the server and open `forge-1.16.5-xx.x.x-installer.jar` - - Upon first launch of the server it will close and ask you to accept Minecraft's EULA there should be a new file in that directory called `eula.txt` that contains a link to Minecraft's EULA and change a line that you need to change to `eula=true` in there to accept Minecraft's EULA - - This will create the appropriate directories for you to place the file in the following step. + - Upon first launch of the server it will close and ask you to accept Minecraft's EULA. There will be a new file called `eula.txt` that contains a link to Minecraft's EULA, and a line that you need to change to `eula=true` to accept Minecraft's EULA. + - This will create the appropriate directories for you to place the files in the following step. 3. Place the `aprandomizer-x.x.x.jar` from the link above file into the `mods` folder of the above installation of your forge server. - Once again run the server, it will load up and generate the required directory `APData` for when you are ready to play a game! ### Basic Player Setup -- Purchace and Install Minecraft from the above link. - **Your Done**. +- Purchase and install Minecraft from the above link. + + **You're Done**. + Players only need to have a Vanilla unmodified version of Minecraft to play! ### Advanced Player Setup ***This is not required to play a randomized minecraft game.*** -however this recommended as it helps make the experience more enjoyable in the view of the developers. +however this recommended as it helps make the experience more enjoyable. #### Recomended Mods - [JourneyMap](https://www.curseforge.com/minecraft/mc-mods/journeymap) (Minimap) @@ -41,11 +43,11 @@ however this recommended as it helps make the experience more enjoyable in the v 1. Install and run Minecraft from the link above at least once. 2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install client**. - Start Minecraft forge at least once to create the directories needed for the next steps. -3. Navigate to your minecraft install directory and place desired mods `.jar` files the mods in the `mods` directory - - The default install directories are as follows +3. Navigate to your minecraft install directory and place desired mods `.jar` file the in the `mods` directory. + - The default install directories are as follows. - Windows `%APPDATA%\.minecraft\mods` - - macOS `~/Library/Application Support/minecraft\mods` - - Linux `~/.minecraft\mods` + - macOS `~/Library/Application Support/minecraft/mods` + - Linux `~/.minecraft/mods` ## Configuring your YAML file @@ -58,39 +60,36 @@ can all have different options. ### Where do I get a YAML file? A basic minecraft yaml will look like this. ```yaml -description: Template Name # Used to describe your yaml. Useful if you have multiple files -name: YourName # Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit -#{player} will be replaced with the player's slot number. -#{PLAYER} will be replaced with the player's slot number if that slot number is greater than 1. -#{number} will be replaced with the counter value of the name. -#{NUMBER} will be replaced with the counter value of the name if the counter value is greater than 1. +description: Template Name +# Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit +name: YourName game: Minecraft -# Shared Options supported by all games: accessibility: locations -progression_balancing: off # we recommend turning this off for minecraft, as it has a much smaller pool of items, as well as many more logic skips that can be done than other games. -# Minecraft Specific Options -advancement_goal: # Number of advancements required (out of 92 total) to spawn the Ender Dragon and complete the game. - few: 0 # 30 advancements - normal: 1 # 50 - many: 0 # 70 -combat_difficulty: # Modifies the level of items logically required for exploring dangerous areas and fighting bosses. +progression_balancing: off +advancement_goal: + few: 0 + normal: 1 + many: 0 +combat_difficulty: easy: 0 normal: 1 hard: 0 -include_hard_advancements: # Junk-fills certain RNG-reliant or tedious advancements with XP rewards. +include_hard_advancements: on: 0 off: 1 -include_insane_advancements: # Junk-fills extremely difficult advancements; this is only How Did We Get Here? and Adventuring Time. +include_insane_advancements: on: 0 off: 1 -include_postgame_advancements: # Some advancements require defeating the Ender Dragon; this will junk-fill them so you won't have to finish to send some items. +include_postgame_advancements: on: 0 off: 1 -shuffle_structures: # CURRENTLY DISABLED; enables shuffling of villages, outposts, fortresses, bastions, and end cities. +shuffle_structures: #CURRENTLY DISABLED on: 0 off: 1 ``` +For more detail on what each setting does check the default `playerSettings.yaml` that comes with the Archipelago install. + ## Joining a MultiWorld Game ### Obtain your Minecraft data file @@ -100,8 +99,8 @@ When you join a multiworld game, you will be asked to provide your YAML file to 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. -Put your data file in your forge server `APData` folder. Make sure to remove any previous data file that was in -there all ready +Put your data file in your forge servers `APData` folder. Make sure to remove any previous data file that was in there +previously. ### Connect to the MultiServer After having placed your data file in the `APData` folder, start the Forge server and make sure you have OP From d0427db7e5ec47cbe590bbf323467a9bb6a67ca6 Mon Sep 17 00:00:00 2001 From: Kono Tyran Date: Sat, 8 May 2021 08:03:53 -0700 Subject: [PATCH 7/7] update readme to relfect removal of name field from connect command. --- .../assets/tutorial/minecraft/minecraft_en.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md index 0cc39794cfce..0a8e0c62d914 100644 --- a/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md +++ b/WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md @@ -62,7 +62,7 @@ A basic minecraft yaml will look like this. ```yaml description: Template Name # Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit -name: YourName +name: YourName game: Minecraft accessibility: locations progression_balancing: off @@ -83,12 +83,12 @@ include_insane_advancements: include_postgame_advancements: on: 0 off: 1 -shuffle_structures: #CURRENTLY DISABLED - on: 0 - off: 1 +shuffle_structures: + on: 1 + off: 0 ``` -For more detail on what each setting does check the default `playerSettings.yaml` that comes with the Archipelago install. +For more detail on what each setting does check the default `PlayerSettings.yaml` that comes with the Archipelago install. ## Joining a MultiWorld Game @@ -106,8 +106,8 @@ previously. After having placed your data file in the `APData` folder, start the Forge server and make sure you have OP status by typing `/op YourMinecraftUsername` in the forge server console then connecting in your Minecraft client. -Once in game type `/connect ()` where `` is the address of the -Archipelago server and `` is the case-sensitive name that was in your YAML file. `()` +Once in game type `/connect ()` where `` is the address of the +Archipelago server. `()` is only required if the Archipleago server you are using has a password set. ### Play the game