Tags:

Other

Author:

KenigVovan

Side:

Server

Created:

Apr 5th at 6:25 PM

Last modified:

Jul 31st at 5:24 AM

Downloads:

291

Latest release (for Vintage Story 1.22.3, potentially outdated):
canvsserverlist_1.1.7.zip  1-click install

Connects your server to vsserverlist.com - keeps your listing alive with automatic heartbeats and rewards players who vote for your server. Rewards are queued persistently and survive server restarts; each vote ID is tracked so a reward is never given twice even if the API acknowledgment fails.

Features

Setup

1. Install the mod and start the server once — a default config file canvsserverlist.json will be created.
2. Register your server on vsserverlist.com and get your Server UUID and API Key.
3. Edit canvsserverlist.json:

{
  "ServerUuid": "your-server-uuid",
  "ApiKey":     "your-api-key",
  "ApiUrl":     "https://vsserverlist.com",
  "HeartbeatIntervalSeconds":  600,
  "VotePollIntervalSeconds":   60,
  "WhitelistPollIntervalSeconds": 60,
  "Rewards": [
    {
      "ItemCode":   "game:gear-rusty",
      "Quantity":   1,
      "Attributes": null,
      "Class":      null
    }
  ]
}

4. Restart the server or run /vslist reload.

Configuration

Config fields

• ServerUuid - your server's UUID from vsserverlist.com
• ApiKey - your API key from vsserverlist.com
• ApiUrl - API endpoint, default https://vsserverlist.com
• HeartbeatIntervalSeconds - how often player count is sent to the listing, default 600
• VotePollIntervalSeconds - how often the mod checks for new votes, default 60
• WhitelistPollIntervalSeconds - how often the mod checks for approved whitelist applications, default 60. Only does anything when auto-whitelist is enabled on your server page
• Rewards - list of items given for each vote

Reward item fields

• ItemCode -— item or block code, e.g. game:gear-rusty, game:bread-rice
• Quantity - how many to give
• Attributes - base64-encoded item attributes (durability, enchantments, etc.). Set automatically via /addvotereward — do not edit by hand
• Class - character class filter. Only players of this class receive the reward. null = everyone

Commands

Player commands

• /voteclaim — claim pending vote rewards; items drop at your feet if inventory is full

Admin commands

• /vslist status — show UUID, heartbeat/poll intervals, configured rewards, and pending offline reward count
• /vslist reload — reload config from disk without restarting; prints a summary of what changed
• /vslist testreward <player> — give a test reward to an online player to verify your reward config
• /addvotereward <quantity> — hold an item and run this command to add it as a vote reward; preserves all item attributes
• /clearvoterewards — remove all configured rewards and save

How It Works

• Heartbeat - every 10 minutes the mod sends the current player count and online names to vsserverlist.com so your listing stays accurate. On repeated failures the interval is automatically doubled (up to 10 minutes) and resets when the connection returns.
• Vote polling -every minute the mod checks for new votes. Each vote ID is stored persistently: if the acknowledgment fails and the backend returns the same vote on the next poll, the reward is not queued a second time.
• Reward claiming - players type /voteclaim to receive their items. Each vote gives the full configured reward set. If the inventory is full, items are dropped at the player's feet.
• Offline rewards - votes are queued immediately to the world save file. A player who votes while offline is notified on login and their rewards are waiting, even after a server restart.
• Auto whitelist - when you enable auto-whitelist on your server page, players can apply to join from vsserverlist.com. Once you approve an application, the mod picks it up on its next poll and adds the player to the in-game whitelist (the same path as /whitelist add). Each approval is applied only once; if adding fails it stays pending and is retried next cycle, and it never runs unless you turn the feature on.