Boost Order Management Discord Bot
Allow for easy mobile creation and execution of a sign-up list and boost list for the game Egg Inc.
- There is a limitation of one contract per channel or thread.
Create a discord application here: https://discord.com/developers/applications
Take the Application ID and Secret and save those to configure the bot in .config.json. If you wish to restrict the bot to a specific server then add your Guild ID to DiscordGuildID
.config.json:
{
"DiscordToken": "APP_SECRET",
"DiscordAppID": "APP_ID",
"DiscordGuildID": "DISCORD_GUILD_ID"
}Install your bot into your discord server with this URL: https://discord.com/api/oauth2/authorize?client_id=$(BOT_APP_ID)&permissions=466004470848&scope=bot%20applications.commands
/contract contract-id coop-id coop-size ping-role
This will display a Sign-up List and a message with reactions for
players to sign up.
When the Sign-up List reaches the coop-size it will automatically
start the contract
The reactions are farmer, bell and dice.
Select farmer and/or bell to sign up on the list
Select the dice as a vote to randomize the Boost List.
Normally the Boost List will will run in Sign-up Order.
The vote needs a 2/3 super-majority before electing the random order.
ping-role: The default for this is @here.
/change [ping-role] [boost-order] Change settings of a running a contract. There are several actions available.
Change the boost order of a running contract. Specify a comma separated list of values. Ranges can be specified with hyphenated values. Every boost position must be listed in the reordering. Examples: Specify individual positions: "2,4,6,3,5" Specify ranges: 5,1-4 Specify reverse range: 5-1
Use this to update the ping role for the contract. Select a Role on your server. It's not possible to select "@here" for the role.
/start
This will change the Sign-up List to the Boost List. If there is a order preference it will apply before the Boost List is displayed. The first farmer on the list is presented with a boost token indicating that they are the current booster. The channel receives a message mentioning who's turn it is. Farmers that reacted with a 🔔 will receive a DM about this.
/boost
The Farmer who's turn it is to receive tokens uses this to indicate that they
are boosting.
Contract Farmers may vote to indicate an AFK player has enough tokens to boost by
selecting the 🚀 icon. Two votes will elect a successful boost.
/skip
Move current booster to last in the Boost List
/unboost [farmer]
Sometimes mistakes happen and someone is marked as boosting too early. Mark someone as unboosted to take care of it. Their position in the boost order stays the same and would boost next if they were earlier in the list than the current booster.
/prune
Remove a Farmer from the Sign-up or Boost List. This is useful if a Farmer reacted to the Sign-up message and didn't join the contract within the game.
/join farmer-mention
Add a farmer to the contract within that channel. The players are added as Farmers without 🔔 DM notifications.
/swap command to swap yourself when currently boosting to next
/priority to allow someone to signal they need to go early Player has indicated that they wish to boost early for Real Life reasons