From 3700e4055d3fb2df479124375f4dfe6e4578bd06 Mon Sep 17 00:00:00 2001 From: profitroll Date: Tue, 6 May 2025 20:28:42 +0200 Subject: [PATCH] Fixed formatting in README --- README.md | 43 +++++++++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 024a1c4..0483db5 100644 --- a/README.md +++ b/README.md @@ -39,59 +39,66 @@ Open source Discord bot for quizzes and quest-like events. ```json { - "locale": "en-US", // Bot's default locale. Based on file name from locale/ - "debug": false, + "locale": "en-US", // Debug mode setting + "debug": false, + // Bot's config "bot": { + // Discord ID(s) of bot's owner(s) "owners": [ 0 - // Discord ID of bot's owner ], + // Discord ID(s) of the debug guild(s) "debug_guilds": [ 0 - // Discord ID of the debug guild ], - "bot_token": "", // Bot's token - "timezone": "UTC", + "bot_token": "", // Bot's timezone + "timezone": "UTC", + // Bot's status activity "status": { - "enabled": true, // Whether activity is enabled + "enabled": true, + // Type of the activity. Can be: "playing", "watching", "listening", "streaming", "competing" and "custom" "activity_type": "playing", - // Type of the activity. Can be: playing, watching, listening, streaming, competing and custom - "activity_text": "The Game Of Life" // Text of the activity + "activity_text": "The Game Of Life" } }, + // Database connection "database": { - "user": null, // User name for database connection. null if without auth - "password": null, + "user": null, // User password for database connection. null if without auth - "host": "127.0.0.1", + "password": null, // Database host - "port": 27017, + "host": "127.0.0.1", // Database port - "name": "quiz_bot" + "port": 27017, // Database name + "name": "quiz_bot" }, + // Cache connection "cache": { + // Type of caching engine. Can be: "memcached", "redis" or null "type": null, - // Type of caching engine. Can be: memcached and redis + // Memcached connection. Only used if cache type is "memcached" "memcached": { - "uri": "127.0.0.1:11211" // Memcached URI + "uri": "127.0.0.1:11211" }, + // Redis connection. Only used if cache type is "redis" "redis": { - "uri": "redis://127.0.0.1:6379/0" // Redis URI + "uri": "redis://127.0.0.1:6379/0" } }, + // Emojis used by guilds that prefer emoji messages "emojis": { - "guess_wrong": null // Markdown of a Discord emoji to be used for wrong guesses + "guess_wrong": null } } ```