🚸 Added basic guide for official bot
This commit is contained in:
parent
e9b2de08da
commit
c93e090ed5
2 changed files with 78 additions and 74 deletions
42
README.md
42
README.md
|
|
@ -1,19 +1,23 @@
|
|||
# Xyter
|
||||
|
||||
## Installation
|
||||
|
||||
Rename config.json.example to config.json and fill in the fields.
|
||||
|
||||
_Please note that mongodb.url needs to be inside of double quotes ("YourURL")._
|
||||
|
||||
You can leave any of the **footer** fields empty, it will not impact the bot.
|
||||
|
||||
Then run **node deploy-commands.js** the first time then you can start the bot by **node src/index.js**
|
||||
|
||||
**Free MongoDB hosting**
|
||||
|
||||
- https://atlas.mongodb.com/
|
||||
|
||||
## Credits
|
||||
|
||||
**Please leave of some credits or if anyone ask about the bot, give them a link to the repository. Thanks!**
|
||||
# Xyter
|
||||
|
||||
## Installation
|
||||
|
||||
Rename config.json.example to config.json and fill in the fields.
|
||||
|
||||
_Please note that mongodb.url needs to be inside of double quotes ("YourURL")._
|
||||
|
||||
You can leave any of the **footer** fields empty, it will not impact the bot.
|
||||
|
||||
Then run **node deploy-commands.js** the first time then you can start the bot by **node src/index.js**
|
||||
|
||||
**Free MongoDB hosting**
|
||||
|
||||
- https://atlas.mongodb.com/
|
||||
|
||||
## Credits
|
||||
|
||||
**Please leave of some credits or if anyone ask about the bot, give them a link to the repository. Thanks!**
|
||||
|
||||
## Add it to your server
|
||||
|
||||
We have a official bot for this repository. [Invite bot!](https://discord.com/api/oauth2/authorize?client_id=949998000401436673&permissions=8&scope=bot%20applications.commands)
|
||||
|
|
@ -26,69 +26,69 @@ module.exports = {
|
|||
.setName('credits')
|
||||
.setDescription('Manage your credits.')
|
||||
.addSubcommand((subcommand) => subcommand
|
||||
.setName('give')
|
||||
.setDescription('Give credits to a user. (ADMIN)')
|
||||
.addUserOption((option) => option.setName('user').setDescription('The user you want to pay.').setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will pay.').setRequired(true)))
|
||||
.setName('give')
|
||||
.setDescription('Give credits to a user. (ADMIN)')
|
||||
.addUserOption((option) => option.setName('user').setDescription('The user you want to pay.').setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will pay.').setRequired(true)))
|
||||
.addSubcommand((subcommand) => subcommand
|
||||
.setName('take')
|
||||
.setDescription('Take credits from a user. (ADMIN)')
|
||||
.addUserOption((option) => option
|
||||
.setName('user')
|
||||
.setDescription('The user you want to take credits from.')
|
||||
.setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will take.').setRequired(true)))
|
||||
.setName('take')
|
||||
.setDescription('Take credits from a user. (ADMIN)')
|
||||
.addUserOption((option) => option
|
||||
.setName('user')
|
||||
.setDescription('The user you want to take credits from.')
|
||||
.setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will take.').setRequired(true)))
|
||||
.addSubcommand((subcommand) => subcommand
|
||||
.setName('balance')
|
||||
.setDescription("Check a user's balance.")
|
||||
.addUserOption((option) => option
|
||||
.setName('user')
|
||||
.setDescription('The user whose balance you want to check.')
|
||||
.setRequired(false)))
|
||||
.setName('balance')
|
||||
.setDescription("Check a user's balance.")
|
||||
.addUserOption((option) => option
|
||||
.setName('user')
|
||||
.setDescription('The user whose balance you want to check.')
|
||||
.setRequired(false)))
|
||||
.addSubcommand((subcommand) => subcommand
|
||||
.setName('redeem')
|
||||
.setDescription('Redeem your credits.')
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('How much credit you want to withdraw.')))
|
||||
.setName('redeem')
|
||||
.setDescription('Redeem your credits.')
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('How much credit you want to withdraw.')))
|
||||
.addSubcommand((subcommand) => subcommand
|
||||
.setName('gift')
|
||||
.setDescription('Gift someone credits from your credits.')
|
||||
.addUserOption((option) => option.setName('user').setDescription('The user you want to pay.').setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will pay.').setRequired(true))
|
||||
.addStringOption((option) => option.setName('reason').setDescription('Your reason.')))
|
||||
.setName('gift')
|
||||
.setDescription('Gift someone credits from your credits.')
|
||||
.addUserOption((option) => option.setName('user').setDescription('The user you want to pay.').setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will pay.').setRequired(true))
|
||||
.addStringOption((option) => option.setName('reason').setDescription('Your reason.')))
|
||||
.addSubcommand((subcommand) => subcommand.setName('top').setDescription('Check the top balance.'))
|
||||
.addSubcommand((subcommand) => subcommand
|
||||
.setName('transfer')
|
||||
.setDescription('Transfer credits from a user to another user. (ADMIN)')
|
||||
.addUserOption((option) => option
|
||||
.setName('from')
|
||||
.setDescription('The user you want to take credits from.')
|
||||
.setRequired(true))
|
||||
.addUserOption((option) => option
|
||||
.setName('to')
|
||||
.setDescription('The user you want to give credits to.')
|
||||
.setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will transfer.').setRequired(true)))
|
||||
.setName('transfer')
|
||||
.setDescription('Transfer credits from a user to another user. (ADMIN)')
|
||||
.addUserOption((option) => option
|
||||
.setName('from')
|
||||
.setDescription('The user you want to take credits from.')
|
||||
.setRequired(true))
|
||||
.addUserOption((option) => option
|
||||
.setName('to')
|
||||
.setDescription('The user you want to give credits to.')
|
||||
.setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will transfer.').setRequired(true)))
|
||||
.addSubcommand((subcommand) => subcommand
|
||||
.setName('set')
|
||||
.setDescription('Set credits on a user. (ADMIN)')
|
||||
.addUserOption((option) => option
|
||||
.setName('user')
|
||||
.setDescription('The user you want to set credits on.')
|
||||
.setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will set.').setRequired(true)))
|
||||
.setName('set')
|
||||
.setDescription('Set credits on a user. (ADMIN)')
|
||||
.addUserOption((option) => option
|
||||
.setName('user')
|
||||
.setDescription('The user you want to set credits on.')
|
||||
.setRequired(true))
|
||||
.addIntegerOption((option) => option.setName('amount').setDescription('The amount you will set.').setRequired(true)))
|
||||
.addSubcommand((subcommand) => subcommand
|
||||
.setName('settings')
|
||||
.setDescription('Manage credit settings. (ADMIN)')
|
||||
.addBooleanOption((option) => option.setName('status').setDescription('Toggle credits.'))
|
||||
.addStringOption((option) => option.setName('url').setDescription('Controlpanel.gg URL.'))
|
||||
.addStringOption((option) => option.setName('token').setDescription('Controlpanel.gg token.'))
|
||||
.addNumberOption((option) => option.setName('rate').setDescription('Credits rate.'))
|
||||
.addNumberOption((option) => option.setName('minimum-length').setDescription('Minimum length for credits.'))
|
||||
.addNumberOption((option) => option.setName('work-rate').setDescription('Work rate (rate).'))
|
||||
.addNumberOption((option) => option
|
||||
.setName('work-timeout')
|
||||
.setDescription('Timeout between working for credits (milliseconds).'))
|
||||
.addNumberOption((option) => option.setName('timeout').setDescription('Timeout between credits (milliseconds).')))
|
||||
.setName('settings')
|
||||
.setDescription('Manage credit settings. (ADMIN)')
|
||||
.addBooleanOption((option) => option.setName('status').setDescription('Toggle credits.'))
|
||||
.addStringOption((option) => option.setName('url').setDescription('Controlpanel.gg URL.'))
|
||||
.addStringOption((option) => option.setName('token').setDescription('Controlpanel.gg token.'))
|
||||
.addNumberOption((option) => option.setName('rate').setDescription('Credits rate.'))
|
||||
.addNumberOption((option) => option.setName('minimum-length').setDescription('Minimum length for credits.'))
|
||||
.addNumberOption((option) => option.setName('work-rate').setDescription('Work rate (rate).'))
|
||||
.addNumberOption((option) => option
|
||||
.setName('work-timeout')
|
||||
.setDescription('Timeout between working for credits (milliseconds).'))
|
||||
.addNumberOption((option) => option.setName('timeout').setDescription('Timeout between credits (milliseconds).')))
|
||||
.addSubcommand((subcommand) => subcommand.setName('work').setDescription('Work for credits.')),
|
||||
async execute(interaction) {
|
||||
const guild = await guilds.findOne({ guildId: interaction.member.guild.id });
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue