https://github.com/blnstudio/bln_3d_waypoint
A sleek and performant waypoint indicator system that shows a dynamic 3D marker pointing to your destination.
https://github.com/blnstudio/bln_3d_waypoint
Last synced: over 1 year ago
JSON representation
A sleek and performant waypoint indicator system that shows a dynamic 3D marker pointing to your destination.
- Host: GitHub
- URL: https://github.com/blnstudio/bln_3d_waypoint
- Owner: blnStudio
- License: agpl-3.0
- Created: 2024-11-15T00:19:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-07T15:03:04.000Z (over 1 year ago)
- Last Synced: 2025-01-28T16:15:50.296Z (over 1 year ago)
- Language: Lua
- Homepage: https://github.com/blnStudio/bln_3d_waypoint
- Size: 12.9 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 3D Waypoint Indicator for RedM 🎯
A sleek and performant waypoint indicator system that shows a dynamic 3D marker pointing to your destination.
## Features ⭐
- Real-time 3D position tracking 🎮
- Dynamic distance indicator 📏
- Automatic waypoint detection 🗺️
- Custom destination support via exports 🔧
- Toggle command for player preference ⚡
- Configurable blip styles and colors 🎨
- Performance optimized 🚀
- No external dependencies required 📦
## Preview
[Video Preview](https://youtu.be/OyLcVwynbtI)
## Installation 🛠️
1. Download the resource
2. Place it in your resources folder
3. Add `ensure bln_3d_waypoint` to your `cfg` file
## Usage 🎯
### Basic Usage
1. Open your map
2. Set a waypoint anywhere
3. The 3D indicator will automatically appear and guide you!
### Commands
- `/togglewaypoint` - Enable/disable the waypoint indicator
### For Developers
```lua
-- Set custom destination with custom blip and color
exports['bln_3d_waypoint']:SetCustomDestination({
x = 123.4,
y = 567.8,
z = 90.0 -- optional
}, "blip_name", {255, 0, 0})
-- Remove custom destination
exports['bln_3d_waypoint']:RemoveCustomDestination()
-- or using events
TriggerEvent('waypointIndicator:setDestination', coords, blipName, blipColor)
TriggerEvent('waypointIndicator:removeDestination')
```
## Performance 📈
- Optimized native draws
- Ground Z coordinate caching
- Smart update cycles
- Minimal resource usage
- Smooth real-time tracking
## Support 💬
Need help? Join our Discord server:
[Join Discord](https://discord.com/invite/MEZRYQVpnt)
## Credits 🙏
Created by [BLN Studio](https://bln.tebex.io)
Feel free to contribute to this project! ⭐