Scribble.rs

This project is intended to be a clone of the web-based drawing game skribbl.io. In my opinion skribbl.io has several usability issues, which I'll try addressing in this project.

Even though there is an official instance at scribble.rs, you can still host your own instance.

The site will not display any ads or share any data with third parties.

Building / Running

Run the following to build the application:

git clone https://github.com/scribble-rs/scribble.rs.git
cd scribble.rs

For -nix systems:

# run `make` to see all availables commands
make build

For Windows:

go run github.com/gobuffalo/packr/v2/packr2
go build -o scribblers .

This will produce a portable binary called scribblers. The binary doesn't have any dependencies and should run on every system as long as it has the same architecture and OS family as the system it was compiled on.

The default port will be 8080. The parameter portHTTP allows changing the port though.

It should run on any system that go supports as a compilation target.

This application uses go modules, therefore you need to make sure that you have go version 1.13 or higher.

Docker

Alternatively there's a docker container:

docker pull biosmarcel/scribble.rs

Changing default port

Default port is set to 8080. To override it, run it as follow:

docker run -p <port-number>:<port-number> biosmarcel/scribble.rs --portHTTP=<port-number>

Contributing

There are many ways you can contribute:

• Update / Add documentation in the wiki of the GitHub repository
• Extend this README
• Create issues
• Solve issues by creating Pull Requests
• Tell your friends about the project
• Curating the word lists

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.

• Favicon - Fredy Sujono
• Rubber Icon - Made by Pixel Buddha from flaticon.com
• Fill Bucket Icon - Made by inipagistudio from flaticon.com
• Kicking Icon - Kicking Icon #309402
• Sound / No sound Icon - Made by Viktor Erikson (If you this is you or you know who this is, send me a link to that persons Homepage)
• Profile Icon - Made by kumakamu