(BREAKING CHANGE) Make likelihoods configurable #528
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rather than encoding the likelihood of a mode as part of the game_mode
decorator, it is now present in botconfig.yml. The defaults have been
migrated over, however any custom modes will require manual work.
If your custom mode simply re-defined a built-in mode to change the
likelihood, delete the custom mode file and customize the likelihood via
botconfig.yml instead.
If you have actual custom modes, you must remove the likelihood kwarg
from the game_mode decorator, and then add a section to your
botconfig.yml to define the mode's likelihood, like so:
gameplay:
<mode name>:
weight: <likelihood>
The default is 0 for custom modes that are missing from botconfig, i.e.
the modes will be majority-vote only. Failure to remove the likelihood
kwarg will result in the bot failing to start. This is a breaking
change.
Additionally, for sleepy and boreal some additional settings became
configurable in botconfig.yml which can be used to tweak the difficulty
of those modes.
Finally, the configuration page autogeneration for the wiki should now
properly handle union types.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rather than encoding the likelihood of a mode as part of the game_mode decorator, it is now present in botconfig.yml. The defaults have been migrated over, however any custom modes will require manual work.
If your custom mode simply re-defined a built-in mode to change the likelihood, delete the custom mode file and customize the likelihood via botconfig.yml instead.
If you have actual custom modes, you must remove the likelihood kwarg from the game_mode decorator, and then add a section to your botconfig.yml to define the mode's likelihood, like so:
The default is 0 for custom modes that are missing from botconfig, i.e. the modes will be majority-vote only. Failure to remove the likelihood kwarg will result in the bot failing to start. This is a breaking change.
Additionally, for sleepy and boreal some additional settings became configurable in botconfig.yml which can be used to tweak the difficulty of those modes.
Finally, the configuration page autogeneration for the wiki should now properly handle union types.