# Configuration
### Configuration
Use this page to manage the main Vxkoth settings.
Edit the config files carefully.
Reload or reload after changes if required by your setup.
### Config files
Document the files used by Vxkoth here.
Typical files include:
Config.yml
```yaml
# ==========================================
# VxKoth Configuration
# ==========================================
global:
use-cache: false
debug: false
# Make sure this matches a valid Java TimeZone (e.g., Europe/Amsterdam, America/New_York)
schedule-timezone: Europe/Amsterdam
hooks:
bossbar:
# ======================================================
# Note: Bossbar colors, styles, and text are now fully
# customizable PER-KOTH! You can edit them inside each
# arena's specific file: plugins/VxKoth/koths/.yml
# ======================================================
# How far away (in blocks) a player must be to see the KOTH bossbar
range: 50
settings:
# ======================================================
# TEAM & CLAN SUPPORT
# ======================================================
# Choose which plugin VxKoth should hook into to group players.
# Available Options: NONE, BetterTeams, SimpleClans, mcMMO, Lands, Gangs
team-support: "NONE"
# ======================================================
# HOLOGRAM SETTINGS
# ======================================================
# Note: Hologram text and titles are customizable PER-KOTH
# inside their respective arena .yml files.
#
# Choose when the hologram should be visible floating above the KOTH:
# "all the time" - Shows the "Inactive" status when the KOTH is off.
# "only when koth is active" - Completely hides the hologram when off.
hologram-active: "all the time"
# ======================================================
# VISUAL EVENT SETTINGS
# ======================================================
particles:
enabled: true
# Use valid Spigot particle names (e.g., FLAME, VILLAGER_HAPPY, HEART)
type: "FLAME"
dynamic-floor:
enabled: true
# ----------------------------------------------------
# KOTH Event Expiration Timers
# ----------------------------------------------------
# Timeout: If the KOTH reaches this time limit, the event shuts down
# and NOBODY wins. Use this to prevent empty events running forever.
koth-timeout-seconds: 1800
# Hardstop: If the KOTH reaches this time limit, it FORCE-ENDS and
# gives the rewards to the LAST person who was capturing it!
# Use this to stop endless PVP wars. (Set to 0 to disable).
hardstop: 3600
schedule-alerts:
enabled: true
# Time in seconds before the KOTH starts to broadcast an alert
alerts: [3600, 1800, 900, 600, 300, 60, 30, 15, 10, 5]
broadcast-range: 0
```
Lang.yml
```yaml
# Use standard colors (&a, &c) or Hex Colors (#&RRGGBB)
messages:
prefix: "#&ff6600&lVxKoth &8» &r"
no-permission: "#&ff0000You do not have permission to access this command!"
only-players: "#&ff0000You must be a player to use this command!"
invalid-command: "#&ff0000Invalid command or subcommand!"
plugin-reloaded: "#&33ff33VxKoth configuration, languages, and arenas successfully reloaded!"
# Help Menu
help-header: "&8&m--------------------------------------------------"
help-title: " #&ff6600&lVxKoth Commands"
help-cmd-info: " #&fc8d5d/vxkoth info &8- &7View arena info"
help-cmd-help: " #&fc8d5d/vxkoth help &8- &7Shows this menu"
help-cmd-wand: " #&fc8d5d/vxkoth wand &8- &7Get selection wand"
help-cmd-create: " #&fc8d5d/vxkoth create Schedule.json
```json
[
{
"arena": "example_arena",
"day": "MONDAY",
"time": "15:30"
},
{
"arena": "outpost",
"day": "EVERYDAY",
"time": "20:00"
}
]
```
### Safe edit flow
{% stepper %}
{% step %}
#### Stop or prepare your server
Avoid editing while active writes are happening.
{% endstep %}
{% step %}
#### Back up the files
Save a copy before changing values.
{% endstep %}
{% step %}
#### Edit one section at a time
Change small pieces first.
{% endstep %}
{% step %}
#### Apply the changes
Reload plugin.
{% endstep %}
{% step %}
#### Test the result
Check logs and confirm the feature works in game.
{% endstep %}
{% endstepper %}
### Example format
Use this structure for each setting:
```yml
example-setting: true
```
* **Path:** `example-setting`
* **Default:** `true`
* **Allowed values:** `true`, `false`
* **Description:** Enables the example feature.
* **Reload:** Restart recommended.
### Best practices
* Keep comments when possible.
* Avoid changing many values at once.
* Test large changes on a staging server.
* Keep backups for every release update.
{% hint style="warning" %}
Wrong indentation or invalid values can break YAML-based configs.
{% endhint %}
### Troubleshooting
#### Config changes do not apply
Check whether that option supports reload.
If not, restart the server.
#### Plugin fails after editing
Check:
* YAML indentation
* missing quotes
* invalid numbers
* unsupported values
Then review the latest logs.
#### Values reset after update
Compare your old file with the new default file.
Merge changes carefully.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://vortexstudio-1.gitbook.io/vortexstudio-docs/vxkoth/configuration.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.