mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 20:21:32 -06:00
462ddce72c
* Fix wrapping too early if docstring is within 120 characters and re-indent other lines. * Remove auto-word wrapping and tweaked all worlds' option docstrings formatting. Options should wrap around the 120 character mark to prevent template files from being too long horizontally. This also allows manual-indentation to work again. * Fix missing '#' on empty lines in output from docstring.
86 lines
3.1 KiB
YAML
86 lines
3.1 KiB
YAML
# Q. What is this file?
|
|
# A. This file contains options which allow you to configure your multiworld experience while allowing
|
|
# others to play how they want as well.
|
|
#
|
|
# Q. How do I use it?
|
|
# A. 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.
|
|
#
|
|
# Q. I've never seen a file like this before. What characters am I allowed to use?
|
|
# A. 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/
|
|
# You can also verify your Archipelago settings are valid at this site:
|
|
# https://archipelago.gg/check
|
|
|
|
# Your name in-game. Spaces will be replaced with underscores and there is a 16-character limit.
|
|
# {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.
|
|
name: Player{number}
|
|
|
|
# Used to describe your yaml. Useful if you have multiple files.
|
|
description: Default {{ game }} Template
|
|
|
|
game: {{ game }}
|
|
requires:
|
|
version: {{ __version__ }} # Version of Archipelago required for this yaml to work as expected.
|
|
|
|
{%- macro range_option(option) %}
|
|
# You can define additional values between the minimum and maximum values.
|
|
# Minimum value is {{ option.range_start }}
|
|
# Maximum value is {{ option.range_end }}
|
|
{%- set data, notes = dictify_range(option) %}
|
|
{%- for entry, default in data.items() %}
|
|
{{ entry }}: {{ default }}{% if notes[entry] %} # {{ notes[entry] }}{% endif %}
|
|
{%- endfor -%}
|
|
{% endmacro %}
|
|
|
|
{{ game }}:
|
|
{%- for option_key, option in options.items() %}
|
|
{{ option_key }}:
|
|
{%- if option.__doc__ %}
|
|
# {{ option.__doc__
|
|
| trim
|
|
| replace('\n\n', '\n \n')
|
|
| replace('\n ', '\n# ')
|
|
| indent(4, first=False)
|
|
}}
|
|
{%- endif -%}
|
|
|
|
{%- if option.__doc__ and option.range_start is defined %}
|
|
#
|
|
{%- endif -%}
|
|
|
|
{%- if option.range_start is defined and option.range_start is number %}
|
|
{{- range_option(option) -}}
|
|
|
|
{%- elif option.options -%}
|
|
{%- for suboption_option_id, sub_option_name in option.name_lookup.items() %}
|
|
{{ sub_option_name }}: {% if suboption_option_id == option.default %}50{% else %}0{% endif %}
|
|
{%- endfor -%}
|
|
|
|
{%- if option.name_lookup[option.default] not in option.options %}
|
|
{{ option.default }}: 50
|
|
{%- endif -%}
|
|
|
|
{%- elif option.default is string %}
|
|
{{ option.default }}: 50
|
|
|
|
{%- elif option.default is iterable and option.default is not mapping %}
|
|
{{ option.default | list }}
|
|
|
|
{%- else %}
|
|
{{ yaml_dump(option.default) | trim | indent(4, first=false) }}
|
|
{%- endif -%}
|
|
{{ "\n" }}
|
|
{%- endfor %}
|