Repository files navigation

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

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

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

• scribblers.bios-marcel.link (Official instance, Notethat the instance may not respond instantly, as it automatically shuts downif 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)

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

I haven't really accepted donations for a long time. But I think the project ispolished enough now to dare taking some money. Right now the hosting is veryminimal and there's no domain. The server is located in amsterdam and manypeople playing seem to be from outside of europe. So it'd be nice to have adecentralised 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 clearvision of it yet though.

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

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

Available settings:

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

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

Starting from v0.8.5, docker images are only built on tagged pushes. Each gittag becomes a docker tag, howeverlatest will always point to the latestversion released via GitHub.

Download the image:

docker pull biosmarcel/scribble.rs:latest

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

docker pull biosmarcel/scribble.rs:windows-latest

Run the following, replacing<port> with the port you want the container to bereachable 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 change8080 too, but it is the internal port of thecontainer and you shouldn't have to change it under normal circumstances.

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.gitcd scribble.rsgo build ./cmd/scribblers

This will produce a portable binary calledscribblers orscribblers.exe ifyou are on Windows.

In theReleases sectionyou can find the latest stable release.

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

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

Since Scribble.rs uses WebSockets, when running it behind an nginx reverseproxy, you have to configure nginx to support that. You will find an exampleconfiguration on therelated Wiki page.

Other reverse proxies may require similar configuration. If you are using awell known reverse proxy, you are free to contribute a configuration to thewiki.

While there's a Prometheus metrics endpoint at/v1/metrics, it currentlydoesn't expose a lot of information. If there are any requests for certain data,I'd be willing to extend it, as long as it doesn't expose any personal data.

While I do have a dashboard for it, my hoster (fly.io) sadly doesn't supportpublic dashboards right now, so the data will remain closed for now.

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

These resources are by people unrelated to the project, whilst not every ofthese 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 theauthors 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 theoriginal file.

• Logo - All rights reserved, excluded from BSD-3 licensing
• Background - All rights reserved, excluded from BSD-3 licensing
• Favicon - All rights reserved, excluded from BSD-3 licensing
• Rubber Icon - Made byPixel Buddha fromflaticon.com
• Fill Bucket Icon - Made byinipagistudio fromflaticon.com
• Kicking Icon -Kicking Icon #309402
• Sound / No sound Icon - Made by Viktor Erikson (If this is you or you know who this is, send me a link to that persons Homepage)
• Profile Icon - Made bykumakamu
• Help Icon - Made by Ionicons
• Fullscreen Icon - Made by Github
• Pencil Icon
• Drawing Tablet Pen Icon
• Checkmark Icon
• Fill Icon
• Trash Icon - Made byYannick Lung
• Undo Icon - Made byIvan Boyko
• Alarmclock Icon - Made byKit of Parts
• https://www.iconfinder.com/icons/808399/load_turn_turnaround_icon TODO