gamelog

Running this service

Prerequisites

To run this service and its dependencies, the following things need to be installed:

Docker and Docker Compose (for the Kafka and MariaDB containers required for development)
Java in version 17 or newer
Maven (manages the dependencies, building and execution of the Java project)

Starting the service

First, start the Kafka and MariaDB Docker containers via Terminal (run this in the base directory of the project):

docker-compose -f src/main/docker/docker-compose.kafka.yml up -d
docker-compose -f src/main/docker/docker-compose.mariadb.yml up -d

This will download the required images (if they aren't found locally) and start the containers in detached mode.

As soon as both containers are running, you can start the Java application via Terminal (run this in the base directory of the project):

mvn spring-boot:run

This will compile the project and start the application.

Grafana / Prometheus

We configured a Grafana Dashboard for displaying game-related metrics and some score values. The necessary configuration files are found in this repo as well (Prometheus, Grafana).

Documentation

Decision Log

An overview of our decisions can be found here on the Microservice Dungeon Decision Log.

API Documentation

Our API Documentation can be found here(REST API) and here(Event Specification).

Wiki

Further documentation can be found on the wiki, including Problems and Conclusions for further Development, the Scoreboard Mechanics, the Concept of the Service and the list of Trophies and Achievements.

Features

This microservice provides scoreboards and trophies for the players of the Microservice Dungeon.

Scoreboard

The service provides a scoreboard for the total scores of the players. Whoever ranks no. 1 on this board can be considered the winner of the game.

The service also provides categorized scoreboards in 4 categories to enable competing in different aspects of the game. Those categories are:

Fighting
Mining
Robot Stats
Trading
Traveling

The scoreboard is reachable under the /scorebard endpoint as defined in the API Spec. However, if you call it from the browser it will render a static view of the scoreboard.

Scoreboard View

Grafana Dashboard

We developed a Grafana Dashboard to provide various metrics including scores to the participants of the codefight/hackathon.

Grafana Dashboard

Achievements and Trophies

The service provides achievements and trophies.
Achievements are awarded for the individual progress of the player in activities of the game.
Trophies are awarded to the players that rank 1st, 2nd and 3rd on any of the scoreboards.