About the gamemode
Fazbear's Hunt is a custom gamemode for Garry's Mod, inspired by the Five Nights at Freddy's universe. Players are divided into two teams: Survivors and Animatronics. Animatronics hunt survivors using unique abilities.
Who this wiki is for
This wiki is technical documentation for developers. It will be useful for you if you:
- Want to create your own animatronics
- Are making a modification that changes round rules
- Want to add your own gift effects
- Want to intercept events via hooks
- Simply want to understand the gamemode's source code
There is separate player-oriented documentation for regular players; this one is about code.
Prerequisites
Before diving in, you should have at least basic programming skills and a moderate understanding of GLua structure.
Useful resources:
- Official GMod Wiki — primary GLua reference
- GMod Lua tutorial — introduction for beginners
- Player API — base player class
Wiki structure
| Section | Description |
|---|---|
| Guide | Step-by-step guides, from setup to your first modification |
| Gameplay | Documentation for gameplay systems: rounds, gifts, highlights |
| Reference | Complete API: functions, methods, meta-tables |
| Hooks | All gamemode hooks with usage examples |
Next step
Go to the Getting started → section to set up your environment.