R-type

The purpose of this project is to create a one to four players game, based on a client / server architecture and an ECS game engine.

Dependencies

The only dependencies are sfml-graphics and sfml-audio. Optionally, to run the test suite, you'll need google-test.

All other abstractions and libraries has been written from scratch (e.g. the network, game engine, state machine, logger, protocol, etc..)

Compilation, test and play (for Linux/Windows)

Compilation

The compilation has been tested with:

cmake v3.6 (for linux & windows)
gcc v6+ (for linux)
msvc v14 (for windows)

$ mkdir build; cd build
$ cmake ..
$ make
$ make install

make install will only move the built files in the bin in the repo folder.

Tests

You can run the test suite by running make tests

Play

You will find in the bin folder:

the server binary
the client binary

To run the game, start the server, then the client. The client will generate a configuration file on first run, you will need to stop the client, configure the server host/port in the configuration.json file, then re-run the client. Enjoy!

Client-Server

Once the server is started, one or more clients can connect and join a room. Up to 4 players can play in a room, and the number of room is only limited by the capacities of the computer on which the server is running.

See the RFC for informations on the protocol used between the client and the server.

ECS Game engine

The game engine has an ECS architecture (Entity Component System), which allow great flexibility and ease of use.

More informations here.

bew/r-type.tek