Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kiyotoko committed Jul 30, 2024
1 parent 9e78bcc commit 3e3fd74
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 23 deletions.
37 changes: 14 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<h1 align="center">Seekers Server</h1>

<p align="center">
<div align="center">
<h1>Seekers Server</h1>
<a href="https://jitpack.io/#seekers-dev/seekers-server">
<img alt="Jitpack" src="https://jitpack.io/v/seekers-dev/seekers-server.svg">
</a>
Expand All @@ -16,7 +15,7 @@
<img alt="GitHub License" src="https://img.shields.io/github/license/seekers-dev/seekers-java">
<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/seekers-dev/seekers-java">
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/seekers-dev/seekers-java">
</p>
</div>

In seekers, AIs compete against each other with the aim of scoring as many points as possible. This project is competition-oriented for students.

Expand All @@ -26,12 +25,7 @@ Please note that at least java 11 is required.

### Installation

Get a jar file from the release or build it on your own.

#### From release

There is currently no official release available, however you can check out [Jitpack](https://jitpack.io/#seekers-dev/seekers-server)
for snapshot builds.
Get a jar file from the latest release or build it on your own.

#### Build it on your own

Expand All @@ -58,22 +52,21 @@ If you start the server for the first time, the following file and folders will
|:------------:|---------------------------------------|
| `config.ini` | Config file for changing the settings |
| `players` | Bot files from the players |
| `plugins` | Loading plugin jar files |
| `drivers` | Store local drivers |
| `results` | Save tournament results |

Before the server starts, the app checks first if all listed paths exist. If a path does not exist, it will be created.
Then it will launch all plugins. It will create a tournament with a list of matches. In the tournament will every player
play a match against every other opponent. If the
play a match against every other opponent.

## Config

In the `config.ini`, you can set properties for the game and your plugins. Note that all plugins have their own section.
For example, the section of the python plugin is `[python-plugin]`. The name of the section is equivalent to the id of
the plugin. Please note that the config file of the seekers-py repo and this config file are interchangeable. If you
In the `config.ini`, you can set properties for the game and your drivers.
Please note that the config file of the seekers-py repo and this config file are interchangeable. If you
have already altered your config file for python, you can simply reuse it for the server.

Please note that the playtime is measured in game ticks. For a conversion between ticks and time, you can look at the
table below:
Please note that the `playtime` is measured in game ticks. For a conversion between ticks and time, you can look at the
table below for a `tick-duration` of $10.0$:

| Ticks | Time |
|:----------:|:-----:|
Expand All @@ -86,18 +79,16 @@ table below:
| 8640000 | 1d |
| 3155760000 | 1a |

The tick duration is measured in milliseconds. To calculate the duration of any match $t$ in minutes based on the tick duration $\Delta t$ and playtime $p$, you can use the following formula:

$$t=\frac{p \cdot \Delta t}{60\cdot1000}$$

## Players

The server will create a tournament with all AIs that are in the `players` folder. A file is marked as a valid player
if it starts with `ai`. Drop all files you want to run into this folder and start the server. Please note that an empty
folder will result into an empty tournament. If the tournament is empty, the server will be closed automatically.

## Plugins

The server will not host any clients on its own. If you want to do it automatically instead manually, you can add
plugins. Simply download the plugin jar from the release page of the publisher, move it to the plugins folder and add
the settings if required to the config.

## Results

All results will be saved in the ``results`` folder. This file contains a list of all matches that are still running and
Expand Down
7 changes: 7 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@
<maven.compiler.release>${project.javaVersion}</maven.compiler.release>
</properties>

<licenses>
<license>
<name>GNU General Public License</name>
<url>https://www.gnu.org/licenses/gpl-3.0.html</url>
</license>
</licenses>

<contributors>
<contributor>
<name>Karl Zschiebsch</name>
Expand Down

0 comments on commit 3e3fd74

Please sign in to comment.