Skip to content

Latest commit

 

History

History
137 lines (99 loc) · 4.73 KB

README.md

File metadata and controls

137 lines (99 loc) · 4.73 KB
Raw

Scribble.rs

Scribble.rs is an alternative to the web-based drawing game skribbl.io. My main problems with skribbl.io were the ads and the fact that a disconnect would cause you to lose your points. On top of that, the automatic word choice was quite annoying and caused some frustration.

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

Play now

Feel free to play on this instance

Hosting your own instance for free

By using Heroku, you can deploy a temporary container that runs scribble.rs. The container will not have any cost and automatically suspend as soon as it stops receiving traffic for a while.

Simply create an account at https://id.heroku.com/login and then click this link:

https://heroku.com/deploy?template=https://github.com/scribble-rs/scribble.rs/tree/master

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 available commands
make build

For Windows:

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.16 or higher.

Docker

Alternatively there's a docker container:

docker pull biosmarcel/scribble.rs

The docker container is built from the master branch on every push, so it should always be up-to-date.

Changing default port

The default port is 8080. To override it, run:

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

Discord

While you can find a link to a discord server at the top, for personally reasons you won't find me on that server anymore, however, you can still reach me via E-Mail or even the issue section.

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

Donating

If you can't or don't want to contribute in any of the ways listed above, you can always donate something to the project.

If there's a steady income stream I'd spend it on infrastructure and a domain ;)

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.