Fazbear's Hunt Wiki
Welcome to the technical documentation for the Fazbear's Hunt gamemode for Garry's Mod.
This wiki is a reference for developers who want to create modifications, extensions, and custom animatronics for the gamemode.
For beginners
If this is your first time here — start with the About the gamemode section, then proceed to Getting started.
Where to start
To get started confidently, you need at least basic programming skills and a moderate understanding of GLua structure.
If you are a beginner and want to make a simple modification (e.g., add a third-party Pill Pack from the Steam Workshop), read the First modification section.
Documentation sections
📖 Guide
Introduction to the gamemode, setting up a development environment, first modification.
🎮 Gameplay systems
Documentation for Fazbear's Hunt core mechanics.
- Rounds — creating custom round types
- Gifts — custom positive and negative effects
- Highlights — seeing players through walls
- Statistics — custom round metrics
📚 API reference
Complete technical reference for all functions and methods.
- PlayerMeta — Player meta-table extensions
- FH Functions — global gamemode functions
- Animatronics — managing animatronic lists
- Round types — built-in and custom
🔧 Hooks
All gamemode hooks with usage examples.
- Hooks overview — how to use hooks
- Round hooks — round start, end
- Animatronic hooks — screamers, Taser
- Animatronic abilities — unique hooks for each
- Event hooks — Maniac Mask, etc.
Please note
Keep up with updates
If you want your modification to work stably — keep up with wiki updates after gamemode updates. Functions may change or be removed.