Libraries and base resources the scripts rely on.
Ce dossier contient 8 scripts. Choisis un script dans les onglets ci-dessous.
Free (included in JRS Core) PolyZone
Define zones of different shapes and test whether a point is inside or outside of the zone
| Resource | PolyZone |
| Folder | [DEPENDENCIES] |
| Version | 2.6.1-RedM |
| Interface | No |
| Code size | 2,017 Lua lines |
Commands
/pzadd/pzcancel/pzcomboinfo/pzcreate/pzfinish/pzlast/pzundo
Exports
TriggerZoneEvent
Notes from the README#
# PolyZone
PolyZone is a FiveM mod to define zones of different shapes and test whether a point is inside or outside of the zone
## Download
Click [here](https://github.com/mkafrin/PolyZone/releases) to go to the releases page and download the latest release
## Using PolyZone in a Script
In order to use PolyZone in your script, you must _at least_ include PolyZone's client.lua directly in your __resource.lua or fxmanifest.lua. You can do that by
'''lua
client_scripts {
'@PolyZone/client.lua',
'your_scripts_client.lua',
}
'''
This will allow you to create PolyZones in your script, but will not import other zones, such as CircleZone, BoxZone, etc. All the other zones are extra, and re
'''lua
client_scripts {
'@PolyZone/client.lua',
'@PolyZone/BoxZone.lua',
'@PolyZone/EntityZone.lua',
'@PolyZone/CircleZone.lua',
'@PolyZone/ComboZone.lua',
'your_scripts_client.lua'
}
'''
## Documentation
For additional information on how to use PolyZone, please take a look at the [wiki](https://github.com/mkafrin/PolyZone/wiki)
## Troubleshooting and Support
For help troubleshooting issues you've encountered (that aren't in the FAQ), or to suggest new features, use the [issues page](https://github.com/mkafrin/PolyZo
## FAQ - Frequently Asked Questions
**I'm getting the error `attempt to index a nil value` when creating a zone, what's wrong?**
> Did you include all the necessary scripts in your \_\_resource.lua or fxmanifest.lua? Remember some zones require other zones, like EntityZone.lua requires Bo
**I'm getting no errors, but I can't see my zone in the right place when I turn on debug drawing**
> If you are using them, is minZ and maxZ set correctly? Or if you are using a CircleZone with useZ=true, is your center's Z value correct? If using a PolyZone,
**Is PolyZone faster than a distance check?**
(line hidden)
## License
**Please see the LICENSE file. That file will always overrule anything mentioned in the README.md or wiki**Free (included in JRS Core) httpmanager
HTTP handler library
| Resource | httpmanager |
| Folder | [DEPENDENCIES] |
| Author | jrs team |
| Interface | No |
| Code size | 1,803 Lua lines |
Exports
createHttpHandler, getUrl
Notes from the README#
# httpmanager
HTTP handler utility for FiveM and RedM. It can be used as a simple file server, or to provide easy HTTP functionality to any resource.
# Installation
1. Place in your resources directory.
2. Add `start httpmanager` to server.cfg.
# Usage
## As a standalone file server
After installing, you can place files in the `http` folder inside the `httpmanager` resource folder, and those files will be accessible at:
'''
http://[server IP]:[server port]/httpmanager/...
'''
or
'''
https://[owner]-[server ID].users.cfx.re/httpmanager/...
'''
For example, if you place a file named `test.html` in the `http` folder, it would be accessible at `http://[server IP]:[server port]/httpmanager/test.html`.
## In other resources
You can quickly add HTTP functionality to any resource using the `createHttpHandler` export:
'''lua
handler = exports.httpmanager:createHttpHandler(options)
'''
This creates a new HTTP handler that can be used with `SetHttpHandler` in a server script in the resource:
'''lua
SetHttpHandler(exports.httpmanager:createHttpHandler())
'''
`options` is a table containing configuration options for the new handler. Any unspecified options will be given their default value.
| Option | Description | Default |
(line hidden)
| `documentRoot` | The directory in the resource folder where files are served from. | `"http"` |
| `directoryIndex` | If the path points to a directory, a file with this name inside that directory will be sent. | `"index.html"` |
| `templateExtension` | File extension for files that will be automatically preprocessed as templates. | `"lsp"` |
| `authorization` | A table of usernames and passwords required to access any files or routes. | `nil` |
| `access` | A table of paths with which users can access them. | `{}` |
| `log` | Whether to log requests to a file in the resource directory. | `false` |
| `logFile` | If `log` is `true`, store the log in this file in the resource directory. | `"log.json"` |
| `errorPages` | A table of custom pages for different error codes (e.g., 404). | `{}` |
| `mimeTypes` | A table of MIME type associations for extensions, which will override any detected type. | `{}` |
| `routes` | A table of route patterns and callbacks. | `{}` |
'''lua
SetHttpHandler(exports.httpmanager:createHttpHandler {
documentRoot = "root",
directoryIndex = "index.html",
templateExtension = "html",
authorization = {
["admin"] = "$2a$11$HoxJPx5sTe4RX5qPw1OkSO.ukDdwAvGJwXtmyOE5i.1gz7EvN71.q",Paid (server only) jrs_female_body
jrs_female_body - female player ped body fix (torso meshes) + body rework textures (feet/hands)
| Resource | jrs_female_body |
| Folder | [DEPENDENCIES] |
| Version | 1.0.0 |
| Author | jrs |
| Interface | No |
| Code size | 9 lignes Lua |
Free (included in JRS Core) moonshine_interiors
Change interior_sets with the interior you want at that location https://github.com/femga/rdr3_discoveries/blob/399df3278b5101af1044f205c045648d2c8bcb38/interiors/interior_sets/README.md
| Resource | moonshine_interiors |
| Folder | [DEPENDENCIES] |
| Interface | No |
| Code size | 249 lignes Lua |
config.lua - 8 options#
General
| Setting | Default | What it does |
|---|---|---|
UseTeleports |
true |
Active ou désactive teleports (par défaut true). |
Blips |
true |
Interrupteur pour blips : true = activé, false = désactivé (par défaut true). |
Shacks |
table |
Table d'entrées shacks. Ajoute, supprime ou modifie les entrées en suivant les exemples du fichier. |
↳ lemoyne |
table |
Table d'entrées lemoyne. Ajoute, supprime ou modifie les entrées en suivant les exemples du fichier. |
↳ cattail_pond |
table |
Table d'entrées cattail pond. Ajoute, supprime ou modifie les entrées en suivant les exemples du fichier. |
↳ new_austin |
table |
Table d'entrées new austin. Ajoute, supprime ou modifie les entrées en suivant les exemples du fichier. |
↳ hanover |
table |
Table d'entrées hanover. Ajoute, supprime ou modifie les entrées en suivant les exemples du fichier. |
↳ manzanita_post |
table |
Table d'entrées manzanita post. Ajoute, supprime ou modifie les entrées en suivant les exemples du fichier. |
Notes from the README#
# moonshine_interiors
moonshine interiors for redmFree (included in JRS Core) objectloader
Distance at which entities spawn/despawn
| Resource | objectloader |
| Folder | [DEPENDENCIES] |
| Interface | No |
| Code size | 1,009 Lua lines |
Commands
/objectloader_debug
Exports
addMap, disableMap, enableMap, removeMap
config/config.lua - 3 options#
General
| Setting | Default | What it does |
|---|---|---|
SpawnDistance |
50 |
Distance at which entities spawn/despawn |
MapLoadTimeout |
10000 |
Timeout before attempting to restart a crashed map thread |
MaxEntities |
500 |
Maximum number of entities that may be spawned at the same time |
Free (included in JRS Core) oxmysql
FXServer to MySQL communication via node-mysql2
| Resource | oxmysql |
| Folder | [DEPENDENCIES] |
| Version | 2.14.1 |
| Author | Overextended |
| Depends on | /server:12913 |
| Interface | Yes (NUI) |
| Code size | 215 lignes Lua |
Notes from the README#
# oxmysql
A FiveM resource to communicate with a MySQL database using [node-mysql2](https://github.com/sidorares/node-mysql2).
## 🔗 Links
- 💾 [Download](https://github.com/overextended/oxmysql/releases/latest/download/oxmysql.zip)
- Download the latest release directly.
- 📚 [Documentation](https://overextended.dev/oxmysql)
- For installation, setup, and everything else.
- 📦 [npm](https://www.npmjs.com/package/@overextended/oxmysql)
- Use our npm package for enhanced functionality and TypeScript support.
## ✨ Features
- Support for mysql-async and ghmattimysql syntax.
- Promises / async query handling allowing for non-blocking and awaitable responses.
- Improved performance and stability compared to other options.
- Support for named and unnamed placeholders, improving performance and security.
- Support for URI connection strings and semicolon separated values.
- Improved parameter checking and error handling.
## 🧾 Logging
We have included a module for submitting error logs to [Fivemanage](https://fivemanage.com/?ref=overextended), a cloud management service tailored for game serv
## Lua Language Server
- Install [Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) to ease development with annotations, type checking, diagnostic
- See [ox_types](https://github.com/overextended/ox_types) for our Lua type definitions.Free (included in JRS Core) pma-voice
VOIP built using FiveM\
| Resource | pma-voice |
| Folder | [DEPENDENCIES] |
| Author | AvarianKnight |
| Depends on | /onesync |
| Interface | Yes (NUI) |
| Code size | 1,457 Lua lines |
Commands
/-radiotalk/cycleproximity/jrs_voicerange/setvoiceintent/vol
Exports
GetPlayersInRadioChannel, SetCallChannel, SetMumbleProperty, SetRadioChannel, SetTokoProperty, addChannelCheck, addPlayerToCall, addPlayerToRadio, clearProximityOverride, getCallVolume, getPlayersInRadioChannel, getRadioAnimState, getRadioVolume, isValidPlayer, overrideProximityCheck, overrideProximityRange, overrideRadioNameGetter, removePlayerFromCall, removePlayerFromRadio, resetProximityCheck, setAllowProximityCycleState, setCallChannel, setCallVolume, setPlayerCall, setPlayerRadio, setRadioChannel, setRadioVolume, setVoiceProperty, setVoiceState, toggleMutePlayer
Free (included in JRS Core) uiprompt
| Resource | uiprompt |
| Folder | [DEPENDENCIES] |
| Interface | No |
| Code size | 1,415 Lua lines |
Commands
/uiprompt_test
Notes from the README#
# uiprompt
Object-oriented library for UI prompts in RedM.
## features
- Simplified prompt creation with the `Uiprompt` and `UipromptGroup` classes
- Callbacks for prompt events such as `onControlJustPressed` and `onHoldModeJustCompleted`
- Automatic cleanup of prompts
## installing
1. Create a folder called `uiprompt` in your resources directory.
2. Copy `fxmanifest.lua` and `uiprompt.lua` to this folder.
3. Add `start uiprompt` to `server.cfg`.
## using
In any resources where you want to use this library, add `@uiprompt/uiprompt.lua` as a client script in `fxmanifest.lua`:
'''lua
fx_version "cerulean"
game "rdr3"
rdr3_warning "I acknowledge that this is a prerelease build of RedM, and I am aware my resources *will* become incompatible once RedM ships."
client_scripts {
"@uiprompt/uiprompt.lua",
"client.lua"
}
'''
## example
'''lua
local promptGroup = UipromptGroup:new("Test")
local prompt1 = Uiprompt:new(`INPUT_DYNAMIC_SCENARIO`, "Test 1", promptGroup)
prompt1:setHoldMode(true)
local prompt2 = Uiprompt:new(`INPUT_RELOAD`, "Test 2", promptGroup)
prompt2:setHoldMode(true)
promptGroup:setOnHoldModeJustCompleted(function(group, prompt)
TriggerEvent("chat:addMessage", {args={"You held " .. prompt:getText() .. "!"}})
end)
UipromptManager:startEventThread()
'''
Further documentation and code examples are provided here: https://kibook.github.io/redm-uiprompt