johannesmerkt/rust-scribble

Rust Scribble Game README

A client/server scribble game written in Rust.

Features

• Draw in multiple colours, sizes and erase mistakes easily
• Chat between users and correctly guessed words are not shown
• Concurrent lobbies/games on a single server
• Configurable port and word list
• Network connection is end-to-end encrypted by default

---

Starting a Server

To Run the server, enter the server directory and use cargo run to start.

cargo run

Configuration parameters

The server can be configured on the command line. They can be used individually or in any combination

The options available are

• --port : Port number
• --words: Word list file

To use the command line configuration simply use

cargo run -- --port 4001 --words filepath/filename.txt

Servers can also be configured to run without end-to-end encryption, using the conditional compilation feature

cargo run --features no-encryption

Note that all clients connecting will also need to be compiled with this features in order to communicate properly

---

Running a Client

Open new terminal and change directory to client. Then run

cargo run 

To create a client without end-to-end encryption, use the same command as the server.

cargo run --features no-encryption