Skip to content
NordBots.
Back to MiniLottery

MiniLottery configuration

The MiniLottery 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/MiniLottery/config.json then reload the plugin or restart the server. Keep a backup before large changes.

Every setting

General

Debug
togglefalse
Debug: set to true to write extra lines to ArkApi.log. Leave it false for normal play.

Commands

Commands: the word players type. It has sub actions: /lottery show the pot, your tickets, odds, time to draw, and recent winners /lottery buy <n> buy n tickets /lottery verify show the last draw's seed and hash so you can check it was fair

BuyCMD
text"/lottery"

Lottery

Lottery: the rules.

TicketPrice
number100
TicketPrice: how many ArkShop points one ticket costs. 100 means each ticket is 100 points.
DrawEveryMinutes
number60
DrawEveryMinutes: how often a draw happens, in minutes. 60 means once an hour.
MaxTicketsPerPlayer
number50
MaxTicketsPerPlayer: the most tickets one player can hold in a round. This stops one rich player from owning every draw. 50 is a fair cap. Set to 0 for no cap.
MinPlayers
number2
MinPlayers: the fewest different players needed for a real draw. If fewer than this bought in, the pot rolls over to the next round instead of paying out. 2 means you need at least two players. Set to 1 to always draw when at least one ticket is sold.
HouseCutPct
number0
HouseCutPct: the share the server keeps from the pot. 0.0 means the winner gets the whole pot. 0.1 means the server keeps 10 percent and the winner gets 90.
AnnounceBuys
toggletrue
AnnounceBuys: set to true to tell the whole server when someone buys tickets, to build hype. Set to false to keep buys quiet.
WarnBeforeMinutes
list[10,1]
WarnBeforeMinutes: a list of minute marks to shout a reminder before each draw. [10, 1] warns ten minutes and one minute before the draw. Set to [] for no warnings.
RecentWinnersShown
number3
RecentWinnersShown: how many past winners /lottery shows for hype. 3 is a good number.
HistoryKept
number20
HistoryKept: how many past draws to keep on file. 20 is plenty.
PingPayoutAtOrAbove
number100000
PingPayoutAtOrAbove: when a payout is this big or bigger, the Discord winner post adds an @here ping. Set very high to never ping.

Permissions

Permissions: gate who can play. Needs Permissions.dll.

Enabled
toggletrue
Enabled: set to true to check Permissions. If off or missing, everyone can play.
UsePermission
textempty
UsePermission: leave "" so everyone can play. Set a node to limit the lottery to players who have it.

ArkShop

ArkShop: the points economy. The lottery needs it to charge for tickets and pay the winner.

Enabled
toggletrue
Enabled: set to true to use ArkShop. If off or missing, the lottery can not run.

Discord

Discord: announces winners and rollovers.

Enabled
togglefalse
Enabled: set to true to send Discord posts. Leave false to keep it in game.
WebhookURL
textempty
WebhookURL: the Discord webhook for the channel.
Username
text"MiniLottery"
Username: the name the webhook posts under.
ServerName
text"My ARK Server"
ServerName: shown in the footer. Set it to 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.

{
  // This file explains every setting in config.json.
  // It has notes in it, so it is NOT valid JSON. Do not load this file.
  // Edit config.json instead. This file is just here to help you.

  "General": {
    // Debug: set to true to write extra lines to ArkApi.log. Leave it false for normal play.
    "Debug": false
  },

  // Commands: the word players type. It has sub actions:
  //   /lottery            show the pot, your tickets, odds, time to draw, and recent winners
  //   /lottery buy <n>    buy n tickets
  //   /lottery verify     show the last draw's seed and hash so you can check it was fair
  "Commands": {
    "BuyCMD": "/lottery"
  },

  // Lottery: the rules.
  "Lottery": {
    // TicketPrice: how many ArkShop points one ticket costs. 100 means each ticket is 100 points.
    "TicketPrice": 100,

    // DrawEveryMinutes: how often a draw happens, in minutes. 60 means once an hour.
    "DrawEveryMinutes": 60,

    // MaxTicketsPerPlayer: the most tickets one player can hold in a round. This stops one rich
    // player from owning every draw. 50 is a fair cap. Set to 0 for no cap.
    "MaxTicketsPerPlayer": 50,

    // MinPlayers: the fewest different players needed for a real draw. If fewer than this bought
    // in, the pot rolls over to the next round instead of paying out. 2 means you need at least
    // two players. Set to 1 to always draw when at least one ticket is sold.
    "MinPlayers": 2,

    // HouseCutPct: the share the server keeps from the pot. 0.0 means the winner gets the whole
    // pot. 0.1 means the server keeps 10 percent and the winner gets 90.
    "HouseCutPct": 0.0,

    // AnnounceBuys: set to true to tell the whole server when someone buys tickets, to build hype.
    // Set to false to keep buys quiet.
    "AnnounceBuys": true,

    // WarnBeforeMinutes: a list of minute marks to shout a reminder before each draw. [10, 1]
    // warns ten minutes and one minute before the draw. Set to [] for no warnings.
    "WarnBeforeMinutes": [10, 1],

    // RecentWinnersShown: how many past winners /lottery shows for hype. 3 is a good number.
    "RecentWinnersShown": 3,

    // HistoryKept: how many past draws to keep on file. 20 is plenty.
    "HistoryKept": 20,

    // PingPayoutAtOrAbove: when a payout is this big or bigger, the Discord winner post adds an
    // @here ping. Set very high to never ping.
    "PingPayoutAtOrAbove": 100000
  },

  // Permissions: gate who can play. Needs Permissions.dll.
  "Permissions": {
    // Enabled: set to true to check Permissions. If off or missing, everyone can play.
    "Enabled": true,

    // UsePermission: leave "" so everyone can play. Set a node to limit the lottery to players
    // who have it.
    "UsePermission": ""
  },

  // ArkShop: the points economy. The lottery needs it to charge for tickets and pay the winner.
  "ArkShop": {
    // Enabled: set to true to use ArkShop. If off or missing, the lottery can not run.
    "Enabled": true
  },

  // Discord: announces winners and rollovers.
  "Discord": {
    // Enabled: set to true to send Discord posts. Leave false to keep it in game.
    "Enabled": false,

    // WebhookURL: the Discord webhook for the channel.
    "WebhookURL": "",

    // Username: the name the webhook posts under.
    "Username": "MiniLottery",

    // ServerName: shown in the footer. Set it to your server name.
    "ServerName": "My ARK Server"
  }
}