bitsquid_dt/Darktide-Mod-Framework
bitsquid_dt/Darktide-Mod-Framework
2
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Var Dump: 
dumpVar: only available in dev mode
Mailing List

mutators readme: features

Browse source
This commit is contained in:
UnShame 2018-02-22 01:49:41 +03:00
parent 69d2e49b4e
commit 1ee688402d
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
vmf_source/scripts/mods/vmf/modules/mutators/README.md
View file

@ -1,9 +1,20 @@
# Mutators
A mutator is a mod that affects other players as well as you by modifying the game rules, enemies, weapon balance etc.
You can turn your mod into a mutator by calling `mod:register_as_mutator(config)` instead of `mod:init_state()`. This way it will show up on the map screen and have additional features and options to control its behavior.
Note that you can still have additional options for your mutator in the mod options menu:
``vmf:create_options(options_widgets, false, "Title", "Description")``
## Features
* Show the toggle for the mutator on the map screen
* Choose which game modes and difficulty levels the mutator can be played on
* Add additional dice to the end game roll
* Control the order in which mutators are enabled/disabled
* Control compatibility with other mutators
* Notify players already in the lobby and just joining about enabled mutators
## Configuration
The config object is optional but obviously you'd want to provide at least a readable title for your mutator. Here are the default values: