Skip to content
NordBots.
Back to Polls

Polls configuration

The Polls config.json controls how the plugin runs on your Ark Survival Ascended server. Every setting is listed below with what it does and its default value.

Open the configuration editorPrefer clicking to typing? Build the file with sliders and toggles.

Where it lives

Drop the file on your server at ArkApi/Plugins/Polls/config.json then reload the plugin or restart the server. Keep a backup before large changes.

Every setting

General

Debug
togglefalse
Debug: true prints extra poll lines to ArkApi.log. Keep it false unless you are chasing a bug.

Commands

Commands: the words players type. /poll show the current poll and your vote /poll start Q | A | B start a poll (staff, or a paying player if you allow it below) /poll end close the poll now (staff) /poll last show the last finished poll /vote <number> cast or change your vote

PollCMD
text"/poll"
VoteCMD
text"/vote"

Polls

Polls: the rules.

StaffPermission
text"Polls.Manage"
StaffPermission: the Permissions node a player needs to start or end a poll. Needs Permissions.dll. From the server console or RCON you can always end a poll.
AutoEndMinutes
number10
AutoEndMinutes: how long a poll runs before it closes on its own, in minutes. 10 is a good length. Set to 0 to make a poll run until staff close it by hand.
ShowLiveCounts
togglefalse
ShowLiveCounts: set to false to hide the running counts while a poll is open, so early votes do not sway the rest. Players still see how many have voted, just not for what. Set to true to show live bars to everyone.
MaxChoices
number9
MaxChoices: the most choices a poll can have. Keep it at 9 or less so every choice has a single digit number to vote for.
WarnBeforeMinutes
list[1]
WarnBeforeMinutes: a list of minute marks to remind the server before a poll closes. [1] warns one minute before. Set to [] for no reminders. Only used when AutoEndMinutes is set.
PlayerStartCost
number0
PlayerStartCost: set above 0 to let any player start a poll by paying this many ArkShop points. 0 means only staff can start a poll. Needs ArkShop.dll to charge.
HistoryKept
number10
HistoryKept: how many finished polls to keep on file for /poll last. 10 is plenty.

Permissions

Permissions: gates who can start and end polls. Needs Permissions.dll.

Enabled
toggletrue
Enabled: set to true to check Permissions. If off or missing, no player passes the staff check, so run start and end from the console or use PlayerStartCost.

ArkShop

ArkShop: only used if PlayerStartCost is above 0. Needs ArkShop.dll.

Enabled
toggletrue
Enabled: set to true to charge for player started polls.

Discord

Discord: posts the question at start and the result at end.

Enabled
togglefalse
Enabled: true posts polls to Discord too. False keeps them in game only.
WebhookURL
textempty
WebhookURL: drop the webhook link for your poll channel here.
Username
text"Polls"
Username: the poster name Discord shows on each poll.
ServerName
text"My ARK Server"
ServerName: shown in the footer of poll posts. Set your server name.

The full commented config

This is a reading copy with notes. It is not valid JSON, so do not load it. Use the editor or the plain config.json instead.

{
  // Polls config guide. Notes below cover each key.
  // The notes break JSON, so the server can not read this file. Put your changes in config.json.

  "General": {
    // Debug: true prints extra poll lines to ArkApi.log. Keep it false unless you are chasing a bug.
    "Debug": false
  },

  // Commands: the words players type.
  //   /poll                     show the current poll and your vote
  //   /poll start Q | A | B     start a poll (staff, or a paying player if you allow it below)
  //   /poll end                 close the poll now (staff)
  //   /poll last                show the last finished poll
  //   /vote <number>            cast or change your vote
  "Commands": {
    "PollCMD": "/poll",
    "VoteCMD": "/vote"
  },

  // Polls: the rules.
  "Polls": {
    // StaffPermission: the Permissions node a player needs to start or end a poll. Needs
    // Permissions.dll. From the server console or RCON you can always end a poll.
    "StaffPermission": "Polls.Manage",

    // AutoEndMinutes: how long a poll runs before it closes on its own, in minutes. 10 is a good
    // length. Set to 0 to make a poll run until staff close it by hand.
    "AutoEndMinutes": 10,

    // ShowLiveCounts: set to false to hide the running counts while a poll is open, so early votes
    // do not sway the rest. Players still see how many have voted, just not for what. Set to true
    // to show live bars to everyone.
    "ShowLiveCounts": false,

    // MaxChoices: the most choices a poll can have. Keep it at 9 or less so every choice has a
    // single digit number to vote for.
    "MaxChoices": 9,

    // WarnBeforeMinutes: a list of minute marks to remind the server before a poll closes. [1]
    // warns one minute before. Set to [] for no reminders. Only used when AutoEndMinutes is set.
    "WarnBeforeMinutes": [1],

    // PlayerStartCost: set above 0 to let any player start a poll by paying this many ArkShop
    // points. 0 means only staff can start a poll. Needs ArkShop.dll to charge.
    "PlayerStartCost": 0,

    // HistoryKept: how many finished polls to keep on file for /poll last. 10 is plenty.
    "HistoryKept": 10
  },

  // Permissions: gates who can start and end polls. Needs Permissions.dll.
  "Permissions": {
    // Enabled: set to true to check Permissions. If off or missing, no player passes the staff
    // check, so run start and end from the console or use PlayerStartCost.
    "Enabled": true
  },

  // ArkShop: only used if PlayerStartCost is above 0. Needs ArkShop.dll.
  "ArkShop": {
    // Enabled: set to true to charge for player started polls.
    "Enabled": true
  },

  // Discord: posts the question at start and the result at end.
  "Discord": {
    // Enabled: true posts polls to Discord too. False keeps them in game only.
    "Enabled": false,

    // WebhookURL: drop the webhook link for your poll channel here.
    "WebhookURL": "",

    // Username: the poster name Discord shows on each poll.
    "Username": "Polls",

    // ServerName: shown in the footer of poll posts. Set your server name.
    "ServerName": "My ARK Server"
  }
}