RollPlayer-backend

This is a Kotlin server for a multiplayer game, built using the Ktor framework. It handles communication between clients and manages game-related data. The server uses the H2 database for storing game data.

Getting Started

Before running the server, make sure you have Kotlin and Gradle installed. To build and run the project, follow these steps:

Clone the repository:

git clone <repository-url>
cd server-project-directory

Build the project:

gradle build

Run the server:

gradle run

The server will start running at http://localhost:9999 by default. You can change the port and other configurations in the application.conf file.

Configuration

You can configure project in src/main/resources/application.conf. Configure:

host/port
jwt authentication parameters (you can use environment variables)

ktor {
    deployment {
        port = 9999 # Change this port number to your desired port
        host = "0.0.0.0"
    }
}
jwt {
    secret = <String>
    issuer = <String>
    audience = <String>
    realm = <String>
}

Logging Configuration

Logging is configured in the server code. Logs are written to both the console and a log file named server.log. You can also configure logging in the file logback.xml.

Documentation

If (authorization) is written next to the request body, then access to this page is possible only with a token for the logged in user.

Add in request header for key "Authorization": "Bearer "

Map format

To store maps we use Tiled json map format. For each map we have a corresponding json (.tmj) file, it looks something like:

{
  "height":2,
  "layers":[
    {
      "data":[1, 2, 0,
        10, 5, 11],
      "height":2,
      "width":3,
      "properties": [
        {
          "name":"Obstacle",
          "type":"bool",
          "value":false
        },
        {
          "name":"Pass cost",
          "type":"int",
          "value":2
        }]
    },
    {
      "data":[0, 0, 3,
        0, 0, 0],
      "height":2,
      "width":3,
      "properties": [
        {
          "name":"Obstacle",
          "type":"bool",
          "value":true
        }]
    }],
  "renderorder":"right-down",
  "orientation":"orthogonal",
  "tilesets":[
    {
      "firstgid":1,
      "source":"tmp.tsj"
    },
    {
      "firstgid":2,
      "source":"tmp2.tsj"
    },
    {
      "firstgid":11,
      "source":"tmp3.tsj"
    }
  ],
  "width":3
}

The map itself is stored in "data" field. If the value is 0 then this tile is empty otherwise we must find the corresponding tileset.

"firstgid" field shows the first id corresponding to this tileset, "source" field shows which file contains information about needed texture.

.tsj file looks something like:

{
 "image":"/path/to/image.png",
 "imageheight":96,
 "imagewidth":96,
 "tilecount":9,
 "tileheight":32,
 "tilewidth":32
}

If we have only one tile in this tileset then we can render file stored in "image" field as a texture, otherwise we need to get the corresponding tile from the file. In that case the picture from specified file is divided into tiles with specified height and width and tiles' ids ascending from left to right, from top to bottom starting with "firstgid" and needed tile is selected.

spbu-math-cs/RollPlayer-backend