README.md

Mind Flayer - WebSocket Server

WebSocket server component used for communicating with the Mind Flayer VTT module and external devices

Usage

To get the Mind Flayer VTT module to work, this WebSocket server is a base requirement, without it there is no communication between VTT and your control devices.

Installation

Docker

You need to install Docker first. Afterwards you can run the server:

docker run -d --restart unless-stopped --name mindflayer-server -p 10443:10443 mindflayervtt/server

Docker Compose

You can use the following yml with docker-compose as well, copy the compose config down below into a file named docker-compose.yml

version: "3"

services:
  mindflayer-server:
    container_name: mindflayer-server
    image: mindflayervtt/server
    ports:
      - 10443:10443/tcp
    restart: unless-stopped

Then run

docker-compose up -d

Manual

If you want to run it on your machine without docker, you need to install NodeJS 14. Afterwards check out the repository:

git clone https://github.com/mindflayer-vtt/mindflayer-server

Install dependencies

npm install --production

Run the srver

npm start

Verify

To see if the server is running, simply open https://localhost:10443 in your local browser, you should see the test client app. (replace localhost with the IP or hostname of your actual host where you installed the server)