FiveM heavily relies on mods. We provide a few in our mod manager. At the moment, the mod manager only copies the mod files over and does not complete the additional steps required to install mods.
Note: Some mods require a MySQL database. This guide will be split into two sections, the first section are the steps required for all mods. The second section are steps required by MySQL mods. At the moment, we do not support CouchDB mods.
Installation steps for all mods
(Skip to step 4 if you installed the mod via our mod manager)
- Download the mod files. We recommend using https://forum.fivem.net/c/development/releases to find mods.
- Connect to your FTP server (FTP Guide: https://billing.low.ms/knowledgebase.php?action=displayarticle&id=11)
- Copy over the mod folder to your resources directory. The mod folder should contain a file called __resources.lua. If the mod is downloaded from Github, it may have "-master" in the folder name. You may need to rename it so it does not contain "-master" at the end.
- In the control panel (Configuration Files) or via FTP, open/edit the file citmp-server.yml. Locate the line "AutoStartResources". This is a list of all mods/plugins. There will be some there already, do not remove any of these.
- Add the resource name of your mod to the list, keeping the same format as the others (e.g. "- essentialmode"). The resource name of the mod is normally the mod folder name (in /resources/). The mod will generally provide instructions which should include this step, along with the resource name.
- Restart your server, the mod should now be working! If the mod requires MySQL, then continue onto the next section.
Installation steps for MySQL mods
Follow steps 1-5 above!
- If you haven't got one already, you may need to request a MySQL database from us. Contact us to get one setup (https://low.ms/contact). We are working on automating this process.
- Locate your MySQL details. These would have been sent to you in an email with the subject "MySQL Database Information". The four details you will need to enter into your mod are the IP/Hostname, Username, Password and Database Name.
- Locate the mod folder in (/resources/...) via the control panel's file manager or via FTP.
- Most MySQL mods have a line like MySQL:open("127.0.0.1", "User", "Database", "Password") in a file called server.lua, or sv_***.lua. Some mods have a config.lua or settings.lua where you enter the details. The best thing to do is check the mod's documentation.
- Some mods also require you to run some SQL. This is essentially a script that sets up all the database tables that will be needed by the mod. Some mods provide a **.sql file in the mod folder. Some mods have this **.sql file on their mod forum thread or Github page. Locate this .sql file. If you can't find it, then the mod may not have one and you can go ahead to step 8.
- Once you have located the .sql file, login to PHPMyAdmin with your MySQL details. the URL to PHPMyAdmin will be in the "MySQL Database Information" email.
- Once logged in to PHPMyAdmin, select your database on the left (the same as your control panel username) and click SQL at the top of the page. Paste the contents of the .sql file from step 5 into the textarea. Click Go in the bottom right.
- Restart your server and you should be good to go!
If you have any problems with these steps, please get in touch at https://low.ms/contact.