inaka / serpents

Multi-Player Game on top of HDP protocol

Serpents

Multi-Player Game on top of HDP protocol or REST+SSE

Introduction

Serpents is the classic snakes game where each player controls a serpent that moves around a board. When the serpent eats a fruit it grows according to how much food the fruit provides. If the serpent hits anything but a fruit (being that a wall, another serpent or even its own body) the serpent dies.

The Server

This repo provides the game server. Players should write their clients on their own (and that is part of the game). To do that they can use one of two protocols:

• HTTP: A RESTful API with an additional SSE endpoint for updates
• HDP: An UDP based protocol

To start the server, run

$ rebar3 compile && rebar3 shell

Or you can generate a release with rebar3 release and then start it

$ ./_build/default/rel/serpents/bin/serpents start

The Website

Once the server is started you can open http://localhost:8585 and start creating and watching games.

Player Examples

If you don't know where to start in order to write your serpents client, you can check the sample clients provided in the src/clients folder. There are 2 clients there:

• ai: An collection of automatic clients that connect to a game and automatically move the serpents according to their algorithms
• wx: An interactive client built on top of wx

---

Contact Us

If you find any bugs or have a problem while using this project, please open an issue in this repo (or a pull request :)).

And you can check all of our open-source projects at inaka.github.io

serpents's Issues

Add a name to the game

Out of Order Updates

Server needs to ignore out of order client updates. It's currently crashing.

HDP Client Example

A sample HDP client, maybe not written in Erlang.

Unique SerpentIds

Make sure that serpent numeric_ids always include the game numeric_id

Avoid walls on Greedy AI

Once #70 is done, add walls into greedy's avoid_collision function

Fruits may extend the serpent by more than one cell

• Add that to the game options

make the repo public

…and add an issue to fulfil the open-source checklist

HDP Client Documentation

Remove cowboy_swagger hack

Improve spts_core:fetch_game

Now when you use a numeric id there it traverses the whole list of games to find the right one.

Evaluate the need of serpents_games_repo

...if games are not stored in mnesia.

Randomly appearing walls

After #18

Website

A static HTML file that, given the game provided in the url will connect to GET /game/:game_id/news and listen for SSE messages using EventSource and render the corresponding changes on screen.
It should only work on localhost and you get to choose your favourite browser.

@todos

Allow changes in ticktime through API

during the game

Fulfil the open-source checklist

General Items

• It has a github repo
• It has a proper Apache2 LICENSE file
• It's has a clear and useful README.md
• It's documented (with examples)
• It's tested
• It's hooked to a the open-source hipchat room
• It has a link to the open-source hipchat room in its README
• It has a link to inaka.github.io in its README and/or landing page

Exhibition

• There is a blog post about it
• It's shared on social networks
• It's shared on reddit
• It's shared on hacker news with a title like Show HN: description
• It has a landing page built in github pages

For Erlang Projects

• It's checked with Gadget
• It's shared on Erlang Central

Move from Erlang.mk to rebar3

Migrate to rebar3 as described here.

This is requested by esl/TODO#62

Bump Version to 0.1.0

Improve Game Info on HDP

• Add game state
• Swap MaxPlayers and CurrentPlayers
• Verify that all static info is returned
• Move the binary construction to spts_games:to_binary

Accept serpent turns before the game starts

That's to change the initial direction of the serpent.

HDP Client

• Define the HDP protocol and then implement
• Supervisors and workers to talk HDP protocol with clients and then communicate with the server
  • calling the functions defined on #2
  • listening for the events defined on #17

HDP Connection Timeout

If clients fall behind a certain (configurable) number of ticktimes from the server… it should be considered disconnected and it should no longer receive events until it sends its next client update