2020-03-06 00:48:23 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								general_options:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  #File name of the v1.0 J rom
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  rom_file: "Zelda no Densetsu - Kamigami no Triforce (Japan).sfc"
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-07 04:18:26 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # set this to your (Q)Usb2Snes location if you want the MultiClient to attempt an auto start, does nothing if not found
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  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)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # true for operating system default program
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # alternatively, a path to a program to open the .sfc file with
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  rom_start: true
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-07 18:55:53 +01: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:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  host: null
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-02 11:21:33 +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-03-11 09:27:07 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #automatically forward the port that is used, then close that port after 24 hours
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-02 11:21:33 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  port_forward: false
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-03 01:22:52 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #Disallow !getitem. Old /getitem cannot be blocked this way
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-02 11:21:33 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  disable_item_cheat: false
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-03 01:22:52 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #Client hint system
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  #points given to player for each acquired item
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-02 11:21:33 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  location_check_points: 1
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-03 01:22:52 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #point cost to receive a hint via !hint for players
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-02 11:21:33 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  hint_cost: 1000 #set to 0 if you want free hints
							 | 
						
					
						
							
								
									
										
										
										
											2020-04-25 15:11:58 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #forfeit modes: "disabled" -> clients can't forfeit, "enabled" -> clients can always forfeit
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # "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
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # warning: only Berserker's Multiworld clients of version 2.1+ send game beaten information
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  forfeit_mode: "goal"
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # !remaining handling, that tells a client which items remain in their pool
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # "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
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # warning: only Berserker's Multiworld clients of version 2.1+ send game beaten information
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  remaining_mode: "goal"
							 | 
						
					
						
							
								
									
										
										
										
											2020-07-10 17:42:22 +02: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-07-16 16:57:38 +02: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
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  compatibility: 2
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								#options for MultiMystery.py
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								multi_mystery_options:
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-23 17:06:44 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								#teams, however, note that there is currently no way to supply names for teams 2+ through MultiMystery
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  teams: 1
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								#Where to place the resulting files
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  output_path: "MultiMystery"
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								#location of your Enemizer CLI, available here: https://github.com/Bonta0/Enemizer/releases
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  enemizer_path: "EnemizerCLI/EnemizerCLI.Core.exe"
							 | 
						
					
						
							
								
									
										
										
										
											2020-05-31 00:28:03 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #folder from which the player yaml files are pulled from
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  player_files_path: "Players"
							 | 
						
					
						
							
								
									
										
										
										
											2020-05-31 00:28:03 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #meta file name, within players folder
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-18 09:14:31 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  meta_file_path: "meta.yaml"
							 | 
						
					
						
							
								
									
										
										
										
											2020-05-31 00:28:03 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #automatically launches {player_name}.yaml's ROM file using the OS's default program once generation completes. (likely your emulator)
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-06 00:48:23 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #does nothing if the name is not found
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  #example: player_name = "Berserker"
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  player_name: "" # the hosts name
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-06 00:48:23 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #create a spoiler file
							 | 
						
					
						
							
								
									
										
										
										
											2020-05-31 00:28:03 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # 0 -> none
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 1 -> full spoiler
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  # 2- -> spoiler without playthrough
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-17 02:09:33 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  create_spoiler: 1
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-06 00:48:23 +01: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-03-07 17:06:34 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  # zip diff files, 2-> delete the non-zipped one. Note that diffs are only created if they are placed in a zip.
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-06 00:48:23 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  zip_diffs: 2
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  #include the spoiler log in the zip, 2 -> delete the non-zipped one
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-17 02:09:33 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  zip_spoiler: 0
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-06 00:48:23 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #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-04-10 14:29:42 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #zip algorithm to use. zip is recommended for patch files, 7z is recommended for roms. All of them get the job done.
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-07 18:57:50 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  zip_format: 1 # 1 -> zip, 2 -> 7z, 3->bz2
							 | 
						
					
						
							
								
									
										
										
										
											2020-03-06 00:48:23 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  #create roms flagged as race roms
							 | 
						
					
						
							
								
									
										
										
										
											2020-02-09 05:28:48 +01:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  race: 0
							 |