Skip to content

Documentation TODO

Planned documentation topics to investigate and write.

Events

  • [x] Block Break/Place - Prevent/allow breaking, custom drops, building restrictions
  • [x] Player Chat - Chat formatting, filtering, channels, muting (let's focus less on channels and proximity chat and this kind of thing, more on adding prefixes/ranks to specific users)
  • [x] Entity Spawn - Control mob spawning, custom spawners (note: let's also include straight up disabling entity spawning)
  • [ ] ⬆️ Player Movement/Teleport - Regions, boundaries, teleportation
  • [ ] Projectile Hit - Arrow damage, custom projectiles
  • [ ] Item Pickup/Drop - Loot, item restrictions
  • [ ] ⬆️ Container Interact - Chest protection, custom GUIs
  • [ ] ⬆️ Player Interact - Right-click actions, custom item uses
  • [ ] ⬆️⬆️ Combat Start/End - Combat tagging, PvP zones

Systems

  • [ ] ⬆️⬆️ Custom Commands - Creating /commands with arguments
  • [ ] ⬆️ Permissions - Checking player permissions
  • [ ] ⬆️ Scheduled Tasks - Timers, delayed execution, repeating tasks
  • [ ] ⬆️ Data Persistence - Saving custom player/world data
  • [ ] Particles & Effects - Spawning particles, visual effects
  • [ ] Sound Effects - Playing sounds to players
  • [ ] ⬆️ Messages & UI - Action bar, titles, chat formatting
  • [ ] ⬆️ Teams/Scoreboards - Player groups, score tracking
  • [ ] NPCs - Creating and controlling NPCs
  • [ ] ⬆️⬆️ World Management - Loading worlds, world settings

Common Patterns

  • [ ] ⬆️ Game State Machine - For minigames (lobby → game → end)
  • [ ] ⬆️️ Cooldowns - Preventing action spam
  • [ ] Regions/Zones - Area-based logic

Unofficial documentation · Any questions? Found a mistake? Have something you want documented? Join the Discord server at the top and let us know in #hytale!