> For the complete documentation index, see [llms.txt](https://nayzeee-dev.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nayzeee-dev.gitbook.io/docs/nayzeee-scripts/nayzeee-reports/installation.md).

# Installation

1. **Extract Files**\
   \&#xNAN;*Extract the `nayzeee-reports` folder into your server resources directory.*

   Place inside:

   ```
   resources/[your-resources]/nayzeee-reports
   ```
2. **Configure Staff Ranks**\
   \&#xNAN;*Edit staff permission ranks inside `config.lua`.*

   ```lua
   Config.StaffRanks = {
       { id = 'mod', label = 'Moderator', color = '#58a6ff' },
       { id = 'admin', label = 'Admin', color = '#a371f7' },
   }
   ```
3. **Configure Categories**\
   \&#xNAN;*Edit report categories inside `config.lua`.*

   ```lua
   Config.Categories = {
       { id = 'question', label = 'Question', icon = 'fa-question' },
       { id = 'bug', label = 'Bug Report', icon = 'fa-bug' },
       { id = 'player', label = 'Player Report', icon = 'fa-user' },
   }
   ```
4. **Add to server.cfg**\
   \&#xNAN;*Ensure the resource is started after dependencies.*

   ```cfg
   ensure nayzeee-reports
   ```

***

#### Troubleshooting

| Issue                | Solution                          |
| -------------------- | --------------------------------- |
| Can't see reports    | Verify staff rank configuration   |
| Reports not saving   | Enable database support in config |
| Webhooks not working | Verify webhook URL is valid       |