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

# APEX Immigration Tablet

> Character approval gate with routing-bucket isolation.

A character-approval / immigration gate for serious roleplay servers. Unapproved players sit in their own routing bucket with weapons stripped and controls disabled, until a staff member uses the in-game tablet to approve them. Optional screenshot and anti-cheat lookup per applicant.

## Features

* Isolated routing bucket — unapproved players never see the live world
* Staff tablet UI listing nearby applicants with approved / pending status
* Per-player detail panel — first/last name, birth year, join date, status
* Optional live screenshot via `screenshot-basic`
* Optional anti-cheat lookup — built-in Analystic API adapter or plug your own
* Doorman bell — applicant rings, staff get a configurable alert + sound
* Optional bridge polygon zone — auto-bucket on first crossing
* Onboarding hint texts — fade-in/out at landmark positions
* Automatic SQL table creation

## Requirements

<CardGroup cols={2}>
  <Card title="Required" icon="circle-check">
    `es_extended`, `ox_lib`, `oxmysql`
  </Card>

  <Card title="Optional" icon="puzzle-piece">
    `screenshot-basic` — only needed if `EnableScreenshotBasic = true`
  </Card>
</CardGroup>

## Configuration

```lua config.lua theme={null}
Config.Dimension          = 420
Config.ImmigrationJob     = 'immigration'
Config.AllowedGroups      = { 'admin', 'projektleitung', 'founder', 'frakverwaltung' }
Config.SpawnPosition      = vector4(-1037.76, -2736.6, 20.17, 0.0)
Config.NearbyPlayerRadius = 15.0
Config.BellEnabled        = true
Config.BellCooldownMs     = 60000
Config.EnableAnalysticApi = false
```

Default positions ship pre-placed on LSIA North concrete pad. State bags `isImmigrated` and `playerMeta` are exposed for other resources. Commands: `/immig_in`, `/immig_out` (staff-only).

## Hooks

See [Hooks reference / Immigration Tablet](/hooks/apex-immigration-tablet). Key hooks: `Hooks.HasPermission`, `Hooks.GetPlayerBirthyear`, `Hooks.ParseCharacterName`, `Hooks.OnBellNotify`, `Hooks.OnAuditLog`.

## Resource info

<Note>
  Code accessible: `config.lua`, `hooks.lua`, `locales/*`, `html/*`. Approximately 2000 lines of Lua + NUI. English + German.
</Note>