search

Bronkoknorb / type-draw-type-game

Type Draw Type Game
GNU Affero General Public License v3.0
4 stars 1 forks source link

readme

Type Draw Type Game

Build & Publish Docker images

Type Draw Type Logo

Type Draw Type is a simple and fun game for you and your friends. It is like the telephone game (Chinese whispers), only with pictures. Every player starts by typing a sentence. Then the texts are passed on and you have to draw the sentence you received. In the next round you get one of the drawings and have to describe it with another sentence (without knowing the initial sentence!). This goes on, by alternately typing and drawing, until all players have participated in every chain (story). In the end everybody sees all the stories and can wonder about how the initial sentences have transformed in unexpected ways!

Play online at: https://draw.czedik.at

This is an open-source Web/mobile version of the pen-and-paper game Telephone Pictionary (also known as Paper Telephone and "Eat Poop You Cat"). It can be installed on mobile phones (Android and iPhone) by using the "Add to Home Screen" functionality.

Alternative versions of the game are: Drawception, Interference, Doodle Or Die, Broken Picturephone, Drawphone, Gartic Phone, Telestrations, Cranium Scribblish, Stille Post extrem, Scrawl (offline Board games).

Installation on own server

Prerequisites:

Pull the newest image from Docker Hub and tag it with a simpler name:

docker pull bronkoknorb/type-draw-type-game && \
docker tag bronkoknorb/type-draw-type-game tdt-game

To run the Docker image (forwarding the internal port 8080 to the external port 8081):

docker run -p 8081:8080 --volume ~/tdt-data:/tdt-data tdt-game

Note that ~/tdt-data is a directory on the host where game data will be stored.

You can then open the game on http://localhost:8081/

To run the Docker image (in the background) and do automatic restarts (e.g. when the machine gets rebooted or the application crashed):

docker stop tdt
docker rm tdt
docker run -d --restart always --name tdt -p 8081:8080 --volume ~/tdt-data:/tdt-data tdt-game

To check the logs of the running Docker container:

docker logs tdt

Development

Backend Server

The Backend is developed using Spring Boot in Java and built with Gradle.

Prerequisites:

Run the server in development mode:

cd tdt-server
./gradlew bootRun

To get live-reloads on changes, run in a second terminal:

./gradlew build --continuous

See also tdt-server/HELP.md.

Frontend Web App

The Frontend is a React App written in Typescript and built with yarn.

Prerequisites:

Run the frontend in development mode:

cd tdt-webapp
yarn
yarn run dev

This will also automatically start a proxy server which forwards API requests to the backend (running on port 8080).

See also README-webapp.md.

Build

To build the app using Docker:

./build-prod.sh

Multi-Architecture Build

I want to build ARM Docker images to run on my Raspberry Pi:

This repository contains a Github Action Workflow which builds the multi-arch images and pushes them to a Docker registry, see docker-image.yml.

To achieve the same locally follow the instructions at: https://docs.docker.com/build/building/multi-platform/

Then run this to build and push multi-architecture images:

./build-prod-multi-arch-push.sh

Note: This will also try to push the built images to Docker Hub. You need to login first (docker login).

Author

Copyright by Hermann Czedik-Eysenberg
git-dev@hermann.czedik.net

License: GNU AFFERO GENERAL PUBLIC LICENSE