Skip to content

Commit

Permalink
feat: docs\bpt_doorlock\bpt_doorlock.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bitpredator committed Oct 10, 2023
1 parent 3c16ddb commit 87a83e8
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/bpt_doorlock/bpt_doorlock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# bpt_doorlock

Source code: https://github.com/bitpredator/bpt_doorlock

A door management resource that can be used standalone or alongside qb-core, and es_extended.

### Install all resource dependencies.
- [oxmysql](https://github.com/overextended/oxmysql/releases)
- [ox_lib](https://github.com/overextended/ox_lib/releases)

### Download a [release](https://github.com/bitpredator/bpt_doorlock/releases) or build the source code.

```bash
git clone https://github.com/bitpredator/bpt_doorlock.git
cd bpt_doorlock/web
pnpm i
pnpm build
```

## Opening the UI

If you have installed and started the resource, you can use `/doorlock` to open the UI.

- If the cursor is displayed but not the UI then you have not built it.
- You may not be authorised to use the command.

- Enter `test_ace player.1 command.doorlock` in the server console (replace 1 with your server id).

## Convert doors

Door configuration files written for nui_doorlock (and its fork, qb-doorlock) can be automatically added to your MySQL database.

- Any files with the `.lua` extension placed in the `bpt_doorlock/convert` directory will be read on resource start.
- If the directory doesn't exist, you can create it.
- Conversion cannot be guaranteed, especially if the config was not written for nui_doorlock.

## Adding new native audio

A guide can be found [here](https://forum.cfx.re/t/how-to-make-a-simplesound-using-native-audio/5156001) for adding new native audio.

0 comments on commit 87a83e8

Please sign in to comment.