diff --git a/README.md b/README.md new file mode 100644 index 0000000..6e2bf58 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# Teststrecke + +A multiplayer couch game that uses one button per player. + +Press and hold to accelerate, release so slow down. +Steering is controlled automatically, based on distance to a wall. +Driving slower results in a smaller turn radius. + +## Config + +The config.ini file is created with default values on first launch of the game. + +## Key Whitelist + +To allow only certain keys / inputs to be allowed, a whitelist can be created. +This is useful for gamepads or controllers with multiple buttons to avoid accidentially spawning multiple cars per player. + +To create a whitelist make sure to set enabled to false unter \[keywhitelist\] in config.ini + +Start the game. In the menu press and hold all inputs that should be whitelisted, so that they all appear in this list. +Then press "Save Key Whitelist" in the lower right corner. + +A list of keys assigned to player IDs will be created under \[keywhitelist\]. + +Close the Game. Open config.ini and change enabled to true under \[keywhitelist\]. + +## Key Colors + +When assigning colors to controllers with colored tape or using [colored controllers](https://figch.de/index.php?nav=onebuttoncontroller) the input keys used in the key whitelist can be assigned to fixed colors. + +First create the key whitelist as described above. + +Close the Game and open config.ini. + +Create a new section "keycolors" with each line assigning a color to a player id. + +Godot color constants: [docs.godotengine.org/en/stable/classes/class_color.html#constants](https://docs.godotengine.org/en/stable/classes/class_color.html#constants) + +Example: + +''' +[keycolors] + +0="RED" +1="GREEN" +2="BLUE" +3="HOT_PINK" +4="YELLOW" +5="PURPLE" +6="ORANGE" +7="WHITE" +''' + +## Fullscreen + +Represents last state of in menu button "Fullscreen" + +## General + +### Remove cars timeout +**remove_cars_timeout** + +Time in seconds after which players will be removed from a running game. + +0 to disable. + +Helpful to remove accidentially spawned players after a game has started or players leaving mid game. + +### Automatic map change +**automatic_map_change_after** + +How many rounds played after the selected map changes randomly. +Useful for gameplay without UI interaction. + +0 to disable + +### Fast Mode + +fast_mode_chance + +Float in range [0.0 .. 1.0] + +How often the fast mode should be triggered for a game. +0.0 means never, 1.0 means everytime. \ No newline at end of file