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

# Installation

Get rayn\_simcards running.

{% stepper %}
{% step %}

#### Add the resource

Put the `rayn_simcards` folder in your `resources` folder and start it **after** oxmysql, your inventory and lb-phone:

```
ensure oxmysql
ensure ox_inventory
ensure lb-phone
ensure rayn_simcards
```

{% endstep %}

{% step %}

#### Add the SIM card item

In `ox_inventory/data/items.lua`:

```lua
['sim_card'] = {
    label = 'SIM card',
    weight = 10,
    stack = false,
    close = true,
    description = 'A SIM card for your phone',
    server = { export = 'rayn_simcards.useSimCard' },
},
```

Copy `INSTALL/sim_card.png` to `ox_inventory/web/images/`.
{% endstep %}

{% step %}

#### Add the Eject SIM button

Find your **existing** `['phone']` entry in the same file and only add the `buttons` field – keep everything else:

```lua
['phone'] = {
    -- your existing fields stay as they are
    buttons = {
        {
            label = 'Eject SIM',
            action = function(slot)
                exports.rayn_simcards:ejectSimFromSlot(slot)
            end
        },
    },
},
```

{% hint style="warning" %}
Check the closing braces after pasting – a missing `}` stops ox\_inventory from loading the item file.
{% endhint %}
{% endstep %}

{% step %}

#### Patch lb-phone

1. Paste `INSTALL/lb-phone/functions_patch.lua` at the **end** of `lb-phone/client/custom/functions/functions.lua`. It exports lb-phone's internal `SetPhone` function.
2. Back up and replace these two files with the ones from `INSTALL/lb-phone`:
   * `lb-phone/client/custom/uniquePhones/ox_inventory.lua`
   * `lb-phone/server/custom/uniquePhones/ox_inventory.lua`

Every change in them is marked with `[rayn_simcards]`: an empty phone no longer generates a number, it shows *No SIM card* instead.
{% endstep %}

{% step %}

#### Check the lb-phone config

```lua
Config.Item.Unique = true
Config.Item.Inventory = "ox_inventory"
```

{% endstep %}

{% step %}

#### Configure and restart

Set `Config.Vendor.Coords` and make `Config.LBPhone.NumberPrefixes` / `NumberLength` match `Config.PhoneNumber` in lb-phone. Restart the server.

The database tables are created on the first start. `INSTALL/rayn_simcards.sql` is included if you prefer to import them yourself.
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://rayn-scripts.gitbook.io/rayn-scripts-docs/rayn_simcards/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.