ilarikuoppala / onlinesnake

Let's have some online snake fun!

OnlineSnake.fun

OnlineSnake.fun is a small fun multiplayer browser game.

Background

This project was started when I was volunteering at the Junction 2018. I wanted to try out real-time web programming with websockets and decided to make a simple game. This is the result.

Development setup

Docker container

In project repository, run docker-compose up. After the container is ready, navigate to localhost:8080 using your web browser. If you make changes to web files (client), refresh the web page to see the effect. If you change server files (python), rebuild (docker-compose build) and restart the docker container to see changes.

Without Docker

In project repository execute following commands (for Windows setup or additional information about using venv, see https://docs.python.org/3/library/venv.html):

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python3 snake.py

You should now have the websocket backend running. Next, use your text editor to change the websocket port from web/game.js: change line var wsurl = "ws://localhost:8080/websocket/"; to var wsurl = "ws://localhost:8765/websocket/";. Make sure not to commit this port change accidentally! Now open the index.html page with your browser, no setup for web server needed. Similarly to development with docker, refresh the index.html web page when making changes to web files, and restart the snake.py server (use ctrl-c to kill current process) if you change server-side files.

onlinesnake's Issues

Treat shouldn't appear inside any snake

Currently there is no verification when deciding the place of a new treat.

Add support for high-DPI displays

Add theme support

Nice to have:
Ability to change between different themes, e. g. dark mode.

Possibility to change own player name

The player's own name could be a text box that can be edited

Make snake head color a bit darker than it's body

Add different snake colors

This would make it easier to differentiate between multiple players

Closing websockets cause error flood in server stdout

Example output:

Traceback (most recent call last):
  File "snake.py", line 14, in receive
    async for message in websocket:
  File "/Users/felix/Documents/onlinesnake/env/lib/python3.7/site-packages/websockets/protocol.py", line 414, in __aiter__
    yield await self.recv()
  File "/Users/felix/Documents/onlinesnake/env/lib/python3.7/site-packages/websockets/protocol.py", line 484, in recv
    await self.ensure_open()
  File "/Users/felix/Documents/onlinesnake/env/lib/python3.7/site-packages/websockets/protocol.py", line 771, in ensure_open
    raise self.connection_closed_exc()
websockets.exceptions.ConnectionClosedError: code = 1006 (connection closed abnormally [internal]), no reason```

Add favicon

Add style and contribution guidelines

Currently the repository does not contain any guidelines for code style or the goals of the project. These should be added to make life easier for contributors.

Does not work on mobile

😞

Display error in client when server is down

Add license to project

Add build/run instructions to README

Add score if someone hit's your snake

When A hits B and dies, B gets as many points as long A was