Skip to content

2. Configuration

Tien Dat Pham edited this page Mar 22, 2022 · 6 revisions

Content

Your initial config.json file should look like this:

{
	"client": {
		"activity": {
			"name": "you",
			"status": "DoNotDisturb",
			"type": "Watching"
		},
		"private_guilds": [],
		"shard_count": 1,
		"slash_commands_for_global": true,
		"support_guild_invite_link": "",
		"token": ""
	},
	"credentials": {
		"lavalink": {
			"host": "localhost",
			"password": "SleepingOnTrains",
			"port": 2333
		},
		"osu": {
			"client_id": 0,
			"client_secret": ""
		},
		"postgresql": {
			"database_name": "",
			"host": "localhost",
			"password": "thisisnottheend",
			"port": 5432,
			"username": ""
		},
		"top.gg": ""
	}
}

Explanations

  • client: Represents for bot settings
    • shard_count: Number of sharded instances of your bot. Put any number you want.
    • token: Self-explanatory
    • private_guilds: An array of your private guild IDs (for faster command loading)
    • slash_commands_for_global: true if you want your commands to be public, false otherwise

    ⚠️ Warning

    • Set a value for both fields above mostly results in "command duplication" (commands appearing twice) situation
      • Sometimes the duplication happens randomly
    • Only put the guild IDs where the bot is in (if you are using private_guilds field)
    • Enabling commands for global will take a long time to reach out guilds
    • support_guild_invite_link: URL to your support guild of the bot
    • activity: Client activity such as "Playing osu!"
      • type: Activity type
        • Accepted values: Playing, Watching, Competing, ListeningTo
      • name: Name of activity
      • status: Discord status
        • Accepted values: Online, Invisible, Idle, DoNotDisturb
  • credentials: Basic credentials in order to make the bot run w/o any potential issues
    • top.gg: Top.gg webhook, should be at https://top.gg/bot/{your_bot_id}/webhooks
      • Remember to register your bot first!
    • postgresql: Credentials for database. Remember to setup database
      • username: {USERNAME} when you setup the database
      • password: {PASSWORD} when you setup the database
      • database_name: {DATABASE_NAME} when you setup the database
      • host: IP Address/Hostname of your database host, localhost by default
      • port: Port number of your database host, 5432 by default
    • osu: Credentials for osu! commands. How-to-get
      • Can be ignored, but the commands won't work
    • lavalink: Credentials for Lavalink. Remember to setup lavalink
Clone this wiki locally