DS3: Update the setup guide (#878)
* Merge pull request #1 from eudaimonistic/patch-2 Update setup_en.md (cherry picked from commit 41567697fb89e74301afe651fbde0bafca5946e0) * DS3: Update english documentation * DS3: Add French setup guide * DS3: Fix space formatting in doc * DS3: Resolve comment
This commit is contained in:
		
							parent
							
								
									645ede869f
								
							
						
					
					
						commit
						0ed0d17f38
					
				|  | @ -16,14 +16,26 @@ from ..generic.Rules import set_rule | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| class DarkSouls3Web(WebWorld): | class DarkSouls3Web(WebWorld): | ||||||
|     tutorials = [Tutorial( |     bug_report_page = "https://github.com/Marechal-L/Dark-Souls-III-Archipelago-client/issues" | ||||||
|  |     setup_en = Tutorial( | ||||||
|         "Multiworld Setup Tutorial", |         "Multiworld Setup Tutorial", | ||||||
|         "A guide to setting up the Archipelago Dark Souls III randomizer on your computer.", |         "A guide to setting up the Archipelago Dark Souls III randomizer on your computer.", | ||||||
|         "English", |         "English", | ||||||
|         "setup_en.md", |         "setup_en.md", | ||||||
|         "setup/en", |         "setup/en", | ||||||
|         ["Marech"] |         ["Marech"] | ||||||
|     )] |     ) | ||||||
|  | 
 | ||||||
|  |     setup_fr = Tutorial( | ||||||
|  |         setup_en.tutorial_name, | ||||||
|  |         setup_en.description, | ||||||
|  |         "Français", | ||||||
|  |         "setup_fr.md", | ||||||
|  |         "setup/fr", | ||||||
|  |         ["Marech"] | ||||||
|  |     ) | ||||||
|  | 
 | ||||||
|  |     tutorials = [setup_en, setup_fr] | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| class DarkSouls3World(World): | class DarkSouls3World(World): | ||||||
|  |  | ||||||
|  | @ -10,7 +10,10 @@ config file. | ||||||
| In Dark Souls III, all unique items you can earn from a static corpse, a chest or the death of a Boss/NPC are randomized. | In Dark Souls III, all unique items you can earn from a static corpse, a chest or the death of a Boss/NPC are randomized. | ||||||
| This exclude the upgrade materials such as the titanite shards, the estus shards and the consumables which remain at  | This exclude the upgrade materials such as the titanite shards, the estus shards and the consumables which remain at  | ||||||
| the same location. I also added an option available from the settings page to randomize the level of the generated  | the same location. I also added an option available from the settings page to randomize the level of the generated  | ||||||
| weapons( from +0 to +10/+5 ) | weapons(from +0 to +10/+5) | ||||||
|  | 
 | ||||||
|  | To beat the game you need to collect the 4 "Cinders of a Lord" randomized in the multiworld  | ||||||
|  | and kill the final boss "Soul of Cinder" | ||||||
| 
 | 
 | ||||||
| ## What Dark Souls III items can appear in other players' worlds? | ## What Dark Souls III items can appear in other players' worlds? | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -3,7 +3,7 @@ | ||||||
| ## Required Software | ## Required Software | ||||||
| 
 | 
 | ||||||
| - [Dark Souls III](https://store.steampowered.com/app/374320/DARK_SOULS_III/) | - [Dark Souls III](https://store.steampowered.com/app/374320/DARK_SOULS_III/) | ||||||
| - [Dark Souls III AP Client](https://github.com/Marechal-L/Dark-Souls-III-Archipelago-client) | - [Dark Souls III AP Client](https://github.com/Marechal-L/Dark-Souls-III-Archipelago-client/releases) | ||||||
| 
 | 
 | ||||||
| ## General Concept | ## General Concept | ||||||
| 
 | 
 | ||||||
|  | @ -14,22 +14,24 @@ The randomization is performed by the AP.json file, an output file generated by | ||||||
| 
 | 
 | ||||||
| ## Installation Procedures | ## Installation Procedures | ||||||
| 
 | 
 | ||||||
| **This client has only been tested with the Official Steam version of the game (v1.15/1.35) not matter which DLCs are installed** | <span style="color:tomato"> | ||||||
|  | **This mod can ban you permanently from the FromSoftware servers if used online.**  | ||||||
|  | </span>   | ||||||
|  | This client has only been tested with the Official Steam version of the game (v1.15/1.35) not matter which DLCs are installed. | ||||||
| 
 | 
 | ||||||
| Get the dinput8.dll from the [Dark Souls III AP Client](https://github.com/Marechal-L/Dark-Souls-III-Archipelago-client).   | Get the dinput8.dll from the [Dark Souls III AP Client](https://github.com/Marechal-L/Dark-Souls-III-Archipelago-client/releases). | ||||||
| Then you need to add the two following files at the root folder of your game  | Then you need to add the two following files at the root folder of your game (e.g. "SteamLibrary\steamapps\common\DARK SOULS III\Game"): | ||||||
| ( e.g. "SteamLibrary\steamapps\common\DARK SOULS III\Game" ):   |  | ||||||
| - **dinput8.dll** | - **dinput8.dll** | ||||||
| - **AP.json** (renamed from the generated file AP-{ROOM_ID}.json) | - **AP.json** : The .json file downloaded from the multiworld room or provided by the host, named AP-{ROOM_ID}.json, has to be renamed to AP.json. | ||||||
| 
 | 
 | ||||||
| ## Joining a MultiWorld Game | ## Joining a MultiWorld Game | ||||||
| 
 | 
 | ||||||
| 1. Run DarkSoulsIII.exe or run the game through Steam | 1. Run DarkSoulsIII.exe or run the game through Steam | ||||||
| 2. Type in /connect {SERVER_IP}:{SERVER_PORT} in the "Windows Command Prompt" that opened | 2. Type in "/connect {SERVER_IP}:{SERVER_PORT}" in the "Windows Command Prompt" that opened | ||||||
| 3. Once connected, create a new game, choose a class and wait for the others before starting | 3. Once connected, create a new game, choose a class and wait for the others before starting | ||||||
| 4. You can quit and launch at anytime during a game | 4. You can quit and launch at anytime during a game | ||||||
| 
 | 
 | ||||||
| ## Where do I get a config file? | ## Where do I get a config file? | ||||||
| 
 | 
 | ||||||
| The [Player Settings](/games/Dark%20Souls%20III/player-settings) page on the website allows you to | The [Player Settings](/games/Dark%20Souls%20III/player-settings) page on the website allows you to | ||||||
| configure your personal settings and export them into a config file | configure your personal settings and export them into a config file | ||||||
|  |  | ||||||
|  | @ -0,0 +1,38 @@ | ||||||
|  | # Guide d'installation de Dark Souls III Randomizer | ||||||
|  | 
 | ||||||
|  | ## Logiciels requis | ||||||
|  | 
 | ||||||
|  | - [Dark Souls III](https://store.steampowered.com/app/374320/DARK_SOULS_III/) | ||||||
|  | - [Client AP de Dark Souls III](https://github.com/Marechal-L/Dark-Souls-III-Archipelago-client/releases) | ||||||
|  | 
 | ||||||
|  | ## Concept général | ||||||
|  | 
 | ||||||
|  | Le client Archipelago de Dark Souls III est un fichier dinput8.dll. Cette .dll va lancer une invite de commande Windows | ||||||
|  | permettant de lire des informations de la partie et écrire des commandes pour intéragir avec le serveur Archipelago. | ||||||
|  | 
 | ||||||
|  | Le mélange des objets est réalisé par le fichier AP.json, un fichier généré par le serveur Archipelago. | ||||||
|  | 
 | ||||||
|  | ## Procédures d'installation | ||||||
|  | 
 | ||||||
|  | <span style="color:tomato"> | ||||||
|  | **Il y a des risques de bannissement permanent des serveurs FromSoftware si ce mod est utilisé en ligne.** | ||||||
|  | </span>   | ||||||
|  | Ce client a été testé sur la version Steam officielle du jeu (v1.15/1.35), peu importe les DLCs actuellement installés. | ||||||
|  | 
 | ||||||
|  | Télécharger le fichier dinput8.dll disponible dans le [Client AP de Dark Souls III](https://github.com/Marechal-L/Dark-Souls-III-Archipelago-client/releases). | ||||||
|  | Vous devez ensuite ajouter les deux fichiers suivants à la racine du jeu  | ||||||
|  | (ex: "SteamLibrary\steamapps\common\DARK SOULS III\Game"): | ||||||
|  | - **dinput8.dll** | ||||||
|  | - **AP.json** : Le fichier .json téléchargé depuis la <em>room</em> ou donné par l'hôte de la partie, nommé AP-{ROOM_ID}.json, doit être renommé en AP.json. | ||||||
|  | 
 | ||||||
|  | ## Rejoindre une partie Multiworld | ||||||
|  | 
 | ||||||
|  | 1. Lancer DarkSoulsIII.exe ou lancer le jeu depuis Steam | ||||||
|  | 2. Ecrire "/connect {SERVER_IP}:{SERVER_PORT}" dans l'invite de commande Windows ouverte au lancement du jeu | ||||||
|  | 3. Une fois connecté, créez une nouvelle partie, choisissez une classe et attendez que les autres soient prêts avant de lancer | ||||||
|  | 4. Vous pouvez quitter et lancer le jeu n'importe quand pendant une partie | ||||||
|  | 
 | ||||||
|  | ## Où trouver le fichier de configuration ? | ||||||
|  | 
 | ||||||
|  | La [Page de configuration](/games/Dark%20Souls%20III/player-settings) sur le site vous permez de configurer vos  | ||||||
|  | paramètres et de les exporter sous la forme d'un fichier. | ||||||
		Loading…
	
		Reference in New Issue