Git Product home page Git Product logo

apievolved's Introduction

APIEvolved

Made for managing/querying your ARK: Survival Evolved server running on Windows.

  • Tribe Data (working)
  • Player Data (working)
  • Server Query Data (working)
  • RCON Support (working)
  • Scheduled restarts (working)
  • Automated Updates (working)
  • Automated Backups and compression (work in progress)

Disclaimer

The API is currently in alpha, advertised features may be missing. This repository is heavily revised every day, make sure to git pull every once in a while.

Issues

Please post any issues you encounter along with your api.log file

Version

0.1.0

Tech

APIEvolved uses a number of open source projects to work properly:

  • Express - serving the API calls
  • ArkData - Parsing Tribe / Player data.
  • edge - interface C# with ArkData.
  • GameDig - doing parts of the Queries.
  • cron - Scheduled jobs
  • ini - reading the Game Configuration files
  • simple-rcon - rcon protocol (skibz/prestonp fork)
  • portscanner - used to check rcon protocol port.
  • moment - for dates
  • socket.io - real-time chat log
  • request - used to call ARK.Bar API
  • winston - logging

And of course APIEvolved itself is open source with a public repository on GitHub.

Installation

Download latest zip from git

Extract wherever you want

Copy example.config.json to config.json

  • Set the correct Win64 path
  • Set the path where you would like backups to reside.
  • Optionally change the API Port
  • Optionally set the secret for restarting / updating / rcon requests. (One will be generated if not, and will be displayed in console on first run)
  • Optionally set the Params you want the server to run with

Run start.bat

Configuring

Scheduled Jobs Available actions: Restart, Broadcast.

Cron Expression The expression is in this format:

seconds, minutes, hours, days, months, weekday

So if you want to run a broadcast every 15 minutes: 0 */15 * * *

License

MIT Free Software, Hell Yeah!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.