SoE: add documentation to webhost
This commit is contained in:
		
							parent
							
								
									9ada4df151
								
							
						
					
					
						commit
						0d6c23e4f2
					
				|  | @ -0,0 +1,26 @@ | ||||||
|  | # Secret of Evermore | ||||||
|  | 
 | ||||||
|  | ## Where is the settings page? | ||||||
|  | The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options | ||||||
|  | you need to configure and export a config file. | ||||||
|  | 
 | ||||||
|  | ## What does randomization do to this game? | ||||||
|  | Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game | ||||||
|  | is always able to be completed, but because of the item shuffle the player may need to access certain areas before | ||||||
|  | they would in the vanilla game. | ||||||
|  | 
 | ||||||
|  | ## What items and locations get shuffled? | ||||||
|  | All gourds/chests/pots, boss drops and alchemists are shuffled. Additionally you may choose to also shuffle alchemy | ||||||
|  | ingredients, sniff spot items, call bead spells and the dog. | ||||||
|  | 
 | ||||||
|  | ## Which items can be in another player's world? | ||||||
|  | Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to | ||||||
|  | limit certain items to your own world. | ||||||
|  | 
 | ||||||
|  | ## What does another world's item look like in Secret of Evermore? | ||||||
|  | Secret of Evermore will just display "Sent an Item". Check the client output if you want to know which. | ||||||
|  | 
 | ||||||
|  | ## When the player receives an item, what happens? | ||||||
|  | When the player receives an item, a borderless text will appear to show which item was received. You can not receive | ||||||
|  | items while a script is active, for example in Nobilia Market or during most Boss Fights. You will receive the items | ||||||
|  | once no more scripts are running. | ||||||
|  | @ -0,0 +1,116 @@ | ||||||
|  | # Secret of Evermore Setup Guide | ||||||
|  | 
 | ||||||
|  | ## Required Software | ||||||
|  | - [SNI](https://github.com/alttpo/sni/releases) (included in Archipelago if already installed) | ||||||
|  | - Hardware or software capable of loading and playing SNES ROM files | ||||||
|  |     - An emulator capable of connecting to SNI with ROM access | ||||||
|  |         - [snes9x-rr win32.zip](https://github.com/gocha/snes9x-rr/releases) + | ||||||
|  |           [socket.dll](http://www.nyo.fr/~skarsnik/socket.dll) + | ||||||
|  |           [connector.lua](https://raw.githubusercontent.com/alttpo/sni/main/lua/Connector.lua) | ||||||
|  |         - or [BizHawk](http://tasvideos.org/BizHawk.html) | ||||||
|  |         - or [bsnes-plus-nwa](https://github.com/black-sliver/bsnes-plus) | ||||||
|  |     - Or SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware | ||||||
|  | - Your Secret of Evermore US ROM file, probably named `Secret of Evermore (USA).sfc` | ||||||
|  | 
 | ||||||
|  | ## Create a Config (.yaml) File | ||||||
|  | 
 | ||||||
|  | ### What is a config file and why do I need one? | ||||||
|  | Your config 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 config 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 config file? | ||||||
|  | The [Player Settings](/games/Secret%20of%20Evermore/player-settings) page on the website allows you to configure your | ||||||
|  | personal settings and export a config file from them. | ||||||
|  | 
 | ||||||
|  | ### Verifying your config file | ||||||
|  | If you would like to validate your config file to make sure it works, you may do so on the | ||||||
|  | [YAML Validator](/mysterycheck) page. | ||||||
|  | 
 | ||||||
|  | ## Generating a Single-Player Game | ||||||
|  | Stand-alone "Evermizer" has a way of balancing single-player games, but may not always be on par feature-wise. | ||||||
|  | Head over to [evermizer.com](https://evermizer.com) if you want to try the official stand-alone, otherwise read below. | ||||||
|  | 
 | ||||||
|  | 1. Navigate to the [Player Settings](/games/Secret%20of%20Evermore/player-settings) page, configure your options, and | ||||||
|  |    click the "Generate Game" button. | ||||||
|  | 2. You will be presented with a "Seed Info" page. | ||||||
|  | 3. Click the "Create New Room" link. | ||||||
|  | 4. You will be presented with a server page, from which you can download your patch file. | ||||||
|  | 5. Run your patch file through [apbpatch](https://evermizer.com/apbpatch) and load it in your emulator or console. | ||||||
|  | 
 | ||||||
|  | ## Joining a MultiWorld Game | ||||||
|  | 
 | ||||||
|  | ### Obtain your patch file and create your ROM | ||||||
|  | When you join a multiworld game, you will be asked to provide your config file to whoever is hosting. Once that | ||||||
|  | is done, the host will provide you with either a link to download your patch file, or with a zip file containing | ||||||
|  | everyone's patch files. Your patch file should have a `.apsoe` extension. | ||||||
|  | 
 | ||||||
|  | Put your patch file on your desktop or somewhere convenient, open [apbpatch](https://evermizer.com/apbpatch) and | ||||||
|  | generate your ROM from it. Load the ROM file in your emulator or console. | ||||||
|  | 
 | ||||||
|  | ### Connect to SNI | ||||||
|  | 
 | ||||||
|  | #### With an emulator | ||||||
|  | Start SNI either from the Archipelago install folder or the stand-alone version. | ||||||
|  | If this is its first time launching, you may be prompted to allow it to communicate through the Windows Firewall. | ||||||
|  | 
 | ||||||
|  | ##### snes9x-rr | ||||||
|  | 1. Load your ROM file if it hasn't already been loaded. | ||||||
|  | 2. Click on the File menu and hover on **Lua Scripting** | ||||||
|  | 3. Click on **New Lua Script Window...** | ||||||
|  | 4. In the new window, click **Browse...** | ||||||
|  | 5. Select the `Connector.lua` file you downloaded above | ||||||
|  | 6. If the script window complains about missing `socket.dll` make sure the DLL is in snes9x or the lua file's directory. | ||||||
|  | 
 | ||||||
|  | ##### BizHawk | ||||||
|  | 1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following | ||||||
|  |    these menu options:   | ||||||
|  |    `Config --> Cores --> SNES --> BSNES`   | ||||||
|  |    Once you have changed the loaded core, you must restart BizHawk. | ||||||
|  | 2. Load your ROM file if it hasn't already been loaded. | ||||||
|  | 3. Click on the Tools menu and click on **Lua Console** | ||||||
|  | 4. Click the button to open a new Lua script. | ||||||
|  | 5. Select the `Connector.lua` file you downloaded above | ||||||
|  | 
 | ||||||
|  | ##### bsnes-plus-nwa | ||||||
|  | This should automatically connect to SNI. | ||||||
|  | If this is its first time launching, you may be prompted to allow it to communicate through the Windows Firewall.  | ||||||
|  | 
 | ||||||
|  | #### With hardware | ||||||
|  | This guide assumes you have downloaded the correct firmware for your device. If you have not | ||||||
|  | done so already, please do this now. SD2SNES and FXPak Pro users may download the appropriate firmware | ||||||
|  | [here](https://github.com/RedGuyyyy/sd2snes/releases). Other hardware may find helpful information | ||||||
|  | [on this page](http://usb2snes.com/#supported-platforms). | ||||||
|  | 
 | ||||||
|  | 1. Copy the ROM file to your SD card. | ||||||
|  | 2. Load the ROM file from the menu. | ||||||
|  | 
 | ||||||
|  | ### Open the client | ||||||
|  | Open [ap-soeclient](https://evermizer.com/apclient) in a modern browser. Do not switch tabs, open it in a new window | ||||||
|  | if you want to use the browser while playing. Do not minimize the window with the client. | ||||||
|  | 
 | ||||||
|  | The client should automatically connect to SNI, the "SNES" status should change to green. | ||||||
|  | 
 | ||||||
|  | ### Connect to the Archipelago Server | ||||||
|  | Enter `/connect server:port` in the client's command prompt and press enter. You'll find `server:port` on the same page | ||||||
|  | that had the patch file. | ||||||
|  | 
 | ||||||
|  | ### Play the game | ||||||
|  | When the game is loaded but not yet past the intro, the "Game" status is yellow. The intro can be skipped pressing | ||||||
|  | START. When the client shows both "Game" and "AP" as green, you're ready to play. | ||||||
|  | Congratulations on successfully joining a multiworld game! | ||||||
|  | 
 | ||||||
|  | ## Hosting a MultiWorld game | ||||||
|  | The recommended way to host a game is to use our [hosting service](/generate). The process is relatively simple: | ||||||
|  | 
 | ||||||
|  | 1. Collect config files from your players. | ||||||
|  | 2. Create a zip file containing your players' config files. | ||||||
|  | 3. Upload that zip file to the website linked above. | ||||||
|  | 4. Wait a moment while the seed is generated. | ||||||
|  | 5. When the seed is generated, you will be redirected to a "Seed Info" page. | ||||||
|  | 6. Click "Create New Room". This will take you to the server page. Provide the link to this page to your players, | ||||||
|  |    so they may download their patch files from there. | ||||||
|  | 7. Note that a link to a MultiWorld Tracker is at the top of the room page. The tracker shows the progress of all | ||||||
|  |    players in the game. Any observers may also be given the link to this page. | ||||||
|  | 8. Once all players have joined, you may begin playing. | ||||||
|  | @ -290,5 +290,24 @@ | ||||||
|         ] |         ] | ||||||
|       } |       } | ||||||
|     ] |     ] | ||||||
|  |   }, | ||||||
|  |   { | ||||||
|  |     "gameTitle": "Secret of Evermore", | ||||||
|  |     "tutorials": [ | ||||||
|  |       { | ||||||
|  |         "name": "Multiworld Setup Guide", | ||||||
|  |         "description": "A guide to playing Secret of Evermore randomizer. This guide covers single-player, multiworld and related software.", | ||||||
|  |         "files": [ | ||||||
|  |           { | ||||||
|  |             "language": "English", | ||||||
|  |             "filename": "secret-of-evermore/multiworld_en.md", | ||||||
|  |             "link": "secret-of-evermore/multiworld/en", | ||||||
|  |             "authors": [ | ||||||
|  |               "Black Sliver" | ||||||
|  |             ] | ||||||
|  |           } | ||||||
|  |         ] | ||||||
|  |       } | ||||||
|  |     ] | ||||||
|   } |   } | ||||||
| ] | ] | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue