Installation

📥

Zero SQL Imports

mizu_guidebook auto-detects your framework and creates its database tables automatically on first start via oxmysql.

Download the Resource

Download the latest version of mizu_guidebook from your Cfx.re Portal .

Place in Your Resources Folder

Extract the folder into your server’s resources directory. A subfolder like [mizu] works fine.

⚠️

Warning

Do not rename the folder. The resource name must remain mizu_guidebook exactly - exports and NUI files depend on it.

Add to server.cfg

Start the resource after your framework and oxmysql.


ensure oxmysql
ensure es_extended
ensure mizu_guidebook

Replace es_extended with qb-core or qbx_core if that’s your setup - or omit it entirely for Standalone mode.

Database Setup

Tables are created and migrated automatically on first start via oxmysql. No manual SQL import is required.

Optional: import example_data.sql for demo content (categories, pages, help points).
A full schema reference is available in install.sql if you need it.

💡

Tip

Make sure oxmysql is running and connected before the resource starts. Watch the server console for migration messages on first boot.

Permissions (ACE)

Players can open and navigate the guide by default (builtin.everyone). The admin panel and edits require group.admin.


add_principal group.admin group.admin
# Grant a specific player admin rights:
# add_principal identifier.license:abc123 group.admin

Permission keys are defined in permissions.lua and checked via ACE first, with framework fallbacks for admin roles (QBCore: admin/god, ESX: admin/superadmin). In Standalone mode, OPEN_PAGE and NAVIGATE are auto-granted; admin permissions still require ACE configuration.

Done!

Restart your server. The resource initializes automatically:

🔍

Auto-detects

ESX, QBCore, QBox, or Standalone

🗄️

Auto-migrates

Tables created via oxmysql

⌨️

Ready to use

/guidebook or F9 keybind

Next Steps

→ Full configuration reference → See all features → Open the guidebook from your own scripts via exports