Skip to content

LiveMap Resource (for FiveM) #

All Contributors

This is the "backend" code for the live_map addon for FiveM that is ran on the FiveM game server. It creates a websocket server so that it can communicate to the web interface.

How to install#

Download the ZIP file. And extract the contents into resources/live_map/.

Add the following to your server.cfg file.

set socket_port 30121
set livemap_debug "warn" # "[all]" 'trace', 'debug', 'info', 'warn', 'error', 'fatal', 'off'
set blip_file "server/blips.json"
set livemap_access_control "*"
set livemap_use_nucleus true # Allow livemap to set up a secure reverseProxy using the Nucleus project

ensure live_map

To get the in-game blips to show on the interface, you will need to generate a "blips" file. This can be easily done with the in-game command blips generate (must have permission, see the offical documentation).

Configuration#

Please see the config file for the convars used by this resource.

Events#

In an effort to make the addon useful to other developers, I've created a few events that can be used to make changes to the data being sent to the UI.

Please see the events page for more information.

Contributors ✨#

Thanks goes to these wonderful people (emoji key):


Jordan Dalton

💻 🐛 🤔 📖

AciD

🐛

David Wheatley

🐛

KjayCopper

⚠️

jiynn

🐛

mbergwall2222

🐛

Jasen Samuels

🐛

Avery Johnson

💻

Tom

💻

matsn0w

🐛 💻

This project follows the all-contributors specification. Contributions of any kind welcome!