From 0ca3d73ae99d97f4df9c66718195c29d9a4c27a5 Mon Sep 17 00:00:00 2001 From: Joethepic <60947591+Joethepic@users.noreply.github.com> Date: Sun, 26 Jun 2022 18:08:16 -0500 Subject: [PATCH] makes easier to find where to put the launch options for steam version v6 (#712) * Update setup_en.md * Update setup_en.md * Update setup_en.md * Update setup_en.md * typo fix spaces clarification Co-authored-by: Zach Parks * Grammar corrections, clarifications, removed redundant explanations * Markdown syntax fix Co-authored-by: Zach Parks Co-authored-by: Chris Wilson --- worlds/v6/docs/setup_en.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/worlds/v6/docs/setup_en.md b/worlds/v6/docs/setup_en.md index b6df5753..7adf5948 100644 --- a/worlds/v6/docs/setup_en.md +++ b/worlds/v6/docs/setup_en.md @@ -2,42 +2,48 @@ ## Required Software -- VVVVVV (Bought from the [Steam Store](https://store.steampowered.com/app/70300/VVVVVV/) or [GOG Store](https://www.gog.com/game/vvvvvv) Page, NOT Make and Play Edition!) +- VVVVVV + - [Steam Store Page](https://store.steampowered.com/app/70300/VVVVVV/) + - [GOG Store Page](https://www.gog.com/game/vvvvvv) - [V6AP](https://github.com/N00byKing/VVVVVV/releases) ## Installation and Game Start Procedures -1. Install VVVVVV through either Steam or GOG -2. Go to the page linked for V6AP, and download the latest release +1. Install VVVVVV through either Steam or GOG. +2. Go to the page linked for V6AP, and download the latest release. 3. Unpack the zip file where you have VVVVVV installed. # Joining a MultiWorld Game -To join, set the following launch options: `-v6ap_name YourName -v6ap_ip ServerIP:Port`. -Optionally, add `-v6ap_passwd "YourPassword"` if the room you are using requires a password. All parameters without quotation marks. -The Name in this case is the one specified in your generated .yaml file. -In case you are using the Archipelago Website, the IP should be `archipelago.gg`. +To join an Archipelago MultiWorld game, you must set the game's launch options. The two mandatory launch options are: + `-v6ap_name slotName` + `-v6ap_ip server:port` +If the game you are joining requires a password, you should also add the following to your launch options: +`-v6ap_passwd secretPassword` + +If the game is to be played offline in single-player mode, you should include this launch option: +`-v6ap_file filePath` + +Launch options may be found by right-clicking on the game in Steam and clicking "Properties" in the context menu. From there, open the "General" tab. There is a "Launch Options" setting near the bottom wherein you should enter the above options. Note that all launch options are separated by a space, and if there are spaces in your slot name or password, it should be surrounded with quotes. If everything worked out, you will see a textbox informing you the connection has been established after the story intro. # Playing offline To play offline, first generate a seed on the game's settings page. -Create a room and download the `.apv6` file, and start the game with the `-v6ap_file FileName` launch argument. +Create a room and download the `.apv6` file, include the offline single-player launch option described above. ## Installation Troubleshooting -Start the game from the command line to view helpful messages regarding V6AP. These will look something like "V6AP: Message" +Start the game from the command line to view helpful messages regarding V6AP. These will look something like `V6AP: Message`. ### Game no longer starts after copying the .exe -Most likely you forgot to set the launch options. `-v6ap_name YourName` and `-v6ap_ip ServerIP:Port` are required for startup for Multiworlds, and -`-v6ap_file FileName` is required for (offline) singleplayer. -If your Name or Password have spaces in them, surround them in quotes. +The most likely cause of a startup failure is invalid launch options. Ensure the launch options are set properly as described above in +**Joining a MultiWorld Game**. ## Game Troubleshooting ### What happens if I lose connection? -V6AP tries to reconnect a few times, so be patient. -Should the problem still be there after about a minute or two, just save and restart the game. +If a disconnection occurs, wait a moment to see if the game automatically reconnects itself. If the problem presists, save and restart the game.