starred/jim-boarding-jimathy
1
0
Fork 0
mirror of https://github.com/jimathy/jim-boarding.git synced 2026-03-31 06:33:43 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jim Shield
2025-07-24 22:49:39 +01:00
parent 00f747e88e
commit fe04d4dadb
1 changed files with 6 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
README.md
View File

@@ -1,7 +1,5 @@
# Jim-Boarding
## - [Our Documentation](https://jixelpatterns.gitbook.io/docs)
## What is it?
Jim-Boarding is a script completely remade from, but based on rd_cars.
@@ -27,76 +25,11 @@ This is based originally on "ElectricSkateboardFiveM" but completely rewritten a
With the help of `jim_bridge` this also brings more optimization and more features and works on multiple frameworks
```
## How to install:
1. Install `jim_bridge` from github and add it before this script in your server load order
2. Place the folder `jim-skateboard` in your resources folder
3. Add `start jim-skateboard` in your `server.cfg`
# Installation and Previews:
## [JixelPatterns GitBook Documentation](https://jixelpatterns.gitbook.io/docs)
### QB:
4. Add the items to your `[qb]/qb-core/shared/items.lua`:
```lua
skateboard_01 = { name = "skateboard_01", label = "Skateboard", weight = 100, type = "item", image = "skateboard_01.png", unique = true, useable = true, shouldClose = true, combinable = nil, description = "Skateboard"},
### If you need support I have a discord server available, it helps me keep track of issues and give better support.
## [JixelPatterns Discord](https://discord.gg/9pCDHmjYwd)
surfboard_01 = { name = "surfboard_01", label = "Surfboard", weight = 100, type = "item", image = "surfboard_01.png", unique = true, useable = true, shouldClose = true, combinable = nil, description = "Surfboard"},
surfboard_02 = { name = "surfboard_02", label = "Surfboard", weight = 100, type = "item", image = "surfboard_02.png", unique = true, useable = true, shouldClose = true, combinable = nil, description = "Surfboard"},
surfboard_03 = { name = "surfboard_03", label = "Surfboard", weight = 100, type = "item", image = "surfboard_03.png", unique = true, useable = true, shouldClose = true, combinable = nil, description = "Surfboard"},
surfboard_04 = { name = "surfboard_04", label = "Surfboard", weight = 100, type = "item", image = "surfboard_04.png", unique = true, useable = true, shouldClose = true, combinable = nil, description = "Surfboard"},
surfboard_05 = { name = "surfboard_05", label = "Surfboard", weight = 100, type = "item", image = "surfboard_05.png", unique = true, useable = true, shouldClose = true, combinable = nil, description = "Surfboard"},
```
4. Add the images from `_install/images` to your inventory eg. `[qb]/qb-inventory/html/images`
### OX:
4. Add the items to your `[ox]/ox_inventory/data/items.lua`:
```lua
["skateboard_01"] = { label = "Skateboard", weight = 500, stack = false, close = true, description = "Skateboard",
client = { image = "skateboard_01.png", event = "jim-boarding:Skateboard:PickPlace" },
buttons = {
{ label = "Show Board",
action = function()
TriggerEvent('jim-boarding:client:showoff', { item = "skateboard_01", skip = true })
end,
}
}
},
["surfboard_01"] = { label = "Surfboard", weight = 500, stack = false, close = true, description = "",
client = { image = "surfboard_01.png", event = "jim-boarding:Surfboard:PickPlace" },
},
["surfboard_02"] = { label = "Surfboard", weight = 500, stack = false, close = true, description = "",
client = { image = "surfboard_02.png", event = "jim-boarding:Surfboard:PickPlace" },
},
["surfboard_03"] = { label = "Surfboard", weight = 500, stack = false, close = true, description = "",
client = { image = "surfboard_03.png", event = "jim-boarding:Surfboard:PickPlace" },
},
["surfboard_04"] = { label = "Surfboard", weight = 500, stack = false, close = true, description = "",
client = { image = "surfboard_04.png", event = "jim-boarding:Surfboard:PickPlace" },
},
["surfboard_05"] = { label = "Surfboard", weight = 500, stack = false, close = true, description = "Surf Rescue",
client = { image = "surfboard_05.png", event = "jim-boarding:Surfboard:PickPlace" },
},
```
4. Add the images from `_install/images` to your inventory eg. `[ox]/ox_inventory/web/images`
5. Start your server
## How to use:
```
- Use the board in your inventory to place on the ground
- Target the board and choose "Get on"
- When you want to get off the skateboard press "G"
- Target the board again and choose "Pick up" to pick it up again
- Press the arrows to move the skateboard
- Use "Spacebar" to do tricks, either press or hold down space
```
## How to add new skateboards/surfboards
```
- You would need to add the items to yoyr inventory
- Make an image or just use skateboard_01 until then
- You would need a model hash/name and place it in the table config of this script
- When placing the board, the model is spawned and detected using that table
- Done
```
### This script uses a base of the script rdrp_rccars by qalle:
https://forum.fivem.net/t/release-rc-car-script/525015
### If you think I did a good job here, consider donating as it keeps by lights on and my cat round:
## [JixelPatterns Kofi](https://ko-fi.com/jixelpatterns)