README
¶
Summary
Ark-Overseer is a handmade application to observe as many Ark-Servers as you want to.
It is capable of tracking players via their Steam-Name. Since it's common case to use
the Steam-Name 123 it might not be the best application for official servers (a Steam-ID-implementation is planned for later releases).
You can simply add the servers you'd wish to track via the web-interface:
The messaging feature can be configured through the Settings-tab in the navigation-bar.
See more -> Messaging
The tracked players can be configured via their Steam-Name on the Blacklist-tab in the navigation bar:
Installation
via rpm
The Ark-Overseer is also available as an rpm-package, which makes it easy to install.
dnf copr enable led0nk/ark-clusterinfo
dnf install ark-overseer
ark-overseer
When installing the application via rpm, you will get a systemd service installed and enabled, which ensures to launch the application on system startup.
Therefore the directories for the database and blacklist are expected like the following:
| component | directory |
|---|---|
| database | /etc/ark-overseer/ |
| blacklist | /etc/ark-overseer/ |
| config | /etc/ark-overseer/ |
via Docker
The most simple way of installation is to just run the application in a container. E.g. with a container-service like Docker:
docker run -it \
-p 8080:8080 \
--rm ghcr.io/led0nk/ark-overseer:latest
Messaging
Setup for Discord-Bot
There are some steps to follow through for getting a working Discord-Bot.
1.) Create an app/bot
You should just follow the first step Creating an app in this guide here:
Discord-Bot
Make sure to write down the token of your bot.
2.) Permissions
Once you've added the Bot to your Discord-Server, you should configure it's permissions. It should at least be able to:
- view channels
- send messages
On top of that you have to verify that the notification-channel grants the
permissions to:
- view channel
- send messages
3.) Developer Options
Now you have to enable the developer options in discord, because you need to
get the channel-ID, where your bot will send notifications.
Therefore you go into the user-settings:
After enabling the dev-mode, you can now copy the channel-ID to set up the notifications.
Now you're able to fill in the Notification-Settings with the tokenand the channel-ID and run your discord-bot.
Contribution
If you're interested in improving the code quality or enhancing the features of the Ark-Overseer, you're very welcome to contribute to this repository.
To contribute, simply fork the repository, make your changes, submit a pull request and add some information on the changes. Your contributions will be reviewed as soon as it is possible.
Don't hesitate to open issues, when being confronted with the applications bugs.
Directories