> ## Documentation Index
> Fetch the complete documentation index at: https://docs.humalike.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Public reference

> Index of stable convars, commands, exports, events, providers, and actions.

This page is a compact index. Follow the linked guides for callback contracts,
examples, and operational guidance.

## Convars

| Area              | Public settings                                                                                                                                                                 |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Required          | `humalike_license_key`                                                                                                                                                          |
| Diagnostics       | `humalike_debug`                                                                                                                                                                |
| Providers         | `humalike_player`, `humalike_inventory`, `humalike_dispatch`, `humalike_actions`, `humalike_interaction`                                                                        |
| Labels            | `humalike_npc_labels_*`                                                                                                                                                         |
| Medical gameplay  | `humalike_npc_wounded_*`, `humalike_npc_death_chance`, `humalike_npc_revive_*`, `humalike_npc_mortuary_*`, `humalike_npc_treatment_distance`, `humalike_npc_deceased_retention` |
| Jobs and dispatch | `humalike_npc_medic_jobs`, `humalike_npc_police_jobs`, `humalike_npc_medical_dispatch*`                                                                                         |
| Wounds            | `humalike_npc_wounds_enabled`, `humalike_npc_wound_*`, `humalike_npc_max_wounds`                                                                                                |
| Poses             | `humalike_npc_pose_abandon_*`, `humalike_npc_pose_threat_*`                                                                                                                     |
| World tuning      | `humalike_world_*` listed in [Configuration](/ai-npc/configuration#advanced-world-tuning)                                                                                       |

Undocumented endpoint, runtime-secret, and authority convars are not a supported
customer interface.

## Commands

| Side          | Command              | Purpose                              |
| ------------- | -------------------- | ------------------------------------ |
| Server        | `humalike_status`    | Runtime and provider status.         |
| Client        | `humalike_status`    | Interaction provider status.         |
| Server/player | `humalikenpc:status` | NPC roster status.                   |
| Server/player | `humalikenpc:reload` | Request an immediate roster refresh. |
| Client        | `/voice`             | Local voice connection status.       |

Developer-only ambient spawn tools are disabled by default. To use them on a
non-production test server, set `humalike_developer_tools 1` and grant the ACE
`humalike.developer_tools`. The command is:

```text theme={null}
/humalike_dev ambient <spawn|goto|remove|list> [npc_uuid]
```

Debug spawns are temporary and are not a replacement for dashboard-managed NPC
placement.

## Server exports

```lua theme={null}
exports.humalike:RegisterProvider(domain, descriptor)
exports.humalike:UnregisterProvider(domain, name)
exports.humalike:GetProviderStatus()
exports.humalike:ReportPlayerEvent(playerId, event)
```

See [Provider API](/ai-npc/integrations/provider-api) and
[Report player events](/ai-npc/integrations/world-events).

## Client exports

```lua theme={null}
exports.humalike:RegisterInteractionProvider(descriptor)
exports.humalike:UnregisterInteractionProvider(name)
exports.humalike:GetInteractionProviderStatus()
```

## Events

| Side              | Event                                | Payload                        |
| ----------------- | ------------------------------------ | ------------------------------ |
| Server and client | `humalike:integration:ready`         | `{ apiVersion, runtimeEpoch }` |
| Client            | `humalike:voice:transmittingChanged` | `active: boolean`              |

## Built-in provider names

* Player: `standalone`, `esx`, `qbcore`, `qbox`.
* Inventory: `esx`, `ox_inventory`, `qb_inventory`.
* Interaction: `builtin`, `ox_target`, `qb_target`.

## Built-in action keys

`wave`, `start_dancing`, `interrupt_animation`, `kneel`, `hands_up`, `punch`,
`stand_up`, `follow_player`, `stop_following`, `hold_position`,
`release_movement`, `enter_vehicle`, `exit_vehicle`, and `walk_away`.

`give_item` is added when an inventory provider is available. The selected
custom actions provider may advertise additional keys.

## Neutral player event types

`rp_action`, `identity_document_shown`, `item_dropped`, `item_picked_up`,
`police_badge_shown`, `ems_badge_shown`, `doj_badge_shown`, `hands_raised`, and
`hands_lowered`.

## Next

* [Read the complete provider contracts](/ai-npc/integrations/provider-api).
* [See event payload examples](/ai-npc/integrations/world-events).
* [Diagnose a running server](/ai-npc/operations).
