OPEN//77

https://open2077.net/docs
Admin
OPEN//77 is a multiplayer platform for Cyberpunk 2077 that enables community-operated dedicated...
Tokens:2,223,505
Snippets:15,639
Trust Score:3.4
Update:3 days ago
Show doc for...
Tokens:
Raw
### Open77.cyberware.install Example

Source: https://open2077.net/docs/api/server/open77-cyberware

Example usage of the install method, including revision checking and operation ID generation.

```lua
local record = Open77.cyberware.current(playerId)
if not record then return end
local operationId, err = Open77.cyberware.newOperationId()
if not operationId then print(err); return end
local result, rejected = Open77.cyberware.install(playerId, "myrp.gorilla", "training", {
 expectedRevision=record.revision,operationId=operationId
})
if not result then print(rejected) else print(result.ticket) end
```

--------------------------------

### StartResource Lua Example

Source: https://open2077.net/docs/api/server/globals

Demonstrates how to queue the start of a resource using the StartResource function within a command.

```lua
-- Start the event resource when an admin opens the event
RegisterCommand("event-open", function(source)
    local ok, reason = StartResource("summer_event")
    if not ok then Open77.chat.send(source, reason) end
end, true)
```

--------------------------------

### Client-side voice guide helper

Source: https://open2077.net/docs/guided-voice-setup

A helper script to manage the voice setup session, including starting, updating, and closing the session, with a thread to keep the session alive.

```lua
-- client.lua
VoiceGuide = { active = false, snapshot = nil, error = nil }

function VoiceGuide.begin()
    if not (Open77.voice and type(Open77.voice.setup) == 'function') then
        return nil, 'voice_setup_unavailable'
    end
    local snapshot, reason = Open77.voice.setup('begin')
    if not snapshot then
        Open77.voice.setup('end')
        return nil, reason
    end
    VoiceGuide.active = true
    VoiceGuide.snapshot, VoiceGuide.error = snapshot, nil
    return snapshot
end

function VoiceGuide.update(operation, payload)
    if not VoiceGuide.active then return nil, 'voice_setup_closed' end
    if operation ~= 'set' and operation ~= 'test' and operation ~= 'refresh'
        and operation ~= 'status' then
        return nil, 'unknown_voice_operation'
    end
    local snapshot, reason = Open77.voice.setup(operation, payload)
    VoiceGuide.error = reason
    if snapshot then VoiceGuide.snapshot = snapshot end
    return snapshot, reason
end

function VoiceGuide.close(completed)
    if not VoiceGuide.active then return true end
    local operation = completed and 'complete' or 'end'
    local ok, reason = Open77.voice.setup(operation)
    if not ok and completed then
        VoiceGuide.error = reason
        return nil, reason -- Keep the session alive so the UI can retry or skip.
    end
    VoiceGuide.active, VoiceGuide.snapshot = false, nil
    VoiceGuide.error = reason
    return ok, reason
end

CreateThread(function()
    while true do
        Wait(500)
        if VoiceGuide.active then
            local snapshot, reason = VoiceGuide.update('status')
            if not snapshot then
                VoiceGuide.close(false)
                VoiceGuide.error = reason
            end
        end
    end
end)

AddEventHandler('onClientResourceStop', function(name)
    if name == GetCurrentResourceName() then VoiceGuide.close(false) end
end)
```

--------------------------------

### ready Usage Example

Source: https://open2077.net/docs/api/server/open77-database

Demonstrates creating a database table once the connection is established.

```lua
-- Create the table once the database is reachable
Open77.database.ready(function()
    Open77.database.update.await([[
        CREATE TABLE IF NOT EXISTS players (
            identifier VARCHAR(64) PRIMARY KEY,
            money INT NOT NULL DEFAULT 500
        )
    ]])
end)
```

--------------------------------

### Get door state example

Source: https://open2077.net/docs/api/client/resource-open77-doors

Example usage of the get export within a thread.

```lua
CreateThread(function()
    local pending, error = Open77.exports.call("open77_doors", "get", id)
    if not pending then print(error); return end
    local result, reason = pending:await()
    -- Handle the result before continuing; queued is not accepted.
end)
```

--------------------------------

### Open77.http.request Example

Source: https://open2077.net/docs/api/server/open77-http

Example of posting to a Discord webhook when the server starts.

```lua
-- Post to a Discord webhook when the server starts
Open77.http.request("https://discord.com/api/webhooks/...", function(status, body, headers, err)
    if status == 0 then print("webhook failed: " .. tostring(err)) end
end, "POST", { content = "Server is up!" })
```

--------------------------------

### Startup Commands Configuration

Source: https://open2077.net/docs/resource-runtime

Example of defining startup commands in the server.jsonc file.

```jsonc
"startup": {
  "commands": [
    "weather.time.set 20:30:00",
    "weather.set lightclouds",
    "weather.random off"
  ]
}
```

--------------------------------

### Open77.chat.broadcast Example

Source: https://open2077.net/docs/api/server/open77-chat

Example of broadcasting a message to all players regarding a round start.

```lua
-- The round is starting in 30 seconds
Open77.chat.broadcast("Round starts in 30 seconds!")
```

--------------------------------

### getEntity example

Source: https://open2077.net/docs/api/server/open77-routingbuckets

Example showing how to get the routing bucket of a vehicle entity.

```lua
-- Which instance is this vehicle in?
print("vehicle bucket", Open77.routingBuckets.getEntity(vehicleEntityId))
```

--------------------------------

### Open77.runtime.commands Example

Source: https://open2077.net/docs/api/client/open77-runtime

Iterates through all registered client commands to build a help list.

```lua
-- Build a "/help" list from every client command
for _, command in ipairs(Open77.runtime.commands()) do
    print("/" .. command.name, command.help or "")
end
```

--------------------------------

### Open77.sound.stopAll example - silence everything

Source: https://open2077.net/docs/api/server/open77-sound

Example showing how to stop all sounds started by this resource.

```lua
-- The event ends: silence everything this resource started
Open77.sound.stopAll()
```

--------------------------------

### Open77.equipment.apply Example

Source: https://open2077.net/docs/api/client/open77-equipment

Example of applying a whole outfit while clearing unspecified slots.

```lua
-- Put on a whole outfit at once, clearing anything the outfit does not name
Open77.equipment.apply({
    Head = "Items.Cap_01_basic_01",
    OuterChest = false,        -- take the jacket off
}, { replace = false })
```

--------------------------------

### Get NPC attitude example

Source: https://open2077.net/docs/api/server/open77-npcs

Example of printing an NPC's default attitude.

```lua
-- Debug: print how the guard regards everyone
local attitude = Open77.npcs.getAttitude(guardId)
if attitude then print("default attitude:", attitude.default) end
```

--------------------------------

### Example: Handle menu state changes

Source: https://open2077.net/docs/api/client/open77-session

Shows how to listen for menu state changes and perform an initial check on resource startup.

```lua
AddEventHandler("open77:menuStateChanged", function(open, pause, source)
    if open == "1" then pauseLoop(source) else resumeLoop() end
end)
local now = Open77.session.menuState()
if now and now.open then pauseLoop(now.source) end
```

--------------------------------

### Get NPC snapshot example

Source: https://open2077.net/docs/api/server/open77-npcs

Example of checking an NPC's health status.

```lua
-- Is the boss still alive?
local boss = Open77.npcs.get(bossId)
if boss and boss.health <= 0 then
    Open77.chat.broadcast("The boss is down!")
end
```

--------------------------------

### Open77.database.isReady usage example

Source: https://open2077.net/docs/api/server/open77-database

An example demonstrating how to gate command execution based on the database readiness status.

```lua
-- Refuse the shop until the database answers
RegisterCommand("shop", function(source)
    local ready, reason = Open77.database.isReady()
    if not ready then return Open77.chat.send(source, "Shop unavailable: " .. reason) end
    openShop(source)
end, false)
```

--------------------------------

### Get Task Example

Source: https://open2077.net/docs/api/server/open77-npcs-tasks

Example of waiting for a movement task to complete by polling its state.

```lua
-- Wait until the walk is finished
CreateThread(function()
    local task = Open77.npcs.tasks.moveTo(npcId, door)
    while Open77.npcs.tasks.get(npcId, task) do Wait(250) end
    print("the NPC has arrived (or gave up)")
end)
```

--------------------------------

### Open77.io.copy Example

Source: https://open2077.net/docs/api/server/open77-io

Example of creating a backup file before overwriting an existing configuration.

```lua
-- Keep a backup before rewriting the config
Open77.io.copy("config.json", "config.backup.json", true)
```

--------------------------------

### Open77.io.exists Example

Source: https://open2077.net/docs/api/server/open77-io

Example of writing a default configuration file if one does not already exist.

```lua
-- First run: write a default config if there is none
if not Open77.io.exists("config.json") then
    Open77.io.writeJson("config.json", { startingMoney = 500 })
end
```

--------------------------------

### setControlLock Example

Source: https://open2077.net/docs/api/client/open77-vehicles

Example usage of setControlLock to manage vehicle inputs for a race starting grid.

```lua
-- Starting grid: freeze the inputs, then release them on GO
RegisterNetEvent("race:grid", function(vehicleId)
    Open77.vehicles.setControlLock(vehicleId, true)
end)
RegisterNetEvent("race:go", function(vehicleId)
    Open77.vehicles.setControlLock(vehicleId, false)
end)
```

--------------------------------

### VoiceGuide.close(true)

Source: https://open2077.net/docs/guided-voice-setup

Completes the voice setup session. Returns a boolean indicating success and a reason string if it fails. Should be called when the player finishes setup.

```APIDOC
## VoiceGuide.close(true)

### Description
Completes the voice setup session. Returns a boolean indicating success and a reason string if it fails. Should be called when the player finishes setup.

### Method
VoiceGuide.close

### Parameters
- **completed** (boolean) - Required - Set to true to finish the setup.

### Request Example
```lua
local completed, completionReason = VoiceGuide.close(true)
if not completed then print('Setup could not finish: ' .. tostring(completionReason)) end
```

### Response
#### Success Response
- **completed** (boolean) - Indicates if setup completed successfully.
- **completionReason** (string) - Reason for failure if setup could not finish.

#### Response Example
```lua
local completed, completionReason = VoiceGuide.close(true)
```
```

--------------------------------

### Close photo mode example

Source: https://open2077.net/docs/api/client/open77-photomode

Example showing how to close the photo mode when a round starts.

```lua
-- Leave photo mode when the round starts
RegisterNetEvent("arena:roundStarted", function()
    Open77.photoMode.close()
end)
```

--------------------------------

### Example: Using Open77.callbacks.callClient

Source: https://open2077.net/docs/api/server/open77-callbacks

Demonstrates asking a client to confirm a purchase using a promise.

```lua
-- Ask one client to confirm a purchase (alias of Open77.net.callClient)
CreateThread(function()
    local pending = Open77.callbacks.callClient(source, "confirmPurchase", "ammo_box", 50)
    local confirmed = pending and pending:await()
    if confirmed then sell(source, "ammo_box") end
end)
```

--------------------------------

### Set perspective mode example

Source: https://open2077.net/docs/api/client/open77-perspective

Example of requesting third-person perspective when a client resource starts.

```lua
-- Third person on foot when the player joins; the arbiter still decides
AddEventHandler("onClientResourceStart", function(name)
    if name == GetCurrentResourceName() then Open77.perspective.set("tps") end
end)
```

--------------------------------

### Get NPC behavior example

Source: https://open2077.net/docs/api/server/open77-npcs

Example of checking and updating an NPC's combat status.

```lua
-- Only re-enable combat if it was actually off
local behavior = Open77.npcs.getBehavior(guardId)
if behavior and not behavior.combatEnabled then
    Open77.npcs.setCombatEnabled(guardId, true)
end
```

--------------------------------

### Open77.motion.launch example

Source: https://open2077.net/docs/api/client/open77-motion

An example showing how to perform a client-side projection launch after server authorization.

```lua
-- Client projection only: invoked after the server has granted motion.
local request, reason = Open77.motion.launch(1, 1, 0, 12, 10)
if request then print(Open77.motion.state(request)) else print(reason) end
```

--------------------------------

### Open77.kvp.find Example

Source: https://open2077.net/docs/api/client/open77-kvp

Example showing how to iterate over entries matching a specific prefix.

```lua
-- List every saved radio favourite with its value
for _, entry in ipairs(Open77.kvp.find("radio:") or {}) do
    print(entry.key, entry.value, entry.type)
end
```

--------------------------------

### Get current target example

Source: https://open2077.net/docs/api/client/open77-inspector

Example showing how to retrieve and print information about the current target.

```lua
local t = Open77.inspector.target()
if t and t.valid then
    print(t.kind, t.name, t.distance)   --> door  Door  1.38
end
```

--------------------------------

### Example: Using Open77.callbacks.callClientAwait

Source: https://open2077.net/docs/api/server/open77-callbacks

Demonstrates awaiting a client response in a single line.

```lua
-- The same question, awaited in one line
CreateThread(function()
    local confirmed = Open77.callbacks.callClientAwait(source, "confirmPurchase", "ammo_box", 50)
    if confirmed then sell(source, "ammo_box") end
end)
```

--------------------------------

### Open77.weapons.setComponent example - install scope with event handler

Source: https://open2077.net/docs/api/client/open77-weapons

Example installing a short scope on the rifle in slot 1, checking the returned requestId, and handling the asynchronous completion via the open77:weapons:completed event.

```lua
-- A short scope on the rifle in slot 1; the verified outcome arrives later
local requestId, reason = Open77.weapons.setComponent(1, "Items.w_att_scope_short_01",
  { attachmentSlot = "AttachmentSlots.Scope" })
if not requestId then print("refused:", reason) end
AddEventHandler("open77:weapons:completed", function(id, operation, accepted, why)
  if tostring(id) == tostring(requestId) then print(operation, accepted, why) end
end)
```

--------------------------------

### Start workshop resources

Source: https://open2077.net/docs/rp-job-techie

Manually ensure the required resources or add them to the startup commands in server.jsonc.

```text
ensure open77_transactions
ensure open77_actions
ensure rp_techie
```

```json
"startup": {
  "commands": [
    "ensure open77_transactions",
    "ensure open77_actions",
    "ensure rp_techie"
  ]
}
```

--------------------------------

### Open77.weapons.activate Example

Source: https://open2077.net/docs/api/server/open77-weapons

Example showing how to draw a player's weapon in slot 1 when a round starts.

```lua
-- Draw the player's slot 1 when the round starts
Open77.weapons.activate(playerId, 1)
```

--------------------------------

### Open77.equipment.registry usage example

Source: https://open2077.net/docs/api/client/open77-equipment

Example showing how to save the current outfit to a KVP for restoration.

```lua
-- Save the current outfit so it can be restored after a respawn
local outfit = Open77.equipment.registry()
if outfit then SetResourceKvp("outfit", json.encode(outfit)) end
```

--------------------------------

### Open77.equipment.info usage example

Source: https://open2077.net/docs/api/client/open77-equipment

Example showing how to retrieve and print slot and gender support information for an item.

```lua
-- Show which slot an item goes into before offering it
local info = Open77.equipment.info("Items.Cap_01_basic_01")
if info then print(info.slot, info.supportsMale, info.supportsFemale) end
```

--------------------------------

### Stop entity animation example

Source: https://open2077.net/docs/api/client/open77-animations

Example usage of Open77.animations.stop to terminate an emote started on another body.

```lua
-- Stop the emote this resource started on another body
local entity = Open77.players.entity(playerId)
if entity then Open77.animations.stop(entity) end
```

--------------------------------

### Get perspective state example

Source: https://open2077.net/docs/api/client/open77-perspective

Example of checking if the perspective is allowed to determine UI element state.

```lua
-- Grey out the "toggle view" button when the server forbids it
local state = Open77.perspective.state()
toggleButton.enabled = state and state.allowed
```

--------------------------------

### Open photo mode example

Source: https://open2077.net/docs/api/client/open77-photomode

Example showing how to bind a key to open photo mode.

```lua
-- A key owned by this resource opens photo mode (the stock shortcut is disabled)
RegisterKeyMapping("photo", "Photo mode", "F8", function()
    local ok, reason = Open77.photoMode.open()
    if not ok then Open77.hud.notify("Photo mode unavailable: " .. reason) end
end)
```

--------------------------------

### Open77.resource.start example: event-open command

Source: https://open2077.net/docs/api/server/open77-resource

Queues a resource start for the next tick boundary. Requires resources.control. Returns true when queued, otherwise false and a reason. The example registers an event-open command that starts the summer_event resource.

```lua
-- Start the event resource when an admin opens the event
RegisterCommand("event-open", function()
    Open77.resource.start("summer_event")
end, true)
```

--------------------------------

### Open77.voice.setup(operation, payload?)

Source: https://open2077.net/docs/guided-voice-setup

Build a microphone setup step inside your server's onboarding or settings interface. It shares device selection, volumes, activation settings and the keyboard/mouse push-to-talk binding with the pause menu.

```APIDOC
## Open77.voice.setup(operation, payload?)

### Description
Build a microphone setup step inside your server's onboarding or settings interface. It shares device selection, volumes, activation settings and the keyboard/mouse push-to-talk binding with the pause menu.

### Method
Function call

### Endpoint
Open77.voice.setup(operation, payload?)

### Parameters
- **operation** (string) - Required - The operation to perform on the setup session.
- **payload** (table) - Optional - Additional data for the operation.

### Request Example
```lua
Open77.voice.setup("open", { ... })
```

### Response
Returns a snapshot or result depending on the operation.

### Errors and fallback
Refer to the source documentation for error handling details.
```

--------------------------------

### setFrozen Example

Source: https://open2077.net/docs/api/client/open77-vehicles

Example usage of setFrozen combined with setControlLock to manage vehicle state on a race starting grid.

```lua
-- Starting grid: lock the inputs and freeze the chassis until GO
RegisterNetEvent("race:grid", function(vehicleId)
    Open77.vehicles.setControlLock(vehicleId, true)
    Open77.vehicles.setFrozen(vehicleId, true)
end)
RegisterNetEvent("race:go", function(vehicleId)
    Open77.vehicles.setFrozen(vehicleId, false)
    Open77.vehicles.setControlLock(vehicleId, false)
end)
```

--------------------------------

### Open77.http.routes Example

Source: https://open2077.net/docs/api/server/open77-http

Example of printing exposed routes at startup.

```lua
-- Print what this resource exposes at start, so the operator's log says it
for _, route in ipairs(Open77.http.routes()) do
    print('serving ' .. route)
end
```

--------------------------------

### Open77.equipment.records usage example

Source: https://open2077.net/docs/api/client/open77-equipment

Example demonstrating how to list up to 50 items in the 'Head' slot.

```lua
-- Fill the shop's hat list
for _, item in ipairs(Open77.equipment.records({ slot = "Head", limit = 50 }) or {}) do
    print(item.record)
end
```

--------------------------------

### Set Prediction Policy Example

Source: https://open2077.net/docs/api/client/open77-prediction

Example of setting a prediction policy on resource start, requiring the prediction.policy permission.

```lua
-- open77.lua: permissions { "prediction.policy" }; normally only open77_prediction does this.
AddEventHandler("onClientResourceStart", function(name)
    if name ~= GetCurrentResourceName() then return end
    local ok, reason = Open77.prediction.setPolicy({ families = { blast = false }, maxPingMs = 200 })
    if not ok then print("prediction policy refused: " .. tostring(reason)) end
end)
```

--------------------------------

### Open77.kvp.stats example - log store usage at startup

Source: https://open2077.net/docs/api/server/open77-kvp

Example usage of Open77.kvp.stats to log the store usage at startup. Checks if stats is not nil before formatting and printing the entry and byte counts.

```lua
-- Log the store usage at startup
local stats = Open77.kvp.stats()
if stats then print(("kvp: %d entries, %d bytes"):format(stats.entries, stats.bytes)) end
```

--------------------------------

### Get player stats command example

Source: https://open2077.net/docs/api/server/open77-players

Example command to display a player's health and stamina in the chat.

```lua
-- Show health and stamina together on request
RegisterCommand("stats", function(source)
    local stats = Open77.players.getStats(source)
    if stats then
        Open77.chat.send(source, ("HP %d / %d  Stamina %d / %d"):format(
            stats.health, stats.maxHealth, stats.stamina, stats.maxStamina))
    end
end, false)
```

--------------------------------

### Open77.network.catalog Usage Example

Source: https://open2077.net/docs/api/client/open77-network

Demonstrates how to refresh the catalog and read the server list after a delay.

```lua
-- The server browser reads the catalog a beat after refreshing it
CreateThread(function()
    Open77.network.refresh()
    Wait(1000)
    local catalog = Open77.network.catalog()
    for _, server in ipairs(catalog.servers or {}) do print(server.name) end
end)
```

--------------------------------

### Example: Check Time Scale

Source: https://open2077.net/docs/api/server/open77-world

Example usage of getTimeScale to defer a round start if another resource is holding the clock.

```lua
-- Refuse to start a round while another resource is still holding a beat.
local held = Open77.world.getTimeScale(ARENA_BUCKET)
if held and held.scale < 1 then
    print(("round start deferred: %s holds the clock at %.2f"):format(tostring(held.owner), held.scale))
end
```

--------------------------------

### Get wanted level command example

Source: https://open2077.net/docs/api/server/open77-players

Example command to show a player their current wanted level and maximum level.

```lua
-- /wanted: show a player their current heat
RegisterCommand("wanted", function(source)
    local wanted = Open77.players.getWanted(source)
    if wanted then
        Open77.chat.send(source, ("Wanted level %d of %d"):format(wanted.level, wanted.maxLevel))
    end
end, false)
```

--------------------------------

### Example usage of open77_doors configure

Source: https://open2077.net/docs/api/server/resource-open77-doors

Demonstrates how to call the configure export and await the resulting Promise.

```lua
CreateThread(function()
    local pending, error = Open77.exports.call("open77_doors", "configure", id, bucket, patch)
    if not pending then print(error); return end
    local result, reason = pending:await()
    -- Handle the result before continuing; queued is not accepted.
end)
```

--------------------------------

### Capabilities Example

Source: https://open2077.net/docs/api/client/open77-remotecamera

Example of retrieving and printing the system capabilities as a JSON string.

```lua
local capabilities = Open77.remoteCamera.capabilities()
print(Open77.json.encode(capabilities))
```

--------------------------------

### Get Current Perspective Example

Source: https://open2077.net/docs/api/client/open77-perspective

Example showing how to adjust UI elements, such as a crosshair, based on the current active perspective.

```lua
-- Adjust the crosshair for the view actually in force
SetTick(function()
    crosshair.big = Open77.perspective.get() == "tps"
end)
```

--------------------------------

### Open77.vehicles.releaseAdopted Example

Source: https://open2077.net/docs/api/client/open77-vehicles

Example showing how to release an adopted chassis after server acceptance.

```lua
-- The server accepted the proposal: hand the vanilla chassis back
RegisterNetEvent("garage:adopted", function(engineEntity, vehicleId)
    Open77.vehicles.releaseAdopted(engineEntity)
    Open77.hud.notify(("Vehicle #%d is yours"):format(vehicleId))
end)
```

--------------------------------

### Get Prediction Stats Example

Source: https://open2077.net/docs/api/client/open77-prediction

Example of registering a command to print current prediction statistics, including ping and per-family counters.

```lua
RegisterCommand("predstats", function()
    local stats, reason = Open77.prediction.stats()
    if not stats then print(reason); return end
    print(("ping %d ms, ceiling %d ms"):format(stats.ping, stats.maxPingMs))
    for name, family in pairs(stats.families) do
        print(name, family.enabled, family.predicted, family.adopted, family.refuted)
    end
end, false)
```
Tokens:
Raw