/scribble.rs

A clone of skribbl.io - No more automatic restarts every X hours, play away!

Primary LanguageGoBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

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
go run github.com/markbates/pkger/cmd/pkger -include /resources -include /templates
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

It uses port 80.

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