Skip to content

Installation

Voxen ships as a single shaded jar with no required dependencies. Libraries it needs (Kotlin, HikariCP, database drivers, broker clients) are downloaded on first start.

  • PaperMC 1.21.8+ or a fork. Folia works. Spigot does not.
  • Java 21 matching your Paper build.
  1. Download the latest Voxen-vX.X.jar from GitHub releases.
  2. Drop the jar into your server’s plugins/ folder.
  3. Start the server. Voxen creates plugins/Voxen/ with every config file.
  4. Edit the files and run /voxen reload to apply them.
  • Directoryplugins/Voxen/
    • config.yml server name, language, quick chat, item sharing, nicknames, command names
    • storage.yml SQLite or MySQL
    • integrations.yml plugin hooks and the cross-server transport
    • Directorychannels/ one file per channel
      • global.yml
      • local.yml
      • world.yml
      • staff.yml
      • party.yml
      • server.yml
    • Directorymodules/
      • mentions.yml
      • moderation.yml
      • private-messages.yml
      • party.yml
      • emotes.yml
      • minimessage-tags.yml
    • Directorymessages/ one file per language
      • en_US.yml
      • pl_PL.yml

New settings and messages are merged into your existing files on startup. Your values and your comments stay untouched. The channels/ folder is left alone entirely, so a channel you deleted stays deleted.

Plugin Enables
PlaceholderAPI %papi% in formats and the voxen expansion
MiniPlaceholders other plugins’ tags in formats and the voxen expansion
LuckPerms / Vault the <prefix>, <suffix> and <group> placeholders
DiscordSRV / EssentialsDiscord forwarding a channel to Discord
Towny / Factions / mcMMO limiting a channel to a town, faction or party

Every hook can be switched off in integrations.yml. Head to the Quick start next.