| 
									
										
										
										
											2021-07-22 18:21:31 +02:00
										 |  |  | # What is this file?
 | 
					
						
							|  |  |  | # This file contains options which allow you to configure your multiworld experience while allowing others
 | 
					
						
							|  |  |  | # to play how they want as well.
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # How do I use it?
 | 
					
						
							|  |  |  | # The options in this file are weighted. This means the higher number you assign to a value, the more
 | 
					
						
							|  |  |  | # chances you have for that option to be chosen. For example, an option like this:
 | 
					
						
							|  |  |  | #
 | 
					
						
							|  |  |  | # map_shuffle:
 | 
					
						
							|  |  |  | #   on: 5
 | 
					
						
							|  |  |  | #   off: 15
 | 
					
						
							|  |  |  | #
 | 
					
						
							|  |  |  | # Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned off
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # I've never seen a file like this before. What characters am I allowed to use?
 | 
					
						
							|  |  |  | # This is a .yaml file. You are allowed to use most characters.
 | 
					
						
							|  |  |  | # To test if your yaml is valid or not, you can use this website:
 | 
					
						
							|  |  |  | # http://www.yamllint.com/
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | description: Default {{ game }} Template # Used to describe your yaml. Useful if you have multiple files
 | 
					
						
							| 
									
										
										
										
											2021-08-31 19:54:55 +02:00
										 |  |  | # Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit
 | 
					
						
							|  |  |  | name: YourName{number}
 | 
					
						
							| 
									
										
										
										
											2021-07-22 18:21:31 +02:00
										 |  |  | #{player} will be replaced with the player's slot number.
 | 
					
						
							|  |  |  | #{PLAYER} will be replaced with the player's slot number if that slot number is greater than 1.
 | 
					
						
							|  |  |  | #{number} will be replaced with the counter value of the name.
 | 
					
						
							|  |  |  | #{NUMBER} will be replaced with the counter value of the name if the counter value is greater than 1.
 | 
					
						
							|  |  |  | game:
 | 
					
						
							|  |  |  |   {{ game }}: 1
 | 
					
						
							|  |  |  | requires:
 | 
					
						
							|  |  |  |   version: {{ __version__ }} # Version of Archipelago required for this yaml to work as expected.
 | 
					
						
							|  |  |  | # Shared Options supported by all games:
 | 
					
						
							| 
									
										
										
										
											2021-09-17 00:17:54 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-08-31 19:54:55 +02:00
										 |  |  | {%- macro range_option(option) %}
 | 
					
						
							|  |  |  |     # you can add additional values between minimum and maximum
 | 
					
						
							|  |  |  |     {%- set data, notes = dictify_range(option) %}
 | 
					
						
							|  |  |  |     {%- for entry, default in data.items() %}
 | 
					
						
							|  |  |  |     {{ entry }}: {{ default }}{% if notes[entry] %} # {{ notes[entry] }}{% endif %}
 | 
					
						
							|  |  |  |     {%- endfor -%}
 | 
					
						
							| 
									
										
										
										
											2021-08-31 19:56:45 +02:00
										 |  |  | {% endmacro %}
 | 
					
						
							| 
									
										
										
										
											2021-07-22 18:21:31 +02:00
										 |  |  | {{ game }}:
 | 
					
						
							| 
									
										
										
										
											2021-08-30 16:31:56 +02:00
										 |  |  |   {%- for option_key, option in options.items() %}
 | 
					
						
							|  |  |  |   {{ option_key }}:{% if option.__doc__ %} # {{ option.__doc__ | replace('\n', '\n#') | indent(4, first=False) }}{% endif %}
 | 
					
						
							| 
									
										
										
										
											2021-09-18 01:32:34 +02:00
										 |  |  |     {%- if option.range_start is defined and option.range_start is number %}
 | 
					
						
							| 
									
										
										
										
											2021-08-31 19:54:55 +02:00
										 |  |  |     {{- range_option(option) -}}
 | 
					
						
							| 
									
										
										
										
											2021-07-22 18:21:31 +02:00
										 |  |  |     {%- elif option.options -%}
 | 
					
						
							| 
									
										
										
										
											2021-08-30 16:31:56 +02:00
										 |  |  |     {%- for suboption_option_id, sub_option_name in option.name_lookup.items() %}
 | 
					
						
							| 
									
										
										
										
											2021-07-22 18:21:31 +02:00
										 |  |  |     {{ sub_option_name }}: {% if suboption_option_id == option.default %}50{% else %}0{% endif %}
 | 
					
						
							|  |  |  |     {%- endfor -%}
 | 
					
						
							| 
									
										
										
										
											2022-06-12 05:48:52 +00:00
										 |  |  |     {% if option.default == "random" %}
 | 
					
						
							|  |  |  |     random: 50
 | 
					
						
							|  |  |  |     {%- endif -%}
 | 
					
						
							| 
									
										
										
										
											2021-07-22 18:21:31 +02:00
										 |  |  |     {%- else %}
 | 
					
						
							| 
									
										
										
										
											2021-09-17 00:17:54 +02:00
										 |  |  |     {{ yaml_dump(default_converter(option.default)) | indent(4, first=False) }}
 | 
					
						
							| 
									
										
										
										
											2021-07-22 18:21:31 +02:00
										 |  |  |   {%- endif -%}
 | 
					
						
							| 
									
										
										
										
											2021-08-31 19:56:45 +02:00
										 |  |  |   {%- endfor %}
 | 
					
						
							| 
									
										
										
										
											2021-08-31 19:54:55 +02:00
										 |  |  |   {% if not options %}{}{% endif %}
 |