ark-server-tools



ark-server-tools

= ARK: Survival Evolved Linux Server Tools

This tool allows you to manage any ARK: Survival Evolved linux server without having to remember long commands.

It provides a lot of features, to get the full list check the section.

Installation

Prerequisites

To install ARK Server Tools run this command:

[source,sh]

curl -sL http://git.io/vtf5N, sudo bash -s steam

NB: You may want to change the parameter to fit your steam user if different from .

This will copy the script and its daemon to the proper directories and will create an empty log directory in for ARK Server Tools.

To instead perform a user-install of ARK Server Tools as an unprivileged user, run this command:

[source,sh]

curl -sL http://git.io/vtf5N, bash -s -- --me

Configuration

To install ARK Server just run this command as normal user:

[source,sh]

arkmanager install

Usage

Global Options

[horizontal]

::

Exposes the output of SteamCMD

::

Prints dots for progress

::

Uses a spinner for progress

Instanceless commands

All of the following commands take arguments to specify

one or more instances, with the special instance selecting all

instances.

[horizontal]

::

Runs the server without putting it into the background

::

Runs the server and puts it into the background

::

Stops the server if it is running

::

Runs the command followed by the command.

Accepts and passes the options for those commands

::

Downloads and installs (or validates an existing install) of

the ARK server

::

Updates an install of the ARK server (or installs it if it's

not already installed)

::

Cancels a pending update / shutdown / restart that was run with

the option

::

Checks if an ARK server update is available

::

Checks if any mods need updating on the server

::

Installs all mods specified in the instance config into the

directory

::

Deletes all mods from the directory

::

Installs the specified mods into the

directory

::

Deletes the specified mods from the

directory

::

Deletes the specified mods from the SteamCMD workshop directory

::

Runs the command followed by the

command

::

::

Enables the setting in the instance config.

modtype defaults to .

Mod types:

::

Backs up the saved world and game config files to a compressed

tar file in the backups directory specified in the config

::

Broadcasts a message to players connected to the server using

the RCON command

::

Saves the world using the RCON command

::

Sends the specified RCON command to the server and prints its

response

::

Sends the specified message using the configured Discord

webhook

::

Prints the status of the ARK server

::

Installs a cron job that executes the specified command.

This accepts any of the options the specified command accepts,

as well as the following options. In order to specify an

argument to the command (e.g. to the command),

use the option.

Please read your manpage to determine what

minute and hour values are valid, as some implementations

may not accept e.g. the minute / hour specification.

::

Removes a cron job previously installed by

::

Waits until any or all instances are stopped or online

Defaults to any stopped

Configuration files

Global configuration

Instance config files are stored under

,

or as specified in the options in

the global config.

[horizontal]

::

The directory under which the ARK server is installed

::

The map the server should use

::

Uses the option to specify the server map

mod ID

::

Specifies the options to use in the option

string passed to the server

::

Specifies an option without a value -

::

Specifies a dash-option without a value (i.e. flag) - e.g.

adds the

flag

::

Specifies a dash-option with a value - e.g.

adds

the

option.

::

Specifies a mod that can be enabled or disabled using

and . Note that mod ids specified

using these options are in addition to those specified directly