From 4cf11c304869bb746ecb77ee03601d96f3da814c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Ritzl?= Date: Tue, 14 Sep 2021 13:30:46 +0200 Subject: [PATCH] Added info about websocket configuration --- docs/index.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 36e8935..362fcb7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,10 +56,23 @@ https://github.com/defold/extension-websocket/archive/master.zip We recommend using a link to a zip file of a [specific release](https://github.com/defold/extension-websocket/releases). +## Configuration +The following configuration options can be set in the game.project file: + +``` +[websocket] +debug = 1 +socket_timeout = 10000000 +``` + +* `debug` - Log level where 0 means no logs and higher values shows more logs (currently 1 or 2). +* `socket_timeout` - Timeout for the underlying socket connection. In microseconds. + + ## Source code The source code is available on [GitHub](https://github.com/defold/extension-websocket) ## API reference -https://defold.com/extension-websocket/api/ \ No newline at end of file +https://defold.com/extension-websocket/api/