Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 2.32 KB

README.md

File metadata and controls

30 lines (23 loc) · 2.32 KB
Raw

testplugins.com helpch.at/discord BFH BFH is a simple plugin that allows you to configure commands that will be ran on a player, if they join with a specific host name. For example, if your server had two creative worlds, you could create a configuration for creative1.example.com and creative2.example.com, to join the player to the correct world. Or perhaps, send them a message if they join with a specific url.

Configuration
The config will generate on first start, in a folder called BukkitForcedHosts, called hosts.yml. Inside, the format is extremely simple.

config-version: 1
example-com:
  hooks:
    - "authme"
  commands:
    - "tellraw %s {\"text\":\"Hello\"}"

config-version is purely metadata for the plugin. Do not modify this manually.

example-com is your domain, the dash, automatically gets replaced with a . at runtime. The reason it doesn't use periods in the config, is because . is the path separator in bukkit.

The hooks key accepts a list of hooks you want enabled on your domain. Currently, the only available hook is authme. If you don't want any hooks, completely remove the hooks section from the domain. The authme hook will delay the domain's command execution till a login has been successful through authme for that user. If the hook is enabled but authme isn't on the server, any user who joins with the domain will be kicked immediately.

The commands key accepts a list of strings, i.e. your commands. In each, %s will be replaced with the player name. If you use the player name more than once, instead reference it via %1$s after the first occurrence. For example: tellraw %s {\"text\":\"Hello %1$s\"}

Commands
Only one command in BFH - /bfh reload. The permission for this is bukkitforcedhosts.reload.

CI: https://ci.piggypiglet.me/job/BukkitForcedHosts Jenkins
NOTE: File size is due to this plugin's usage of RPF, a framework you should definitely check out if you're a developer.