Skip to content

Commit 959eb8c

Browse files
committed
feat(vzn-execution): add docs for this script
1 parent df81034 commit 959eb8c

7 files changed

Lines changed: 144 additions & 1 deletion

File tree

pages/_meta.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ export default {
66
"vzn-notify": "VZN Notify",
77
"vzn-cleanerjob": "VZN Cleanerjob",
88
"vzn-references": "VZN References",
9+
"vzn-execution": "VZN Execution",
910
};

pages/vzn-cleanerjob/config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To Configure logs go to `config/config_server.lua` and put here your discord web
1010

1111
- if you want to edit logs logic go to `server/editable/functions.lua` on function called `SendLog`
1212

13-
```lua filename="config/config.lua"
13+
```lua filename="config/config_server.lua"
1414
-- your wehbhook where logs will be sent
1515
---@type string
1616
SConfig.LogWebhook = "your_webhook_here"

pages/vzn-execution.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
import { Steps } from "nextra/components";
2+
3+
# VZN-EXECUTION
4+
5+
Advanced script to do execution on electric chair for player. **This script is removing player character!!**
6+
7+
<iframe
8+
className="aspect-video w-full"
9+
src={"https://www.youtube.com/embed/@TODO"}
10+
title="VZN Execution preview"
11+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
12+
></iframe>
13+
14+
[PURCHASE](https://vzn-scripts.tebex.io/package/@TODO)
15+
16+
## Requirements
17+
18+
- Onesync (infinity/legacy)
19+
- ox_lib
20+
- ox_target (optional)
21+
- [Wuja Death Room](https://wuja-maps.tebex.io/package/6312401)
22+
23+
## Installation
24+
25+
<Steps>
26+
### Download the newest version from [Keymaster](https://keymaster.fivem.net/asset-grants)
27+
28+
### Put vzn-execution in your server resources folder
29+
30+
### Add `ensure vzn-execution` to your server.cfg
31+
32+
### If you are running on ESX -> [ESX Integration](./vzn-execution/integration/esx.mdx)
33+
34+
</Steps>
35+
36+
## Compatibility
37+
38+
- [esx](https://github.com/esx-framework/esx_core) (only with the newest esx_multicharacter)
39+
- [qb-core](https://github.com/qbcore-framework/qb-core)
40+
- Or you can integrate this script with your framework if you can

pages/vzn-execution/_meta.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
export default {
2+
config: "Configuration",
3+
integration: "Integration",
4+
};

pages/vzn-execution/config.mdx

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Config
2+
3+
### LOCALES
4+
5+
- This script is using ox_lib locales. You can edit values in `locales/*.json`. If you add your language, you can send it us in our discord and we will add it to our script.
6+
7+
### LOGS
8+
9+
To Configure logs go to `s_config.lua` and put here your discord webhook
10+
11+
- if you want to edit logs logic go to `server/editable/editable_logs.lua` on function called `sendLog`
12+
13+
```lua filename="s_config.lua"
14+
--- your webhook logs
15+
---@type string
16+
SConfig.Webhook = 'your_webhook_here'
17+
```
18+
19+
### INTERACTIONS
20+
21+
- This script has implemented 2 interactions system.
22+
- Prompt - Default GTA system, the notification in left corner to press `E`
23+
- ox_target - Third-eye targeting system
24+
- You can switch beetwen them in `config.lua` in field called `Config.Interaction`
25+
26+
```lua filename="config.lua"
27+
--- defining which system will be used to interact with locations
28+
---@type 'ox_target' | 'prompt'
29+
Config.Interaction = 'ox_target'
30+
```
31+
32+
### KILL CONFIRMATION
33+
34+
- Every time when some player wants another player to seat on electric chair, another player would be asked of confirmation to do that. If you wanna to disable it and allows players to force other to be killed you can do it in `config.lua` and set field called `Config.NeedConfirmationToKill` to `false`
35+
36+
```lua filename="config.lua"
37+
---@type boolean
38+
Config.NeedConfirmationToKill = true
39+
```
40+
41+
### LOCATIONS
42+
43+
The script has pre-configured electric chair from [Wuja Death Room](https://wuja-maps.tebex.io/package/6312401). All locations is configurable in `config.lua` in array field called `Config.Locations`. You can add more locations with electric chairs
44+
45+
```lua filename="config.lua"
46+
---@type Location[]
47+
Config.Locations = {
48+
--// NOTE: That script requires wuja_death_room (PURCHASE: https://wuja-maps.tebex.io/package/6312401)
49+
{
50+
chair = {
51+
coords = vec3(1997.16, -1471.64, 48.19),
52+
seatCoords = vec4(1997.16, -1471.64, 47.1330, 326.1991)
53+
},
54+
enableElectric = {
55+
coords = vec3(1999.3041, -1474.8317, 49.0260),
56+
animCoords = vec4(1999.6069, -1474.5575, 47.5919, 147.2450)
57+
}
58+
},
59+
}
60+
```
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import { Callout } from "nextra/components";
2+
3+
# INTEGRATION
4+
5+
### AUTO-DETECTION
6+
7+
<Callout type="info" emoji="ℹ️">
8+
The framework is auto-detected based on started resource. You can look at it
9+
`server/editable/editable_character.lua`
10+
</Callout>
11+
12+
The script will be automatically works on QB-Core
13+
14+
### Custom Multicharacters
15+
16+
If you are using custom multicharacters you will need probably custom integration with them. You can do it in `server/editable/editable_character.lua` in function called `DeleteCharacter`.
17+
18+
### Custom Framework
19+
20+
If you are using custom framework or edited one go to `server/editable/editable_character.lua` to function called `DeleteCharacter` and implement your deleting character logic.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import { Steps } from "nextra/components";
2+
3+
# ESX INTEGRATION
4+
5+
To allow this script deleting player character do steps below!
6+
7+
<Steps>
8+
### Make sure you are using the multicharacter system in ESX and you have the newest version of `esx_multicharacter`
9+
### Go to `esx_multicharacter/server/modules/database.lua`
10+
### Add this lines
11+
12+
```lua
13+
exports('deleteCharacter', function(source, charid)
14+
return Database:DeleteCharacter(source, charid)
15+
end)
16+
```
17+
18+
</Steps>

0 commit comments

Comments
 (0)