Revise comments in multiple YAML files (#137)
* Clean up README.md and easy.yaml Removed periods at end of bullets General revisions to wording and format Updated glitch logic comments in easy.yaml * #133: Implemented requested changes by ljwu * Update README.md * Revise comments in multiple YAML files * #137: Implement revisions from PR conversations
This commit is contained in:
Pandatron76
GitHub
parent
ecf5c505d3
commit
33a86e0812
107
host.yaml
107
host.yaml
|
|
@ -1,17 +1,17 @@
|
|||
general_options:
|
||||
#File name of the v1.0 J rom
|
||||
# File name of the v1.0 J rom
|
||||
rom_file: "Zelda no Densetsu - Kamigami no Triforce (Japan).sfc"
|
||||
# set this to your (Q)Usb2Snes location if you want the MultiClient to attempt an auto start, does nothing if not found
|
||||
# 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"
|
||||
# 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
|
||||
# True for operating system default program
|
||||
# Alternatively, a path to a program to open the .sfc file with
|
||||
rom_start: true
|
||||
# Where to place output files
|
||||
output_path: "output"
|
||||
#options for MultiServer
|
||||
#null means nothing, for the server this means to default the value
|
||||
#these overwrite command line arguments!
|
||||
# Options for MultiServer
|
||||
# Null means nothing, for the server this means to default the value
|
||||
# These overwrite command line arguments!
|
||||
server_options:
|
||||
host: null
|
||||
port: 38281
|
||||
|
|
@ -20,64 +20,77 @@ server_options:
|
|||
savefile: null
|
||||
disable_save: false
|
||||
loglevel: "info"
|
||||
#automatically forward the port that is used, then close that port after 24 hours
|
||||
# Automatically forward the port that is used, then close that port after 24 hours
|
||||
port_forward: false
|
||||
#Disallow !getitem. Old /getitem cannot be blocked this way
|
||||
# Disallow !getitem. Old /getitem cannot be blocked this way
|
||||
disable_item_cheat: false
|
||||
#Client hint system
|
||||
#points given to player for each acquired item
|
||||
# Client hint system
|
||||
# Points given to a player for each acquired item in their world
|
||||
location_check_points: 1
|
||||
#point cost to receive a hint via !hint for players
|
||||
hint_cost: 1000 #set to 0 if you want free hints
|
||||
#forfeit modes: "disabled" -> clients can't forfeit, "enabled" -> clients can always forfeit
|
||||
# Point cost to receive a hint via !hint for players
|
||||
hint_cost: 1000 # Set to 0 if you want free hints
|
||||
# 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
|
||||
# "auto-enabled" -> automatic forfeit on goal completion and manual forfeit is also enabled
|
||||
# warning: only Berserker's Multiworld clients of version 2.1+ send game beaten information
|
||||
# Warning: Only Berserker's Multiworld clients of version 2.1+ send game beaten information
|
||||
forfeit_mode: "goal"
|
||||
# Remaining modes
|
||||
# !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
|
||||
# "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"
|
||||
# automatically shut down the server after this many seconds without new location checks, 0 to keep running
|
||||
# Automatically shut down the server after this many seconds without new location checks, 0 to keep running
|
||||
auto_shutdown: 0
|
||||
#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 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
|
||||
#options for MultiMystery.py
|
||||
# Options for MultiMystery.py
|
||||
multi_mystery_options:
|
||||
#teams, however, note that there is currently no way to supply names for teams 2+ through MultiMystery
|
||||
# Teams
|
||||
# Note that there is currently no way to supply names for teams 2+ through MultiMystery
|
||||
teams: 1
|
||||
#location of your Enemizer CLI, available here: https://github.com/Bonta0/Enemizer/releases
|
||||
# Location of your Enemizer CLI, available here: https://github.com/Bonta0/Enemizer/releases
|
||||
enemizer_path: "EnemizerCLI/EnemizerCLI.Core.exe"
|
||||
#folder from which the player yaml files are pulled from
|
||||
# Folder from which the player yaml files are pulled from
|
||||
player_files_path: "Players"
|
||||
#meta file name, within players folder
|
||||
# Meta file name, within the stated player_files_path location
|
||||
meta_file_path: "meta.yaml"
|
||||
#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
|
||||
# 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
|
||||
create_spoiler: 1
|
||||
#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)
|
||||
# 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)
|
||||
zip_roms: 0
|
||||
# zip diff files, 2 -> delete the non-zipped one. -1 -> create them without zipping
|
||||
# Zip diffs
|
||||
# -1 -> Create them without zipping
|
||||
# 2 -> Delete the non-zipped one.
|
||||
zip_diffs: 2
|
||||
#include the spoiler log in the zip, 2 -> delete the non-zipped one
|
||||
# Zip spoiler log
|
||||
# 0 -> Include the spoiler log in the zip
|
||||
# 2 -> Delete the non-zipped one
|
||||
zip_spoiler: 0
|
||||
#include the multidata file in the zip, 2 -> delete the non-zipped one, which also means the server won't autostart
|
||||
# Zip multidata
|
||||
# 1 -> Include the multidata file in the zip
|
||||
# 2 -> Delete the non-zipped one, which also means the server won't autostart
|
||||
zip_multidata: 1
|
||||
#zip algorithm to use. zip is recommended for patch files, 7z is recommended for roms. All of them get the job done.
|
||||
zip_format: 1 # 1 -> zip, 2 -> 7z, 3->bz2
|
||||
#create roms flagged as race roms
|
||||
# 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
|
||||
# Create roms flagged as race roms
|
||||
race: 0
|
||||
46
meta.yaml
46
meta.yaml
|
|
@ -1,36 +1,36 @@
|
|||
# this file has to be in the Players folder to take effect, keeping the "meta.yaml" name.
|
||||
# This file has to be in the Players folder to take effect, keeping the "meta.yaml" name
|
||||
# A meta file rolls its own set of options first
|
||||
# the result will then overwrite each player's option in that particular field
|
||||
# for example, if a meta.yaml fast_ganon result is rolled, every player will have that fast_ganon goal
|
||||
# there is the special case of null, which ignores that part of the meta.yaml,
|
||||
# The result will then overwrite each player's option in that particular field
|
||||
# For example, if a meta.yaml fast_ganon result is rolled, every player will have that fast_ganon goal
|
||||
# There is the special case of null, which ignores that part of the meta.yaml,
|
||||
# allowing for a chance for that meta to not take effect
|
||||
# players can also have a meta_ignore option to ignore specific options
|
||||
# example of ignore that would be in a player's file:
|
||||
# Players can also have a meta_ignore option to ignore specific options
|
||||
# Example of ignore that would be in a player's file:
|
||||
# meta_ignore:
|
||||
# world_state:
|
||||
# mode:
|
||||
# inverted
|
||||
#this means, if world_state is meta-rolled and the result happens to be inverted, then defer to the player's yaml instead.
|
||||
# This means, if mode is meta-rolled and the result happens to be inverted, then defer to the player's yaml instead.
|
||||
meta_description: Meta-Mystery file with the intention of having similar-length completion times for a hopefully better experience
|
||||
progression_balancing: # progression balancing tries to make sure that the player has *something* towards any players goal in each "sphere"
|
||||
on: 0 # force every player into progression balancing
|
||||
off: 0 # force every player out of progression balancing, then prepare for a lot of logical BK
|
||||
null: 1 # let players decide via their own progression_balancing flag in their yaml, defaulting to on
|
||||
progression_balancing: # Progression balancing tries to make sure that the player has *something* towards any players goal in each "sphere"
|
||||
on: 0 # Force every player into progression balancing
|
||||
off: 0 # Force every player out of progression balancing, then prepare for a lot of logical BK
|
||||
null: 1 # Let players decide via their own progression_balancing flag in their yaml, defaulting to on
|
||||
goals:
|
||||
ganon: 100
|
||||
fast_ganon: 250
|
||||
dungeons: 50
|
||||
pedestal: 100
|
||||
triforce-hunt: 5
|
||||
ganon: 100 # Climb GT, defeat Agahnim 2, and then kill Ganon
|
||||
fast_ganon: 250 # Only killing Ganon is required. The hole is always open. However, items may still be placed in GT
|
||||
dungeons: 50 # Defeat the boss of all dungeons, including Agahnim's tower and GT (Aga 2)
|
||||
pedestal: 100 # Pull the Triforce from the Master Sword pedestal
|
||||
triforce-hunt: 5 # Collect 20 of 30 Triforce pieces spread throughout the worlds, then turn them in to Murahadala in front of Hyrule Castle
|
||||
local_triforce_hunt: 10 # Collect 20 of 30 Triforce pieces spread throughout your world, then turn them in to Murahadala in front of Hyrule Castle
|
||||
ganon_triforce_hunt: 5 # Collect 20 of 30 Triforce pieces spread throughout the worlds, then kill Ganon
|
||||
local_ganon_triforce_hunt: 20 # Collect 20 of 30 Triforce pieces spread throughout your world, then kill Ganon
|
||||
null: 0 # maintain individual goals
|
||||
world_state:
|
||||
null: 0 # Maintain individual goals
|
||||
mode:
|
||||
standard: 10
|
||||
open: 60
|
||||
inverted: 10
|
||||
retro: 10
|
||||
null: 10 # maintain individual world states
|
||||
null: 10 # Maintain individual world states
|
||||
tower_open:
|
||||
'0': 8
|
||||
'1': 7
|
||||
|
|
@ -40,7 +40,7 @@ tower_open:
|
|||
'5': 3
|
||||
'6': 2
|
||||
'7': 1
|
||||
random: 10 # a different GT open time should not usually result in a vastly different completion time, unless ganon goal and tower_open > ganon_open
|
||||
random: 10 # A different GT open time should not usually result in a vastly different completion time, unless ganon goal and tower_open > ganon_open
|
||||
ganon_open:
|
||||
'0': 3
|
||||
'1': 4
|
||||
|
|
@ -50,5 +50,5 @@ ganon_open:
|
|||
'5': 8
|
||||
'6': 9
|
||||
'7': 10
|
||||
random: 5 # this will mean differing completion times. But leaving it for that surprise effect
|
||||
#do not use meta rom options at this time.
|
||||
random: 5 # This will mean differing completion times. But leaving it for that surprise effect
|
||||
# Do not use meta rom options at this time
|
||||
|
|
@ -154,16 +154,16 @@ boss_shuffle:
|
|||
full: 0 # 3 bosses can occur twice
|
||||
random: 0 # Any boss can appear any amount of times
|
||||
singularity: 0 # Picks a boss, tries to put it everywhere that works, if there's spaces remaining it picks a boss to fill those
|
||||
enemy_shuffle: # randomize enemy placement
|
||||
enemy_shuffle: # Randomize enemy placement
|
||||
on: 0
|
||||
off: 50
|
||||
killable_thieves: # make thieves killable.
|
||||
on: 0 # usually turned on together with enemy_shuffle to make annoying thief placement more manageable
|
||||
killable_thieves: # Make thieves killable
|
||||
on: 0 # Usually turned on together with enemy_shuffle to make annoying thief placement more manageable
|
||||
off: 50
|
||||
tile_shuffle: # randomize the tile layouts in flying tile rooms
|
||||
tile_shuffle: # Randomize the tile layouts in flying tile rooms
|
||||
on: 0
|
||||
off: 50
|
||||
bush_shuffle: # randomize the chance that bushes have enemies and the enemies under said bush
|
||||
bush_shuffle: # Randomize the chance that bushes have enemies and the enemies under said bush
|
||||
on: 0
|
||||
off: 50
|
||||
enemy_damage:
|
||||
|
|
@ -187,12 +187,12 @@ beemizer: # Remove items from the global item pool and replace them with single
|
|||
4: 0 # 100% of the non-essential item pool is replaced with bee traps
|
||||
shop_shuffle:
|
||||
none: 50
|
||||
i: 0 # shuffle the inventories of the shops around
|
||||
p: 0 # randomize the prices of the items in shop inventories
|
||||
u: 0 # shuffle capacity upgrades into the item pool (and allow them to traverse the multiworld)
|
||||
ip: 0 # shuffle inventories and randomize prices
|
||||
uip: 0 # shuffle inventories, randomize prices and shuffle capacity upgrades into the item pool
|
||||
# you can add more combos
|
||||
i: 0 # Shuffle the inventories of the shops around
|
||||
p: 0 # Randomize the prices of the items in shop inventories
|
||||
u: 0 # Shuffle capacity upgrades into the item pool (and allow them to traverse the multiworld)
|
||||
ip: 0 # Shuffle inventories and randomize prices
|
||||
uip: 0 # Shuffle inventories, randomize prices and shuffle capacity upgrades into the item pool
|
||||
# You can add more combos
|
||||
timer:
|
||||
none: 50 # No timer will be displayed.
|
||||
timed: 0 # Starts with clock at zero. Green clocks subtract 4 minutes (total 20). Blue clocks subtract 2 minutes (total 10). Red clocks add two minutes (total 10). Winner is the player with the lowest time at the end.
|
||||
|
|
|
|||
Loading…
Reference in New Issue