Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xFutte authored Jul 23, 2022
1 parent 37feab0 commit d04a716
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,19 @@ The resource supports a lot of customization. See everything in the [configurati
- oxmysql

## Implementation

1. Navigate to ./web and run `npm install` to install all dependencies. If you don't already have node.js you can [download it here](https://nodejs.org/en/download/).'
2. Run `npm run dev` in ./web to compile the GUI.
3. Add `exports['newsstands']:CreateJailStory(name, time)` wherever you jail a player, parsing the name of the prisoner and the time sentenced as parameters.
4. Add the newspaper.png image into your qb-inventory folder, where all the other images are located (located in the root of the repo).
5. Add following to your shared.lua file:

1. Run the attached import.sql file in the database
2. Add `exports['newsstands']:CreateJailStory(name, time)` wherever you jail a player, parsing the name of the prisoner and the time sentenced as parameters.
3. Add the newspaper.png image into your qb-inventory folder, where all the other images are located (located in the root of the repo).
4. Add following to your shared.lua file:
```lua
['newspaper'] = {['name'] = 'newspaper', ['label'] = 'Newspaper', ['weight'] = 10, ['type'] = 'item', ['image'] = 'newspaper.png', ['unique'] = false , ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Los Santos Newspaper'},
```

## Development

1. Navigate to ./web and run `npm install` to install all dependencies. If you don't already have node.js you can [download it here](https://nodejs.org/en/download/).'
2. Run `npm run dev` in ./web to compile the GUI.

:bulb: When you are done working with the resource run `npm run build` to minify and uglify the resource to decrease the resource size.

## Configuration
Expand Down

0 comments on commit d04a716

Please sign in to comment.