Skip to content

Latest commit

 

History

History
191 lines (138 loc) · 8.03 KB

README.md

File metadata and controls

191 lines (138 loc) · 8.03 KB
Raw

Scribble.rs

demo

Scribble.rs is a free and privacy respecting pictionary game. There's no advertisements and you don't need an account to play.

It is an alternative to the web-based drawing game skribbl.io.

Play now

There are some community hosted versions of the game (feel free to host your own instance and add it here!):

  • scribblers.fly.dev (Official instance, Note that the instance may not respond instantly, as it automatically shuts down if no traffic is received.)
  • scribble.bixilon.de (community instance maintained by @Bixilon)
  • scribble.drifty.win (community instance maintained by @driftywinds for better latency in Asia)

Join The Discord

Feel free to join the community Discord server to find people to play, talk, get help or whatever else: https://discord.gg/cE5BKP2UnE

Donation

I haven't really accepted donations for a long time. But I think the project is polished enough now to dare taking some money. Right now the hosting is very minimal and there's no domain. The server is located in amsterdam and many people playing seem to be from outside of europe. So it'd be nice to have a decentralised deployment to provide a nice experience for everyone.

So donations would go towards infrastructure and a domain!

In the future I might add some fun little benefits for donators, I have no clear vision of it yet though.

You can donate via Ko-Fi: https://ko-fi.com/biosmarcel

Configuration

Configuration is read from environment variables or a .env file located in the working directory.

Available settings:

Key Description Default Required
PORT HTTP port that the server listens to. 8080 True
NETWORK_ADDRESS TCP address that the server listens to. False
ROOT_PATH Changes the path (after your domain) that the server listens to. False
CORS_ALLOWED_ORIGINS * False
CORS_ALLOW_CREDENTIALS False
LOBBY_CLEANUP_INTERVAL 90s False
LOBBY_CLEANUP_PLAYER_INACTIVITY_THRESHOLD 75s False

For more up-to-date configuration, read the config.go file.

Docker

It is recommended that you run the server via Docker, as this will rule out almost all compatibility issues.

Starting from v0.8.5, docker images are only built on tagged pushes. Each git tag becomes a docker tag, however latest will always point to the latest version released via GitHub.

Linux Docker

Download the image:

docker pull biosmarcel/scribble.rs:latest

Windows Docker

Only use this one if you want to run a native Windows container. Otherwise use the Linux variant, as that's the default mode on Windows:

docker pull biosmarcel/scribble.rs:windows-latest

Running the Docker container

Run the following, replacing <port> with the port you want the container to be reachable from outside:

docker run --pull always --env PORT=8080 -p <port>:8080 biosmarcel/scribble.rs:latest

For example:

docker run --pull always --env PORT=8080 -p 80:8080 biosmarcel/scribble.rs:latest

Note that you can change 8080 too, but it is the internal port of the container and you shouldn't have to change it under normal circumstances.

Building / Running

Dependencies:

  • go version 1.23.3 or later
  • git (You can also download a .zip from Github)

In order to download and build, open a terminal and execute:

git clone https://github.com/scribble-rs/scribble.rs.git
cd scribble.rs
go build ./cmd/scribblers

This will produce a portable binary called scribblers or scribblers.exe if you are on Windows.

Pre-compiled binaries

In the Releases section you can find the latest stable release.

Alternatively each commit uploads artifacts which will be available for a certain time.

Note that these binaries might not necessarily be compatible with your system. In this case, please use Docker or compile them yourself.

nginx

Since Scribble.rs uses WebSockets, when running it behind an nginx reverse proxy, you have to configure nginx to support that. You will find an example configuration on the related Wiki page.

Other reverse proxies may require similar configuration. If you are using a well known reverse proxy, you are free to contribute a configuration to the wiki.

Contributing

There are many ways you can contribute:

  • Update / Add documentation in the wiki of the GitHub repository
  • Extend this README
  • Create feature requests and bug reports
  • Solve issues by creating Pull Requests
  • Tell your friends about the project

Credits

These resources are by people unrelated to the project, whilst not every of these resources requires attribution as per license, we'll do it either way ;)

If you happen to find a mistake here, please make a PR. If you are one of the authors and feel like we've wronged you, please reach out.

Some of these were slightly altered if the license allowed it. Treat each of the files in this repository with the same license terms as the original file.