summaryrefslogtreecommitdiff
path: root/docs/game-controller.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/game-controller.txt')
-rw-r--r--docs/game-controller.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/game-controller.txt b/docs/game-controller.txt
new file mode 100644
index 0000000..bd63dc8
--- /dev/null
+++ b/docs/game-controller.txt
@@ -0,0 +1,9 @@
+How to use the game controller:
+After setting a channel, right-click the controller to start/stop using it.
+While using a controller, it will send a table with the control inputs, pitch, yaw, look vector, and name of the player using the controller each time one of these values changes, up to 5 times per second.
+When a player leaves a controller, the string "player_left" is sent.
+In addition to right-clicking the controller in use to stop using it, the following will also cause a player to stop using the controller:
+* The controller is moved or removed
+* The player leaves the game
+* The player is teleported away from the controller
+* The controller receives the string "release" on its digilines channel