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

# INSTALL

## Requirements

| Resource                                                               | Required                   |
| ---------------------------------------------------------------------- | -------------------------- |
| [es\_extended](https://github.com/esx-framework/esx_core)              | Yes                        |
| [oxmysql](https://github.com/overextended/oxmysql)                     | Yes                        |
| [ox\_lib](https://github.com/overextended/ox_lib)                      | Yes                        |
| [ox\_target](https://github.com/overextended/ox_target)                | Yes                        |
| [esx\_addonaccount](https://github.com/esx-framework/esx_addonaccount) | Yes (society accounts)     |
| esx\_billing                                                           | Optional (Bills module)    |
| Badger\_Discord\_API                                                   | Optional (Discord avatars) |

## Steps

{% stepper %}
{% step %}

## Place the resource

Place the `shr-banksystem` folder in your server's `resources` directory.
{% endstep %}

{% step %}

## Import the database schema

```bash
# Run sql/install.sql in your MySQL/MariaDB database
```

Tables are also created automatically on first resource start. The SQL file is still recommended for clean installs and permissions.
{% endstep %}

{% step %}

## Add dependencies to `server.cfg`

Add dependencies and the resource to `server.cfg` **in this order**:

```cfg
ensure oxmysql
ensure ox_lib
ensure ox_target
ensure esx_addonaccount
ensure shr-banksystem
```

{% endstep %}

{% step %}

## Edit `config.lua`

At minimum set `Config.Locale`, enable the modules you need, and configure society jobs if used. See [CONFIG.md](broken://pages/33903af5e6e248a768001c2424ed2f75f6475b74).
{% endstep %}

{% step %}

## Restart the server

Restart the server (or `ensure shr-banksystem`).
{% endstep %}
{% endstepper %}

## Verify

* Walk to a Fleeca bank location and open the UI via ox\_target / drawtext.
* Issue a card in the **Card** section and set a PIN.
* Use an ATM model from `Config.ATMModels` to test ATM mode.

## Troubleshooting

| Issue                | Check                                                           |
| -------------------- | --------------------------------------------------------------- |
| UI does not open     | `ox_target` running, player near bank/ATM, account not blocked  |
| Society tab empty    | `Config.SocietyJobs` matches your ESX jobs and grades           |
| Bills not showing    | `Config.Modules.Bills = true` and `esx_billing` installed       |
| No avatar            | Set `Config.UseBadgerDiscordAPI` or add `Config.SteamWebApiKey` |
| Society logs missing | `Config.Society.Logs.Enabled` and bossmenu table configured     |