Code (YAML):
[/COLOR
]
[/URL
]
# ==============================================================================
# CountryFlags Configuration
#
# This file controls the behavior of the CountryFlags plugin, which displays
# country flag emojis as chat and tab prefixes based on player IP.
#
# Features:
# • Uses MaxMind GeoLite2 Country database for IP-to-country lookups.
# • Supports proxy IP forwarding (BungeeCord/Velocity).
# • Players can toggle flag prefix visibility.
# • Configurable default prefix visibility (opt-in vs opt-out).
# • Integrates with PlaceholderAPI to dynamically insert flag emojis into
# chat and tab formats.
#
# Placeholder Usage:
# To show flag prefixes, server owners must configure their chat and tab list
# plugins to include the following PlaceholderAPI placeholder:
#
# %countryflags_flag%
#
# ❗ IMPORTANT ❗
# THIS PLUGIN WILL NOT DISPLAY ANY FLAGS UNLESS YOU ADD THE PLACEHOLDER TO YOUR CHAT/TAB FORMATTING
#
# This plugin does **not** modify chat or tab names directly — it only provides
# placeholder output. You must add %countryflags_flag% in your chat/tab plugin’s format string
# via compatible plugins like VentureChat, TAB, DeluxeChat, etc.
#
# ⚠️ Important:
# • Server owners must manually download the GeoLite2 database.
# • Bedrock clients cannot receive custom resource packs with bitmap fonts.
# Their fallback format can be customized in this config.
# ==============================================================================
# === ️ GeoIP Database Settings ===
# Path to the MaxMind GeoLite2 Country database file (relative to the server root folder).
# The database file is NOT included with the plugin due to licensing restrictions.
#
# To download the database:
# 1. Register a free account at https://www.maxmind.com/en/geolite2/signup
# 2. Log in and click "Download Databases" on your account's main page.
# 3. Scroll to "GeoLite2 Country" and click "Download GZIP".
# 4. Extract the archive to obtain GeoLite2-Country.mmdb.
# 5. Place the GeoLite2-Country.mmdb file at the path specified below.
#
# Without this file, IP-to-country lookups will fail and the plugin will use the default emoji.
geoip-db-path
: plugins/CountryFlags/GeoLite2-Country.mmdb
# === ️ Default Fallback ===
# Emoji to show when a player's country cannot be determined.
default-fallback-emoji
:
""
# === First-Join Seeding ===
# For brand-new players (no saved prefs yet), set their initial preferences:
force-broadcast-on-first-join
: true
# Java + Bedrock
force-pack-on-first-join
: true
# Java + Bedrock; Java gets a prompt from Bukkit, Bedrock receives the pack via Geyser
# Whether to add a space after the country flag placeholder in chat/tab.
add-space-after-placeholder
: false
# === Resource Pack Delivery ===
# Whether to automatically send the included resource pack on login or first toggle.
# true → Players will be prompted to download the resource pack
# false → Players must install the pack manually; link provided below
use-resource-pack
: true
# URL to your Java Edition resource pack (direct download; no trailing slash)
java-pack-url
:
"https://countryflags-pack.netlify.app/countryflagspack.zip"
# Optional SHA-1 hash (40 hex chars). Leave blank "" if you don't use it.
# If set, Minecraft shows a trusted hash and behaves more reliably.
java-pack-sha1
:
""
# If Geyser is installed on THIS server (single-server setup), we will auto-register
# this Bedrock pack URL with Geyser at startup so Bedrock players get it on join.
bedrock-pack-url
:
"https://countryflags-pack-bedrock.netlify.app/countryflagspack-bedrock.zip"
# === Bedrock Fallback Formatting ===
# Defines how the %countryflags_flag% placeholder appears for Bedrock players
# **ONLY** when they do not have the CountryFlags Bedrock resource pack active
# (for example, if they declined it, or if Geyser is not set up to send it).
#
# The Bedrock resource pack contains PNG flag glyphs, so if it is active, players
# will see the same bitmap flags as Java players.
#
# This fallback format is used as a textual representation instead of a flag emoji
# or bitmap image.
#
# <code> → replaced with the two-letter country code (e.g., US, FR, DE)
# Example: "<dark_gray>[<white><code></white>]</dark_gray>&r" → produces [US] in dark-gray/white
bedrock-fallback-format
:
"<dark_gray>[<white><code></white>]</dark_gray>&r"
# === Debugging ===
# Enable debug mode to print detailed logs for troubleshooting.
debug-mode
: false
# Show whether each connection was via PROXY or DIRECT in debug logs.
# This does NOT affect how IPs are resolved — informational only.
debug-show-proxy-mode
: false