Skip to content
RomoslayerARK plugins
TribeScore

Installation

Installing TribeScore across the maps in your cluster.

On this page4 sections

TribeScore is an AsaApi plugin. Install it on every map in the cluster that should contribute to the scoreboard, and point them all at the same database.

Before you start

  • A MySQL database the plugin can reach from every map. TribeScore uses its own tables, so it can share a MySQL server with other plugins.
  • A Discord webhook URL for the channel the board should post to.
  • Optional: ClusterSync for cluster-wide tribe names, and CustomDinoEvents for event creature points.

Steps

  1. Stop the server. The plugin file is locked while it is running.
  2. Place the plugin folder under your AsaApi plugins directory:
path
ShooterGame/Binaries/Win64/ArkApi/Plugins/TribeScore/
  1. In config.json, set the Database block, the leaderboard WebhookUrl, and a MapTag that is unique to this server.
  2. Start the server. Tables are created automatically on first run.
  3. Repeat on every other map, changing only the map tag. Keep the remaining settings identical.

Checking it worked

A few seconds after the map loads, the server log says whether the database connection worked. On failure it names the host, port, database and user it tried, so you can see which setting is wrong.

TribeScore will not start at all rather than run half-configured. The log names the problem when:

  • MysqlHost, MysqlUser or MysqlDB is empty.
  • PostLeaderboard is on but WebhookUrl is empty or does not start with https://. To record scores on a map without posting from it, set PostLeaderboard to false.
  • IntervalMinutes or TopCount is below 1.

Intervals must match across maps

Every map should use the same posting interval. If they differ, the map with the shortest interval posts every time.

Save configuration without a BOM

The config file must be plain UTF-8 with no byte order mark. Some editors and PowerShell's default encoding add one invisibly.

Treat the webhook as a credential

Anyone holding the webhook URL can post to that channel. Keep it out of anything you share when asking for support.

Updating

Stop the server, replace the plugin file, start it again. Configuration is read once at load, so config-only changes still need a restart before they do anything.