gameserver

Simple nodejs server for multiuser usage: multiplayer games, chats, webrtc apps, etc. It allow creating independent sessions for users and delegate messages only inside them. Version 2.x.x works with ws library. Version 1.x.x works with socket.io library.

The idea

Each session should have its own id, or name.
Emitting a uniq id/name will create a new session. You will try to join that session, if the id/name is already exist.
Emitting other messages will be delegated only to participants 
joined to the same session.
Inactive sessions will be automatically removed

Using

ServerSide http

copy/paste files to your web-server
npm start

ServerSide https

For https connection you should provide valid certificate and cert key paths:
CERT="/var/certs/cert.crt" KEY="/var/certs/cert.key" npm start

Specify port

PORT=9999 npm start

ClientSide

Create Websocket endpoint:
```
const socket = new WebSocket(serverAddress);
```
Use socket.send() to emit events:
```
socket.send(JSON.stringify({
    event,
    args: ["roomName", { userInfo: {ip: 125.12.0.16, name: "myusername"} }, 2, 10]
}));
```
_________________________________________________
|   event             | args:[]          |
_________________________________________________
|   'gatherRoomsInfo' |                         |   
|   'create or join'  | room:string,            |
|                     | userInfo:Object = {},   |
|                     | maxPlayers:number = 2   |
|                     | maxMessages:number = 10 |
|   'restart'         | userInfo:Object = {}    |
|   'message'         | message:Object          |
_________________________________________________ 

listen to events:
```
socket.addEventListener('message', (event) => {
    const data = JSON.parse(event.data);
    
    if (data.event === "created") {
        const [room, roomState] = data.args;
        console.log("Комната создана:", room, roomState);
    }
    ...
});
```
______________________________________________________________________________
|   event      | args                    | receiver | info                                |
______________________________________________________________________________
 'roomsInfo'     rooms:Array<string>      conn peer  Received after gatherRoomsInfo will be emitted
 'created'       room, roomState          conn peer  Received after a new room has been created    
 'joined'        room, roomState          all peers  Received when somebody joined to a room  
 'full'          room                     conn peer  Received when tried to join for overflowed room
 'log'           message                  conn peer  Debug logging
 'message'       message                  all peers  Received, when somebody, emits 'message' event
 'disconnected'  socketId                 all peers  Received, when somebody disconnects
 'restarted'     roomState                all peers  Received, when somebody emits 'restart' event
 'connect_error' err                      conn peer  Received, when client have connection troubles

To secure the connection against unauthorized access, use Ed25519 JWT token

1. Generate an Ed25519 key pair.
2. Place the public key into the server folder under the name ./public.pem
3. Start the server with the environment variable VALIDATION='./public.pem'
4. Connect to the Node.js server by passing the JWT generated from the private key in the 'token' parameter:
```
const socket = new WebSocket(wss://localhost:8080/?token=${encodeURIComponent(token)});
```

Run /examples/tic-tac-toe folder:

1. Start server with http locally:
    npm start
2. Navigate to /examples/tic-tac-toe
3. Install dependencies:
    npm i
4. Start client:
    npm start
5. Visit http://localhost:8080

gameserver

Простой nodejs сервер для: многопользовательских игр, чатов, приложений для видео-звонков, итд. Позволяет создавать независимые сессии для пользователей и рассылать сообщения только внутри них. Работает на нативных вебсокетах без сторонних библиотек.

Идея

Каждая сессия должна иметь свое уникальное имя/id
Создавая сообщение с уникальным именем/id создаст новую сессию. Если имя/id уже существует,
вы будете пытаться присоединится к этой сессии.
Последующая рассылка будет производится только пользователям внутри этой сессии.
Неактивные сессии автоматический удаляются.

Использование

Сервер http

скопируйте содержимое на ваш сервер
npm start

Сервер https

Чтобы запустить сервер с https соединением нужно указать путь к валидному сертификату и ключу:
CERT="/var/certs/cert.crt" KEY="/var/certs/cert.key" npm start

Указать порт

PORT=9999 npm start

Клиент

создайте соединение с сервером: 
```
const socket = new WebSocket(serverAddress);
```
отправляйте сообщения:
```
socket.send(JSON.stringify({
    event,
    args: ["roomName", { userInfo: {ip: 125.12.0.16, name: "myusername"}, 2, 10]
}));
```
_________________________________________________
|   event             | args:type = default|
_________________________________________________
|   'gatherRoomsInfo' |                         |   
|   'create or join'  | room:string,            |
|                     | userInfo:Object = {},   |
|                     | maxPlayers:number = 2   |
|                     | maxMessages:number = 10 |
|   'restart'         | userInfo:Object = {}    |
|   'message'         | message:Object          |
_________________________________________________ 

Слушайте сообщения с сервера:
```
socket.addEventListener('message', (event) => {
    const data = JSON.parse(event.data);
    
    if (data.event === "created") {
        const [room, userInfo] = data.args;
        console.log("Комната создана:", room, userInfo);
    }
    ...
});
```
______________________________________________________________________________
|   event      | args               | receiver | info                                |
______________________________________________________________________________
 'roomsInfo'     rooms:Array<string> conn peer  Получаем, после отправки gatherRoomsInfo
 'created'       room, roomState     conn peer  Получаем, когда создается новая комната
 'joined'        room, roomState     all peers  Получаем, когда кто-то присоединяется к комнате  
 'full'          room                conn peer  Получаем, когда пытаются 
                                                присоединится к заполненной комнате
 'message'       message             all peers  Получаем, когда создают 'message' сообщение
 'disconnected'  socketId            all peers  Получаем, когда создают 'disconnects'
 'restarted'     roomState           all peers  Получаем, когда создают 'restart' сообщение
 'log'           message             conn peer  Отладочные сообщения
 'connect_error' err                 conn peer  Получаем, когда на клиенте ошибки с подключением

Чтобы закрыть соединение от сторонних подключений используется Ed25519 JWT токен

1. Сгенерируйте пару ключей ed25519
2. Публичный ключ положите в папку с сервером под именем
3. Запустите сервер с параметром VALIDATION = 'путь/имя_ключа.pem'
4. Подключаемся к Node.js серверу, передавая JWT в параметре token созданный из приватного ключа 
const socket = new WebSocket(`wss://localhost:8080/?token=${encodeURIComponent(token)}`);

Запустить /examples/tic-tac-toe папку:

1. Запустите http локально:
    npm start
2. Перейдите в папку /examples/tic-tac-toe
3. Установите node_modules:
    npm i
4. Запустите клиент:
    npm start
5. Запустите браузер и перейдите по адресу http://localhost:8080