general.yml

The utility commands: /spawn, /logout, /rename and private messages.

How it plays: read the guide

Every example on this page is taken from the shipped general.yml. Changes apply with /hcf reload.

Switch

general.yml

enabled: true

Turn the whole module off if your essentials plugin already provides these commands. /settings and /cobble keep working.

/spawn

general.yml

spawn:
  enabled: true
  # Which world's spawn point /spawn uses. Leave empty for the player's current
  # world, which is what a multi-world server usually wants.
  world: ""
  # A countdown that any damage or movement cancels. /spawn must not be a way out
  # of a fight; the combat tag already refuses it, but a server running without
  # combat tags still wants this. 0 teleports immediately.
  warmup-seconds: 5

Key	As shipped	What it does
enabled	true	/spawn alone
world	empty	Whose spawn point; empty for the player's current world
warmup-seconds	5	Countdown that damage or movement cancels; 0 at once

/logout, /rename and private messages

general.yml

# /logout is a countdown for the same reason, from the other side: closing the
# client mid-fight is how a player escapes one, and the combat tag answers that by
# killing them - so a way to leave that is visibly not an escape has to exist.
# Any damage or movement cancels it. 0 disconnects immediately.
logout-seconds: 30

general.yml

# Longest name /rename accepts, so nobody writes a book into an item name.
rename-max-length: 32

general.yml

# /msg, /reply, /togglepm and /ignore. Ignore lists last for the session only:
# a stored one would be a social graph nobody would think to clear.
private-messages: true

Key	As shipped	What it does
logout-seconds	30	/logout's countdown; refused while combat-tagged
rename-max-length	32	Longest name /rename accepts
private-messages	true	/msg, /reply, /togglepm, /ignore

The whole shipped file

View it on GitHub.

general.yml

# ---------------------------------------------------------------------------
# general.yml - the utility commands
#
# Nothing here is HCF-specific. Turn the whole module off if your server already
# runs an essentials plugin that provides these - most do, and two plugins
# fighting over /spawn helps nobody.
#
# Lines "# --8<-- [start:...]" and "# --8<-- [end:...]" mark the parts the online
# documentation quotes from this file. They are comments and change nothing.
# ---------------------------------------------------------------------------
enabled: true

spawn:
  enabled: true
  # Which world's spawn point /spawn uses. Leave empty for the player's current
  # world, which is what a multi-world server usually wants.
  world: ""
  # A countdown that any damage or movement cancels. /spawn must not be a way out
  # of a fight; the combat tag already refuses it, but a server running without
  # combat tags still wants this. 0 teleports immediately.
  warmup-seconds: 5

# /logout is a countdown for the same reason, from the other side: closing the
# client mid-fight is how a player escapes one, and the combat tag answers that by
# killing them - so a way to leave that is visibly not an escape has to exist.
# Any damage or movement cancels it. 0 disconnects immediately.
logout-seconds: 30

# Longest name /rename accepts, so nobody writes a book into an item name.
rename-max-length: 32

# /msg, /reply, /togglepm and /ignore. Ignore lists last for the session only:
# a stored one would be a social graph nobody would think to clear.
private-messages: true