Skip to content

Commit ff96b39

Browse files
authored
Mincraft Tutorial (#4)
* add minecraft randomizer usage/installation tutorial * update tutorial to specify Java edition of Minecraft to avoid confusion.
1 parent 4a75d27 commit ff96b39

File tree

1 file changed

+118
-0
lines changed

1 file changed

+118
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Minecraft Randomizer Setup Guide
2+
3+
## Required Software
4+
5+
### Server Host
6+
- [Minecraft Forge Dedicated Server](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html)
7+
- [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases)
8+
9+
### Players
10+
- [Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-edition)
11+
12+
## Installation Procedures
13+
14+
### Dedicated Server Setup
15+
Only one person has to do this setup and host a dedicated server for everyone else playing to connect to.
16+
1. Download the 1.16.5 **Minecraft Forge** installer from the link above, making sure to download the most recent recommended version.
17+
18+
2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install server**.
19+
- On this page you will also choose where to install the server to remember this directory its important in the next step.
20+
21+
3. Navigate to where you installed the server and open `forge-1.16.5-xx.x.x-installer.jar`
22+
- 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
23+
- This will create the appropriate directories for you to place the file in the following step.
24+
25+
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.
26+
- Once again run the server, it will load up and generate the required directory `APData` for when you are ready to play a game!
27+
28+
### Basic Player Setup
29+
- Purchace and Install Minecraft from the above link.
30+
**Your Done**.
31+
Players only need to have a Vanilla unmodified version of Minecraft to play!
32+
33+
### Advanced Player Setup
34+
***This is not required to play a randomized minecraft game.***
35+
however this recommended as it helps make the experience more enjoyable in the view of the developers.
36+
37+
#### Recomended Mods
38+
- [JourneyMap](https://www.curseforge.com/minecraft/mc-mods/journeymap) (Minimap)
39+
40+
41+
1. Install and run Minecraft from the link above at least once.
42+
2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install client**.
43+
- Start Minecraft forge at least once to create the directories needed for the next steps.
44+
3. Navigate to your minecraft install directory and place desired mods `.jar` files the mods in the `mods` directory
45+
- The default install directories are as follows
46+
- Windows `%APPDATA%\.minecraft\mods`
47+
- macOS `~/Library/Application Support/minecraft\mods`
48+
- Linux `~/.minecraft\mods`
49+
50+
## Configuring your YAML file
51+
52+
### What is a YAML file and why do I need one?
53+
Your YAML file contains a set of configuration options which provide the generator with information about how
54+
it should generate your game. Each player of a multiworld will provide their own YAML file. This setup allows
55+
each player to enjoy an experience customized for their taste, and different players in the same multiworld
56+
can all have different options.
57+
58+
### Where do I get a YAML file?
59+
A basic minecraft yaml will look like this.
60+
```yaml
61+
description: Template Name # Used to describe your yaml. Useful if you have multiple files
62+
name: YourName # Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit
63+
#{player} will be replaced with the player's slot number.
64+
#{PLAYER} will be replaced with the player's slot number if that slot number is greater than 1.
65+
#{number} will be replaced with the counter value of the name.
66+
#{NUMBER} will be replaced with the counter value of the name if the counter value is greater than 1.
67+
game: Minecraft
68+
# Shared Options supported by all games:
69+
accessibility: locations
70+
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.
71+
# Minecraft Specific Options
72+
advancement_goal: # Number of advancements required (out of 92 total) to spawn the Ender Dragon and complete the game.
73+
few: 0 # 30 advancements
74+
normal: 1 # 50
75+
many: 0 # 70
76+
combat_difficulty: # Modifies the level of items logically required for exploring dangerous areas and fighting bosses.
77+
easy: 0
78+
normal: 1
79+
hard: 0
80+
include_hard_advancements: # Junk-fills certain RNG-reliant or tedious advancements with XP rewards.
81+
on: 0
82+
off: 1
83+
include_insane_advancements: # Junk-fills extremely difficult advancements; this is only How Did We Get Here? and Adventuring Time.
84+
on: 0
85+
off: 1
86+
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.
87+
on: 0
88+
off: 1
89+
shuffle_structures: # CURRENTLY DISABLED; enables shuffling of villages, outposts, fortresses, bastions, and end cities.
90+
on: 0
91+
off: 1
92+
```
93+
94+
## Joining a MultiWorld Game
95+
96+
### Obtain your Minecraft data file
97+
**Only one yaml file needs to be submitted per minecraft world regardless of how many players play on it.**
98+
99+
When you join a multiworld game, you will be asked to provide your YAML file to whoever is hosting. Once that
100+
is done, the host will provide you with either a link to download your data file, or with a zip file containing
101+
everyone's data files. Your data file should have a `.apmc` extension.
102+
103+
Put your data file in your forge server `APData` folder. Make sure to remove any previous data file that was in
104+
there all ready
105+
106+
### Connect to the MultiServer
107+
After having placed your data file in the `APData` folder, start the Forge server and make sure you have OP
108+
status by typing `/op YourMinecraftUsername` in the forge server console then connecting in your Minecraft client.
109+
110+
Once in game type `/connect <AP-Address> <Name> (<Password>)` where `<AP-Address>` is the address of the
111+
Archipelago server and `<Name>` is the case-sensitive name that was in your YAML file. `(<Password>)`
112+
is only required if the Archipleago server you are using has a password set.
113+
114+
### Play the game
115+
When the console tells you that you have joined the room, you're ready to begin playing. Congratulations
116+
on successfully joining a multiworld game! At this point any additional minecraft players may connect to your
117+
forge server.
118+

0 commit comments

Comments
 (0)