Yu-Gi-oh! 2006: implement new game (#2795)
* Initial implementation of Yu-Gi-Oh! WC 2006 * Added Opponents and banlists * Initial implementation of Yu-Gi-Oh! WC 2006 * Added Opponents and banlists * Added Campaign Logic * Added Bonuses Logic * Added challenge logic * fixed yugioh client * ygo06 rom cleanup and include lua * ygo06 patch cleanup * ygo06 move client to world folder * lots of small changes * bug fixes * implemented filler item for yugioh06 * BizHawkClient: Add client and connector * BizHawkClient: Add launcher component and inno_setup lines * BizHawkClient: Misc stability updates and small improvements Bad commit organization a consequence of working with two different branches and not keeping the commits separated * BizHawkClient: Add docstrings * BizHawkClient: Pull in changes from other branch * BizHawkClient: Fix no handler message not displaying after changed ROMs * BizHawkClient: Remove extra print statement from lua * BizHawkClient: Change version command to use raw strings * BizHawkClient: Change script version to single integer * YGO06: added logic for "all expect type forbidden" limited duels * YGO06: Structure Deck choice now affects logic. Fixed a bug with tier 5 campaign opponents. Added logic for TD16 Union. * BizHawkClient: Add newline to version for lua script * BizHawkClient: Call send_connect from BizHawkClient's watcher loop * BizHawkClient: Add handling for failed request getting script version * BizHawkClient: Have base64.lua check lua version explicitly for bit operations On 2.9, it would detect LuaJIT and flood the console with deprecation warnings * BizHawkClient: Update connector script for slightly better errors and address Gambatte frame sync issue * BizHawkClient: Remove accidentally added print statements * BizHawkClient: Fix connector server not closing correctly * BizHawkClient: Move some connector code around, some linting * BizHawkClient: Small cleanup in lua * BizHawkClient: Lua linting * BizHawkClient: Remove outdated sentences in docstrings * YGO06: Logic additions and bug fixes * BizHawkClient: Correctly null check patch file arg * BizHawkClient: Initialize logging * BizHawkClient: Move code to worlds/_bizhawk Also splits out BizHawk communication functions to their own file for use outside this client * BizHawkClient: Add license to connector lua, add types to docs * BizHawkClient: Add module docstrings * YGO06: Logic additions * BizHawkClient: Allow clients to define multiple systems * BizHawkClient: Better logging and handling of interruptions to connection to script * YGO06: Logic additions * YGO06: Added text to options * YGO06: Ported to bizhawk client * YGO06: fix goal not being detected * YGO06: fix access item rule for tier 5 column 1 and 2 * YGO06: docu and bug fixes * YGO06: change name * YGO06: some fixes * YGO06: fix starting opponent and booster not applying * YGO06: added option to reduce the amount of challenges and remove the no ban list from pool. * YGO06: added rom being asked for on first use * YGO06: fix rules for challenges * YGO06: create proper rules for TD04 Ritual Summon * YGO06: mark most banlists as usefull instead of progression * YGO06: reduce the required core boosters across the board * YGO06: fix client not loading if another game already loaded the bizhawk client * YGO06: fix client not finding the bizhawk client. * YGO06: fix TD08 Draw not giving out an item * YGO06: small text changes * YGO06: update to version 0.4.4 * YGO06: logic mixin clean-up * YGO06: added option for campaign opponents as goal * Pokemon Emerald add encounter table randomization * Pokemon Emerald: Item ball randomization working * Pokemon Emerald: Clean up code a little * Pokemon Emerald: Partial rework of region/location creation * Pokemon Emerald: Dedupe items and add more readable names * Refactor region creation to manually defined regions * Split region json * Use new data.json with flattened constants and add HM locations * YGO06: bug fixes * YGO06: bug fix * YGO06: changes default options to be more beginner friendly * YGO06: attempt at universal tracker support. Settings are stored in slot data now. * YGO06: fix for older python versions * YGO06: fix slot data * YGO06: added diiferent opponents to the campaign * YGO06: fix small bug with opponent icons * YGO06: fix unwanted changes * YGO06: repair merge with main * YGO06: map out all of the opponents * YGO06: added opponent shuffle * YGO06: added logic to opponent shuffle * YGO06: added option to use ocg art * YGO06: bug_fixes * YGO06: removed todos, since they are not needed anymore * YGO06: added draft mode * YGO06: added logic to draft mode * YGO06: Added Money multiplier when you lose * YGO06: Fixed Unit Test errors * YGO06: Added Random deck option * YGO06: Bug fix with registering client * YGO06: client clean-up * YGO06: fixed card misspellings * YGO06: removed unused imports and other small changes * YGO06: small changes * YGO06: fix generation error when the combination of starting with "No Banlist" and not adding "No Banlist" to the pool is selected * YGO06: fix ocg art path overwriting Huge Revolution bugfix * YGO06: added comments and other minor changes * YGO06: fixed byte length in client for money * YGO06: fixes for webhost and options * YGO06: use the proper random function * YGO06: change settings to options * YGO06: move to procedure patch * YGO06: fix imports * YGO06: fix download link for patch not showing * YGO06: remove unnecessary Optional * YGO06: fix universal tracker stuff * YGO06: add typings * YGO06: small cleanup * yugioh06: small change to setup Co-authored-by: Scipio Wright <scipiowright@gmail.com> * YGO06: remove logic mixin * YGO06: fix create item and implement create filler and get filler item name * YGO06: remove double lambdas * YGO06: use pkgutil.get_data instaed pf zipFile * YGO06: fix starting items being duplicated * YGO06: lots of small changes * YGO06: moved functions to match execution order * YGO06: run ruff * YGO06: run ruff format * YGO06: fix ruff errors * YGO06: undo ruff format for rules * YGO06: move import to prevent circular dependency * YGO06: remove unused class * YGO06: optimizing rules * YGO06: some optimization and small bug fix --------- Co-authored-by: Zunawe <gyroscope15@gmail.com> Co-authored-by: Scipio Wright <scipiowright@gmail.com>
This commit is contained in:
		
							
								
								
									
										72
									
								
								worlds/yugioh06/docs/setup_en.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										72
									
								
								worlds/yugioh06/docs/setup_en.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,72 @@ | ||||
| # Setup Guide for Yu-Gi-Oh! Ultimate Masters: World Championship Tournament 2006 Archipelago | ||||
|  | ||||
| ## Important | ||||
|  | ||||
| As we are using Bizhawk, this guide is only applicable to Windows and Linux systems. | ||||
|  | ||||
| ## Required Software | ||||
|  | ||||
| - Bizhawk: [Bizhawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory) | ||||
|   - Version 2.7.0 and later are supported. | ||||
|   - Detailed installation instructions for Bizhawk can be found at the above link. | ||||
|   - Windows users must run the prereq installer first, which can also be found at the above link. | ||||
| - The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases) | ||||
| - A US or European Yu-Gi-Oh! Ultimate Masters: World Championship Tournament 2006 Rom | ||||
|  | ||||
| ## Configuring Bizhawk | ||||
|  | ||||
| Once Bizhawk has been installed, open Bizhawk and change the following settings: | ||||
|  | ||||
| - Go to Config > Customize. Switch to the Advanced tab, then switch the Lua Core from "NLua+KopiLua" to | ||||
|   "Lua+LuaInterface". This is required for the Lua script to function correctly. | ||||
|   **NOTE: Even if "Lua+LuaInterface" is already selected, toggle between the two options and reselect it. Fresh installs**  | ||||
|   **of newer versions of Bizhawk have a tendency to show "Lua+LuaInterface" as the default selected option but still load**  | ||||
|   **"NLua+KopiLua" until this step is done.** | ||||
| - Under Config > Customize > Advanced, make sure the box for AutoSaveRAM is checked, and click the 5s button. | ||||
|   This reduces the possibility of losing save data in emulator crashes. | ||||
| - Under Config > Customize, check the "Run in background" and "Accept background input" boxes. This will allow you to | ||||
|   continue playing in the background, even if another window is selected, such as the Client. | ||||
| - Under Config > Hotkeys, many hotkeys are listed, with many bound to common keys on the keyboard. You will likely want | ||||
|   to disable most of these, which you can do quickly using `Esc`. | ||||
|  | ||||
| It is strongly recommended to associate GBA rom extensions (\*.gba) to the Bizhawk we've just installed. | ||||
| To do so, we simply have to search any GBA rom we happened to own, right click and select "Open with...", unfold | ||||
| the list that appears and select the bottom option "Look for another application", then browse to the Bizhawk folder | ||||
| and select EmuHawk.exe. | ||||
|  | ||||
| ## 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? | ||||
|  | ||||
| You can customize your options by visiting the  | ||||
| [Yu-Gi-Oh! 2006 Player Options Page](/games/Yu-Gi-Oh!%202006/player-options) | ||||
|  | ||||
| ## Joining a MultiWorld Game | ||||
|  | ||||
| ### Obtain your GBA patch file | ||||
|  | ||||
| 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 `.apygo06` extension. | ||||
|  | ||||
| Double-click on your `.apygo06` file to start your client and start the ROM patch process. Once the process is finished | ||||
| (this can take a while), the client and the emulator will be started automatically (if you associated the extension | ||||
| to the emulator as recommended). | ||||
|  | ||||
| ### Connect to the Multiserver | ||||
|  | ||||
| Once both the client and the emulator are started, you must connect them. Within the emulator click on the "Tools" | ||||
| menu and select "Lua Console". Click the folder button or press Ctrl+O to open a Lua script. | ||||
|  | ||||
| Navigate to your Archipelago install folder and open `data/lua/connector_bizhawk_generic.lua`. | ||||
|  | ||||
| To connect the client to the multiserver simply put `<address>:<port>` on the textfield on top and press enter (if the | ||||
| server uses password, type in the bottom textfield `/connect <address>:<port> [password]`) | ||||
|  | ||||
| Don't forget to start manipulating RNG early by shouting "Heart of the Cards!" during generation. | ||||
		Reference in New Issue
	
	Block a user
	 Rensen3
					Rensen3