2020-03-06 00:48:23 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								general_options:
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # File name of the v1.0 J rom
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-06 00:48:23 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  rom_file: "Zelda no Densetsu - Kamigami no Triforce (Japan).sfc"
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Set this to your (Q)Usb2Snes location if you want the MultiClient to attempt an auto start, does nothing if not found
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-07 04:18:26 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  qusb2snes: "QUsb2Snes\\QUsb2Snes.exe"
							 | 
						
					
						
							
								
									
										
										
										
											2020-07-15 17:19:16 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Set this to false to never autostart a rom (such as after patching)
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # True for operating system default program
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # Alternatively, a path to a program to open the .sfc file with
							 | 
						
					
						
							
								
									
										
										
										
											2020-07-15 17:19:16 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  rom_start: true
							 | 
						
					
						
							
								
									
										
										
										
											2020-08-20 15:43:22 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Where to place output files
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  output_path: "output"
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								# Options for MultiServer
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								# Null means nothing, for the server this means to default the value
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								# These overwrite command line arguments!
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								server_options:
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-13 00:19:27 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  host: null
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-15 01:01:27 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  port: 38281
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  password: null
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  multidata: null
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  savefile: null
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-02 11:21:33 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  disable_save: false
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  loglevel: "info"
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-21 22:11:19 -07:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Allows for clients to log on and manage the server.  If this is null, no remote administration is possible.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  server_password: null
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Disallow !getitem. Old /getitem cannot be blocked this way
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-02 11:21:33 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  disable_item_cheat: false
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Client hint system
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # Points given to a player for each acquired item in their world
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-02 11:21:33 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  location_check_points: 1
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Point cost to receive a hint via !hint for players
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-15 01:01:27 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  hint_cost: 1000 # Set to 0 if you want free hints
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Forfeit modes
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # "disabled" -> clients can't forfeit,
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # "enabled" -> clients can always forfeit
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-25 15:11:58 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # "auto" -> automatic forfeit on goal completion, "goal" -> clients can forfeit after achieving their goal
							 | 
						
					
						
							
								
									
										
										
										
											2020-05-04 02:47:22 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # "auto-enabled" -> automatic forfeit on goal completion and manual forfeit is also enabled
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-25 15:11:58 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  forfeit_mode: "goal"
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Remaining modes
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-25 15:11:58 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # !remaining handling, that tells a client which items remain in their pool
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # "enabled" -> Client can always ask for remaining items
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # "disabled" -> Client can never ask for remaining items
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # "goal" -> Client can ask for remaining items after goal completion
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-25 15:11:58 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  remaining_mode: "goal"
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Automatically shut down the server after this many seconds without new location checks, 0 to keep running
							 | 
						
					
						
							
								
									
										
										
										
											2020-06-13 22:49:57 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  auto_shutdown: 0
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Compatibility handling
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 2 -> Recommended for casual/cooperative play, attempt to be compatible with everything across all versions
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 1 -> Recommended for friendly racing, only allow Berserker's Multiworld, to disallow old /getitem for example
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 0 -> Recommended for tournaments to force a level playing field, only allow an exact version match
							 | 
						
					
						
							
								
									
										
										
										
											2020-07-16 16:57:38 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  compatibility: 2
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								# Options for MultiMystery.py
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								multi_mystery_options:
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Teams
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # Note that there is currently no way to supply names for teams 2+ through MultiMystery
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-23 17:06:44 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  teams: 1
							 | 
						
					
						
							
								
									
										
										
										
											2020-11-15 14:49:09 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Location of your Enemizer CLI, available here: https://github.com/Ijwu/Enemizer/releases
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  enemizer_path: "EnemizerCLI/EnemizerCLI.Core.exe"
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Folder from which the player yaml files are pulled from
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  player_files_path: "Players"
							 | 
						
					
						
							
								
									
										
										
										
											2020-11-08 07:26:50 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #amount of players, 0 to infer from player files
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  players: 0
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # general weights file, within the stated player_files_path location
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # gets used if players is higher than the amount of per-player files found to fill remaining slots
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  weights_file_path: "weights.yaml"
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Meta file name, within the stated player_files_path location
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-18 09:14:31 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  meta_file_path: "meta.yaml"
							 | 
						
					
						
							
								
									
										
										
										
											2021-03-03 02:20:37 -08:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Option to pre-roll a yaml that will be used to roll future seeds with the exact same settings every single time.
							 | 
						
					
						
							
								
									
										
										
										
											2021-03-05 11:32:24 -08:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # If using a pre-rolled yaml fails with "Please fix your yaml.", please file a bug report including both the original yaml
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # as well as the generated pre-rolled yaml.
							 | 
						
					
						
							
								
									
										
										
										
											2021-03-03 02:20:37 -08:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  pre_roll: false
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Automatically launches {player_name}.yaml's ROM file using the OS's default program once generation completes. (likely your emulator)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # Does nothing if the name is not found
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # Example: player_name = "Berserker"
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  player_name: "" # The hosts name
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # Create a spoiler file
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 0 -> None
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 1 -> Full spoiler
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 2 -> Spoiler without playthrough
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-17 02:09:33 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  create_spoiler: 1
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Zip the resulting roms
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 0 -> Don't
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 1 -> Create a zip
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 2 -> Create a zip and delete the ROMs that will be in it, except the hosts (requires player_name to be set correctly)
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-07 18:57:50 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  zip_roms: 0
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Zip diffs
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # -1 -> Create them without zipping
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 2 -> Delete the non-zipped one.
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-06 00:48:23 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  zip_diffs: 2
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Zip spoiler log
							 | 
						
					
						
							
								
									
										
										
										
											2020-12-30 16:34:51 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # 1 -> Include the spoiler log in the zip
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # 2 -> Delete the non-zipped one
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-17 02:09:33 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  zip_spoiler: 0
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Zip multidata
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 1 -> Include the multidata file in the zip
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 2 -> Delete the non-zipped one, which also means the server won't autostart
							 | 
						
					
						
							
								
									
										
										
										
											2020-06-26 19:29:33 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  zip_multidata: 1
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-03 07:14:25 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Zip algorithm
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 1 -> Zip is recommended for patch files
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 2 -> 7z is recommended for roms. All of them get the job done.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 3 -> bz2
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  zip_format: 1
							 | 
						
					
						
							
								
									
										
										
										
											2020-11-08 07:26:50 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Create encrypted race roms
							 | 
						
					
						
							
								
									
										
										
										
											2020-09-13 00:17:46 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  race: 0
							 | 
						
					
						
							
								
									
										
										
										
											2021-01-02 12:49:43 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # List of options that can be plando'd. Can be combined, for example "bosses, items"
							 | 
						
					
						
							
								
									
										
										
										
											2021-01-02 22:41:03 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # Available options: bosses, items, texts, connections
							 | 
						
					
						
							
								
									
										
										
										
											2021-01-02 12:49:43 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  plando_options: "bosses"
							 |