• Installation
• Security
• FAQ
  • Why?
  • How?
  • Help!
• Legal stuff
  • License

1. Install Node.js (version 16 recommended)
2. Clone or download (and unzip) the game to get the latest snapshot
3. Open a terminal in the game's folder, where the package.json file is located
4. Run npm start or node client to start the game normally

   Run npm run server or node server to start a dedicated server instance

• The default proxy server encrypts traffic with HTTPS.
• The only directly identifying information that is transmitted is your username.
  It will not be stored by the server, but it will be stored by other users, so be aware of that.
• All authentication (who is who & which player is the lobby's admin) is done through cryptographically securely generated unique session IDs.
  If you feel like your connection is compromised, change your username in the menu or re-launch the game to regernerate the session ID.

If you have any other questions or would like to report a security issue, please refer to our security policy.

This section contains additional information about this project, in FAQ style:

• I wanted to make a project using websockets
• I wanted to make a multiplayer CLI game
• Why not?

This project includes some client, server and common / shared code.

When you launch this game, the index.js file in the client folder is executed.
It prompts you to enter your username, after which the client contacts the server to initialize the session (this is internally called "handshake").
The server now generates a cryptographically secure session ID, sanitizes your username, and returns that data to your client.

Now your client has its session ID, which is used by the server to uniquely identify clients and for example know who the lobby admin is.
Nothing uniquely identifying is saved on the server, it doesn't even know the usernames of the clients after the lobby was initially set up.

If you need help, please join my Discord server or send me an E-Mail.
If your issue is with code, please open a GitHub issue.

This game is licensed under the MIT license. Click here to view the full license text.