Setup
The following commands can be used to set up the bot for usage in your server!
Firstly, use the setup-command. The format for the command is: -
*setup <channel> - Here, <channel> is supposed to be replace with the channel where the starred messages are to be sent.
For example: -
*setup #starboard OR *setup #announcements OR *setup 631556011467079681
The bot will be ready for usage. You can further use the settings commands to modify the behaviour of the starboard. The default settings are listed below.
*setup <channel> - Here, <channel> is supposed to be replace with the channel where the starred messages are to be sent.
For example: -
*setup #starboard OR *setup #announcements OR *setup 631556011467079681
The bot will be ready for usage. You can further use the settings commands to modify the behaviour of the starboard. The default settings are listed below.
- MINIMUM REQUIREMENT - This defines how many stars does a message require to be starred. The default value is 4.
- CHANNEL - This is the channel where the starred messages are sent by the bot. The default value is given during setup.
- EMOJI - This is the emoji that is to be considered a "STAR". This can either be the default ⭐ or one of the server's custom emoji.
Settings
The following are the available settings can be used for modifying the bot's behaviour in your server
Minimum requirement
This defines how many people need to react to the message with a "STAR" (⭐ by default) for the message to be starred. By default this is set to 4 but can later be modified using the minimum command as explained below.
FORMAT : *minimum <number> OR *min <number>
Here the <number> is to be replaced with a number of choice. It has to be greater than or equal to 2.
This will set the minimum requirement to the number you replace <number> with.
FOR EXAMPLE
*minimum 6 will set the minimum requirement to 6.
*min 3 will set the minimum requirement to 3.
Channel
This is the channel where the starred messages will be sent by the bot. The bot needs to have permissions to send, read, edit messages in the channel. The default value for this setting is provided while using the setup command and can be later modified using the channel command as explained below.
FORMAT : *channel <channel> OR *chan <channel> OR *board <channel>
Here the <channel> is to be replaced with a channel of the server. It can either be a channel tag or a channel ID (only name won't work).
This will set the starboard channel to the channel you replace <channel> with.
FOR EXAMPLE
*channel #announcements will set the channel to #announcements.
*board 631556011467079681 will set the starboard channel to the server's channel with ID 631556011467079681.
Emoji
This specifies the emoji that is considered as a "STAR" by the bot. The default value for this setting is ⭐(:star: on discord) and can be later modified using the emoji command as explained below.
FORMAT : *emoji <emoji> OR *star <emoji>
Here the <emoji> is to be replaced with a custom emoji of the server.
This will set the specified emoji as the "STAR" for the server.
FOR EXAMPLE
*emoji :thonk: will set the thonk emoji as the server's "STAR".
Reset
Sometimes you may want to reset the minimum amount of required stars to 4 or reset the "STAR" to the ⭐ emoji. For this purpose, you can use reset command as explained below.
FORMAT : *reset <minimum|min|emoji|star>
Here the <minimum|min|emoji|star> is to be replaced with either of the 4.
This will reset the specified setting.
FOR EXAMPLE
*reset minimum OR *reset min will reset the minimum requirement to 4.
*reset emoji OR *reset star will reset the "STAR" to ⭐.
Update
This command can be used to alter the amount of stars a user has. This command can only be used by the server owner as explained below.
FORMAT : *update <user> <change>
Here, the first argument is the user whose stars are to be modified and the second argument is the change in stars. The change in stars can be a positive or a negative integer.
FOR EXAMPLE
*give @TheDrone7#1624 100 will give 100 stars to TheDrone7.
*update @TheDrone7#1624 -100 will remove 100 stars from TheDrone7.
This defines how many people need to react to the message with a "STAR" (⭐ by default) for the message to be starred. By default this is set to 4 but can later be modified using the minimum command as explained below.
FORMAT : *minimum <number> OR *min <number>
Here the <number> is to be replaced with a number of choice. It has to be greater than or equal to 2.
This will set the minimum requirement to the number you replace <number> with.
FOR EXAMPLE
*minimum 6 will set the minimum requirement to 6.
*min 3 will set the minimum requirement to 3.
Channel
This is the channel where the starred messages will be sent by the bot. The bot needs to have permissions to send, read, edit messages in the channel. The default value for this setting is provided while using the setup command and can be later modified using the channel command as explained below.
FORMAT : *channel <channel> OR *chan <channel> OR *board <channel>
Here the <channel> is to be replaced with a channel of the server. It can either be a channel tag or a channel ID (only name won't work).
This will set the starboard channel to the channel you replace <channel> with.
FOR EXAMPLE
*channel #announcements will set the channel to #announcements.
*board 631556011467079681 will set the starboard channel to the server's channel with ID 631556011467079681.
Emoji
This specifies the emoji that is considered as a "STAR" by the bot. The default value for this setting is ⭐(:star: on discord) and can be later modified using the emoji command as explained below.
FORMAT : *emoji <emoji> OR *star <emoji>
Here the <emoji> is to be replaced with a custom emoji of the server.
This will set the specified emoji as the "STAR" for the server.
FOR EXAMPLE
*emoji :thonk: will set the thonk emoji as the server's "STAR".
Reset
Sometimes you may want to reset the minimum amount of required stars to 4 or reset the "STAR" to the ⭐ emoji. For this purpose, you can use reset command as explained below.
FORMAT : *reset <minimum|min|emoji|star>
Here the <minimum|min|emoji|star> is to be replaced with either of the 4.
This will reset the specified setting.
FOR EXAMPLE
*reset minimum OR *reset min will reset the minimum requirement to 4.
*reset emoji OR *reset star will reset the "STAR" to ⭐.
Update
This command can be used to alter the amount of stars a user has. This command can only be used by the server owner as explained below.
FORMAT : *update <user> <change>
Here, the first argument is the user whose stars are to be modified and the second argument is the change in stars. The change in stars can be a positive or a negative integer.
FOR EXAMPLE
*give @TheDrone7#1624 100 will give 100 stars to TheDrone7.
*update @TheDrone7#1624 -100 will remove 100 stars from TheDrone7.
Info
The following commands can be used to view certain set of information.
Server info
This command can be used to view the server's current settings.
FORMAT : *serverinfo OR *si OR *gi OR *guildinfo
User info
This command can be used to view a certain user's stats.
FORMAT : *userinfo [user] OR *ui [user]
Here [user] can either be omitted or replaced with a user mention.
FOR EXAMPLE
*userinfo will show your own info.
*ui @TheDrone7#1624 will show TheDrone7's info.
Leader board
This command can be used to view the server specific leader board i.e. the list of users with the most stars in the server.
FORMAT : *leaderboard [page] OR *l [page] OR *leaders [page]
Here [page] can either be omitted or replaced with a number (page number of the leader board). Each leaderboard page contains 7 entries. The leaderboard is paginated so you don't need to use the command repeatedly if you wanna see different pages.
FOR EXAMPLE
*leaderboard will show the top 7 users with the most stars (Page 1 of the leaderboard).
*leaders 2 will show 2nd page of the leaderboard.
This command can be used to view the server's current settings.
FORMAT : *serverinfo OR *si OR *gi OR *guildinfo
User info
This command can be used to view a certain user's stats.
FORMAT : *userinfo [user] OR *ui [user]
Here [user] can either be omitted or replaced with a user mention.
FOR EXAMPLE
*userinfo will show your own info.
*ui @TheDrone7#1624 will show TheDrone7's info.
Leader board
This command can be used to view the server specific leader board i.e. the list of users with the most stars in the server.
FORMAT : *leaderboard [page] OR *l [page] OR *leaders [page]
Here [page] can either be omitted or replaced with a number (page number of the leader board). Each leaderboard page contains 7 entries. The leaderboard is paginated so you don't need to use the command repeatedly if you wanna see different pages.
FOR EXAMPLE
*leaderboard will show the top 7 users with the most stars (Page 1 of the leaderboard).
*leaders 2 will show 2nd page of the leaderboard.
Utility
The following commands are there for certain utility functions.
Ping
This command can be used to check the connectivity of the bot to the discord servers.
FORMAT : *ping
Invite
This command can be used to get a link to invite the bot to your own server.
FORMAT : *invite
Statistics
This command can be used to view the bot's statistics such as the number of servers.
FORMAT : *stats
Help
This command can be used to get a list of the bot's commands or view details of a bot's commands inside discord.
FORMAT : *help [command]
You can omit [command] to get a list of commands or replace it with a command's name to view more details about it,
FOR EXAMPLE
*help will show the list of commands (It will be paginated if the bot has permissions to MANAGE MESSAGES and ADD REACTIONS. Otherwise, it will be a complete list in the DMs
*help stats will show details about the stats command.
This command can be used to check the connectivity of the bot to the discord servers.
FORMAT : *ping
Invite
This command can be used to get a link to invite the bot to your own server.
FORMAT : *invite
Statistics
This command can be used to view the bot's statistics such as the number of servers.
FORMAT : *stats
Help
This command can be used to get a list of the bot's commands or view details of a bot's commands inside discord.
FORMAT : *help [command]
You can omit [command] to get a list of commands or replace it with a command's name to view more details about it,
FOR EXAMPLE
*help will show the list of commands (It will be paginated if the bot has permissions to MANAGE MESSAGES and ADD REACTIONS. Otherwise, it will be a complete list in the DMs
*help stats will show details about the stats command.