Spaces:

Anuj-Panthri
/

hapticlink

Runtime error

App Files Files Community

avallef commited on Nov 18, 2023

Commit

0e0a112

1 Parent(s): 81ad08a

Bigger headers

Browse files

Files changed (1) hide show

server/README.md +8 -8

server/README.md CHANGED Viewed

@@ -28,7 +28,7 @@ Types can be `client -> server`, `server -> client <private | room>`.
 Private messages are sent directly to client
 Room messages are sent to everyone in a room
-### Test Connection
 **Type:** `client -> server`
 **Payload:**
@@ -38,7 +38,7 @@ Room messages are sent to everyone in a room
     "route": "test_connection"
 }
 ```
-### Set Username
 **Type:** `client -> server`
 **Payload:**
 ```typescript
@@ -65,7 +65,7 @@ Room messages are sent to everyone in a room
 }
 ```
-### Join Room
 **Type:** `client -> server`
 **Description:** Used to enter a room. Join an existing room by including roomId, or if room doesn't exist, create one with that roomId
@@ -89,7 +89,7 @@ Room messages are sent to everyone in a room
 }
 ```
-### Leave Room
 **Type:** `client -> server`
 **Description:** Used to enter a room.
@@ -112,7 +112,7 @@ Room messages are sent to everyone in a room
 }
 ```
-### Get Rooms
 **Type:** `client -> server`
 **Description:** Used to get list of joined rooms
@@ -132,7 +132,7 @@ Room messages are sent to everyone in a room
 }
 ```
-### Room Update
 **Type:** `server -> client <room>`
 **Description:** Server message that is sent when the room gets updated such as someone joins or leaves
@@ -151,7 +151,7 @@ Room messages are sent to everyone in a room
 }
 ```
-### Send Touch
 **Type:** `client -> server`
 **Description:** Used to send touch/vibration data to room. Client assigns a number for an ID. That ID is then used to update the vibration. Re-use `send_touch` to update previous vibration. Use `"type": "disable"` to disable the vibration. If an update isn't sent within 1 second of creatin/last update it will automatically be disabled.
@@ -171,7 +171,7 @@ Room messages are sent to everyone in a room
 }
 ```
-### Receive Touch
 **Type:** `server -> client <room>`
 **Description:**

 Private messages are sent directly to client
 Room messages are sent to everyone in a room
+## Test Connection
 **Type:** `client -> server`
 **Payload:**
     "route": "test_connection"
 }
 ```
+## Set Username
 **Type:** `client -> server`
 **Payload:**
 ```typescript
 }
 ```
+## Join Room
 **Type:** `client -> server`
 **Description:** Used to enter a room. Join an existing room by including roomId, or if room doesn't exist, create one with that roomId
 }
 ```
+## Leave Room
 **Type:** `client -> server`
 **Description:** Used to enter a room.
 }
 ```
+## Get Rooms
 **Type:** `client -> server`
 **Description:** Used to get list of joined rooms
 }
 ```
+## Room Update
 **Type:** `server -> client <room>`
 **Description:** Server message that is sent when the room gets updated such as someone joins or leaves
 }
 ```
+## Send Touch
 **Type:** `client -> server`
 **Description:** Used to send touch/vibration data to room. Client assigns a number for an ID. That ID is then used to update the vibration. Re-use `send_touch` to update previous vibration. Use `"type": "disable"` to disable the vibration. If an update isn't sent within 1 second of creatin/last update it will automatically be disabled.
 }
 ```
+## Receive Touch
 **Type:** `server -> client <room>`
 **Description:**