move config section to wiki

Author: fooooooooooooooo

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs"]
+	path = docs
+	url = https://github.com/fooooooooooooooo/VelocityDiscord.wiki

README.md

@@ -47,294 +47,6 @@ Chat from all servers gets bridged with a discord channel
 2. Install the [YepTwo](https://github.com/unilock/YepTwo) backend mod/plugin on each of your backend servers that you want to
    receive advancements/deaths from
 
-## Configuration
+### Configuration
 
-Default config generated on startup:
-
-```toml
-# Don't change this
-config_version = "2.0"
-
-# Comma separated list of server names to exclude from the bridge (defined under [servers] inside your velocity.toml)
-# e.g., exclude_servers = ["lobby", "survival"]
-exclude_servers = []
-excluded_servers_receive_messages = false
-
-# How often to ping all servers to check for online status (seconds)
-# Excluded servers will not be pinged
-# Use a value of 0 to disable
-ping_interval = 30
-
-# Server display names
-# If a server is not found in this list, the server name (from velocity.toml) will be used instead
-[server_names]
-# lobby = "Lobby"
-
-[discord]
-# Bot token from https://discordapp.com/developers/applications/
-# Not server overridable
-token = "TOKEN"
-# Default channel ID to send Minecraft chat messages to
-channel = "000000000000000000"
-
-# Show messages from bots in Minecraft chat
-show_bot_messages = false
-# Show clickable links for attachments in Minecraft chat
-show_attachments_ingame = true
-
-# Activity text of the bot to show in Discord
-# Placeholders available: {amount}
-# Can be disabled with "" or false
-# Not server overridable
-activity_text = "with {amount} players online"
-
-# Enable mentioning Discord users from Minecraft chat
-enable_mentions = true
-# Enable @everyone and @here pings from Minecraft chat
-enable_everyone_and_here = false
-
-# Interval (in minutes) for updating the channel topic
-# Use a value of 0 to disable
-# Not server overridable
-update_channel_topic_interval = 0
-
-# Channel topic config (if enabled)
-[discord.channel_topic]
-# Template for the channel topic
-# Placeholders available:
-# {players} - Total number of players online
-# {player_list} - List of players (format is defined below)
-# {servers} - Number of servers
-# {server_list} - List of server names
-# {hostname} - Server hostname
-# {port} - Server port
-# {motd} - Message of the Day (MOTD)
-# {query_port} - Query port
-# {max_players} - Maximum number of players
-# {plugins} - Number of plugins
-# {plugin_list} - List of plugin names
-# {version} - Server version
-# {software} - Software name
-# {average_ping} - Average ping of all players
-# {uptime} - Server uptime in hours and minutes
-# {server[SERVERNAME]} - Dynamic placeholder for each server's name and status (e.g., {server[MyServer]}, {server[AnotherServer]}, {server[Lobby]}, etc.)
-format = """{players}/{max_players}
-{player_list}
-{hostname}:{port}
-Uptime: {uptime}"""
-
-# Template for server[SERVERNAME] placeholder in the channel topic
-# Placeholders available: {name}, {players}, {max_players}, {motd}, {version}, {protocol}
-server = "{name}: {players}/{max_players}"
-
-# Template for server[SERVERNAME] placeholder in the channel topic when the server is offline
-# Placeholders available: {name}
-server_offline = "{name}: Offline"
-
-# Can be disabled with "" or false to hide the list completely when no players are online
-player_list_no_players_header = "No players online"
-
-# Can be disabled with "" or false to hide the header and only show the player list
-player_list_header = "Players: "
-
-# Placeholders available: {username}, {ping}
-player_list_player = "{username}"
-
-# Separator between players in the list, \n can be used for new line
-player_list_separator = ", "
-
-# Maximum number of players to show in the topic
-# Set to 0 to show all players
-player_list_max_count = 10
-
-[discord.webhook]
-# Full webhook URL to send chat messages to
-webhook_url = ""
-# Full URL of an avatar service to get the player's avatar from
-# Placeholders available: {uuid}, {username}
-avatar_url = "https://visage.surgeplay.com/face/96/{uuid}"
-
-# The format of the webhook's username
-# Placeholders available: {username}, {server}
-webhook_username = "{username}"
-
-# Minecraft > Discord message formats
-# Uses the same formatting as the Discord client (a subset of markdown)
-#
-# Messages can be disabled by setting format to empty string ("") or false
-#
-# type can be one of the following:
-# "text"  - Normal text only message with the associated x_message format
-# "embed" - Discord embed with the associated x_message format as the description field
-# Default for all is "text"
-#
-# embed_color is the color of the embed, in #RRGGBB format
-[discord.chat.message]
-# Placeholders available: {username}, {prefix}, {server}, {message}
-# Can be disabled with "" or false
-format = "{username}: {message}"
-
-# for user messages, the following types can be used
-# "text"    - Normal text only message with the above
-#
-# "webhook" - Use a Discord webhook to have the bot use the player's username and avatar when sending messages
-#             Requires a webhook URL to be set below
-#             Ignores the above message format, and just sends the message as the content of the webhook
-#
-# "embed"   - Discord embed with the above format as the description field
-type = "text"
-# Can be disabled with "" or false
-embed_color = ""
-# Channel override for this message type, set to "" or false or remove to use the default channel
-# Can be applied to all message types
-# channel = "000000000000000000"
-
-[discord.chat.join]
-# Placeholders available: {username}, {prefix}, {server}
-# Can be disabled with "" or false
-format = "**{username} joined the game**"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#40bf4f"
-
-[discord.chat.leave]
-# Placeholders available: {username}, {prefix}, {server}
-# Can be disabled with "" or false
-format = "**{username} left the game**"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#bf4040"
-
-[discord.chat.disconnect]
-# Possible different format for timeouts or other terminating connections
-# Placeholders available: {username}, {prefix}
-# Can be disabled with "" or false
-format = "**{username} disconnected**"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#bf4040"
-
-[discord.chat.server_switch]
-# Placeholders available: {username}, {prefix}, {current}, {previous}
-# Can be disabled with "" or false
-format = "**{username} moved to {current} from {previous}**"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#40bf4f"
-
-[discord.chat.death]
-# Placeholders available: {username}, {death_message}
-# death_message includes the username just as it is shown ingame
-# Can be disabled with "" or false
-format = "**{death_message}**"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#bf4040"
-
-[discord.chat.advancement]
-# Placeholders available: {username}, {advancement_title}, {advancement_description}
-# Can be disabled with "" or false
-format = "**{username} has made the advancement __{advancement_title}__**\n_{advancement_description}_"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#40bf4f"
-
-# Not server overridable
-[discord.chat.proxy_start]
-# Can be disabled with "" or false
-format = "**Proxy started**"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#40bf4f"
-
-# Not server overridable
-[discord.chat.proxy_stop]
-# Can be disabled with "" or false
-format = "**Proxy stopped**"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#bf4040"
-
-[discord.chat.server_start]
-# Placeholders available: {server}
-# Can be disabled with "" or false
-format = "**{server} has started**"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#40bf4f"
-
-[discord.chat.server_stop]
-# Placeholders available: {server}
-# Can be disabled with "" or false
-format = "**{server} has stopped**"
-type = "text"
-# Can be disabled with "" or false
-embed_color = "#bf4040"
-
-[discord.commands.list]
-# Not server overridable
-enabled = true
-
-# Ephemeral messages are only visible to the user who sent the command
-# Not server overridable
-ephemeral = true
-
-# Placeholders available: {server_name}, {online_players}, {max_players}
-server_format = "[{server_name} {online_players}/{max_players}]"
-
-# Placeholders available: {username}
-player_format = "- {username}"
-
-# Can be disabled with "" or false
-no_players = "No players online"
-
-# Can be disabled with "" or false
-server_offline = "Server offline"
-# Not server overridable
-codeblock_lang = "asciidoc"
-
-# Discord > Minecraft message formats
-# Uses XML-like formatting with https://docs.advntr.dev/minimessage/format.html
-[minecraft]
-# Ingame command for plugin
-# Not server overridable
-# e.g., /discord, /discord reload, /discord topic preview
-plugin_command = "discord"
-
-# Placeholders available: {discord}
-discord_chunk = "<dark_gray>[<{discord_color}>Discord<dark_gray>]<reset>"
-
-# Placeholders available: {role_color}, {display_name}, {username}, {nickname}
-# <insert> tag allows you to shift right-click the username to insert @{username} in the chat
-username_chunk = "<{role_color}><insert:@{username}><hover:show_text:{display_name}>{nickname}</hover></insert><reset>"
-
-# Placeholders available: {discord_chunk}, {username_chunk}, {attachments}, {message}
-message = "{discord_chunk} {role_prefix} {username_chunk}<dark_gray>: <reset>{message} {attachments}"
-
-# Placeholders available: {url}, {attachment_color}
-attachments = "<dark_gray><click:open_url:{url}>[<{attachment_color}>Attachment<dark_gray>]</click><reset>"
-
-# Placeholders available: {url}, {link_color}
-# Can be disabled with "" or false
-links = "<click:open_url:\"{url}\"><hover:show_text:\"Click to open {url}\"><dark_gray>[</dark_gray><{link_color}>Link<dark_gray>]</hover></click>"
-
-# Colors for the <{discord_color}>, <{attachment_color}> and <{link_color}> tags
-discord_color = "#7289da"
-attachment_color = "#4abdff"
-link_color = "#4abdff"
-
-# Role prefix configuration
-# Format: "role_id" = "prefix format using MiniMessage"
-[minecraft.role_prefixes]
-# "123456789" = "<dark_gray>[</dark_gray><red><b>OWNER</b></red><dark_gray>]</dark_gray>"
-# "987654321" = "<dark_gray>[</dark_gray><blue>ADMIN</blue><dark_gray>]</dark_gray>"
-# "456789123" = "<dark_gray>[</dark_gray><green>MOD</green><dark_gray>]</dark_gray>"
-# "789123456" = "<dark_gray>[</dark_gray><aqua>HELPER</aqua><dark_gray>]</dark_gray>"
-
-# Override config for specific servers
-# Any config option under [discord] or [minecraft] can be overridden (other than options labelled not server overridable)
-# Format: [override.(velocity.toml server name).discord] or [override.(velocity.toml server name).minecraft]
-# Example:
-# [override.lobby.discord]
-# channel = "000000000000000000"
-```
+The config file is generated at `plugins/discord/config.toml`. See [here](wiki/Configuration) for the default config