Skip to content
SirShaw edited this page Sep 9, 2019 · 7 revisions

About the Project

WHAT IS ARK BOT?

This is an application developed by TseBring. He since left the project. We have taken the project over and are trying our best to maintain basic features to keep it working.

WHAT ARKBOT DOES:

ARK Bot is an application that monitors and extracts data from any number of configured local ARK servers and exposes this data through a Web App. It helps administrators manage servers using a Discord bot providing a handful of powerful commands.

WHAT IT USES:

Steam for authentication and ARK Savegame toolkit

HOW IT DOES IT

Arkbot reads the savegame files for data every 10 minutes and then looks for those data points. It saves it to a local cache for displaying on the web page. Arkbot uses the config.json at launch to set all the parameters of the application and has a built in web server to display the information. Many elements are hardcoded, unfortunately.

ARKBOT SAVEGAME TOOLKIT

This is an application developed by someone else modified by TseBring to be used for ArkBot.

WHAT ARKBOT SAVEGAME TOOLKIT DOES

This is what ArkBot utilizes to retrieve its data and acts as a bridge between the core game files of ARK: Survival Evolved and ArkBot. This is a library that has hardcoded map, player, creature, and structure data.

WHAT IT USES

Hard coded map filename parameters from the game ARK: Survival Evolved.

HOW IT DOES IT

When called by ARKBOT it goes and reads the savegame files and provides it back to ARKBOT. The detection routines for mapnames are hardcoded here.

WEB APP

This is the website that arkbot.exe generates.

WHAT THE WEB APP DOES

Displays a website that allows for user interaction within a gui of all the data arkbot pulls together.

HOW IT DOES IT

Utilizes RESTful API for accessing exported ARK Server save data via HTTP in JSON- or XML-format.

A SignalR hub push server update notifications to connected clients in real-time. Javascript is written in angular with webpack.

ARK: Survival Evolved - The Game

This game is built by Studio Wildcard.

WHAT HAPPENS EVERY 2-3 MONTHS

Studio Wildcard will release fixes as well as new DLC maps.

WHAT HAPPENS WITH ARKBOT AFTER UPDATES/DLC RELEASES

Now Arkbot can't read the new maps without some major updates to the SaveGame toolkit and to the ARKBOT app to try to get it to work with the new maps.

WHAT WE ARE LOOKING FOR

We're looking for developers to assist us in maintaining this project to correct this and other issues like this. We are willing to pay bounties for every feature developed. Contact us first prior to beginning work.

How to install?

Refer to the guide over at Getting Started.

What is the Discord Bot?

The Discord bot allows administrators to manage servers using commands in Discord. There are commands to start/stop/restart/update your servers and to issue commands over RCON.

For more information, see Discord Bot.

What is the Companion App (Web App)?

Players

The Companion App allows players to easily see what is going on in the ARK. Players can check on server status, statistics or who is online.

They can browse their creatures, check on food status, base levels, find a missing creature, see which ones are on mating cooldown or check the status of a baby creature.

Pending imprint can be tracked with countdowns and notifications. The status of generators, growing crops and entries in the tribe log are also easily browsable from within the companion app.

Administrators

Administrators have access to tribe and player lists with additional statistics. They can open an overview map of the ARK and see where players and tribes exist and what's built.

With additional extensions installed administrators can manage clean-up and destruction of structures and creatures in the ARK from within the administration interface.

For more information, see Companion App (Web App).