Skip to main content

​
Updating Jaksam Inventory

Since version 1.28, updating is much simpler: everything you change lives in its own folder, so an update is just replacing one folder. Pick the guide that matches the version you have installed now:

1.28 and newer

Replace one folder, nothing to back up or restore

From 1.27 or older to 1.28

Once only: your customizations are moved automatically

Versions before 1.28

The old guide, for installations still on 1.27 or older
You can see your installed version in jaksam_inventory/fxmanifest.lua, on the version line

​
Version 1.28 and newer

Everything you change (settings, items, images, hooks, modules, translations, integrations) is saved in jaksam_inventory_data, a folder next to jaksam_inventory. Updates only replace jaksam_inventory, so your changes are never touched
1

Stop your server

Stop your FiveM server before replacing the files.
2

Replace jaksam_inventory

Delete the jaksam_inventory folder and put the new one in its place. Leave jaksam_inventory_data exactly where it is
3

Start your server

That’s it: your items, settings and customizations are all still there
Backing up jaksam_inventory_data from time to time is still a good idea: it’s the one folder that holds all your work.
Don’t edit files inside jaksam_inventory, they are replaced by every update. If you do, the server console tells you at startup which file was edited and where that change belongs in jaksam_inventory_data. The shipped versions of every file are in jaksam_inventory/defaults: read them, copy what you need, but don’t edit them.

​
What’s inside jaksam_inventory_data

jaksam_inventory_data doesn’t need a line in server.cfg: jaksam_inventory starts it by itself.

​
Troubleshooting

jaksam_inventory_data must be next to jaksam_inventory, in the same folder. Put yours back (or restore it from your backup) and restart the server. If you never had one, an empty one has been created for you: just restart.
Your jaksam_core is too old to read the settings from jaksam_inventory_data. Download the latest jaksam_core and replace it. Until then, your settings keep working from their old place.
That change will be lost with the next update. Move it to the place the console tells you, inside jaksam_inventory_data.

​
Moving from 1.27 or older to 1.28

You only do this once. After it, every update is the simple one above.
1

Stop your server and back up

Stop your server and make a copy of your whole jaksam_inventory folder.
2

Update jaksam_core too

Download the latest jaksam_core and replace yours. Older versions can’t read the settings from their new place.
3

Copy the new version over the old one

Copy the new jaksam_inventory over your current one, overwriting the files, and put jaksam_inventory_data from the download next to it.Don’t delete the old folder first: your old files must still be inside jaksam_inventory on the first start, so they can be moved. If you already deleted it, copy current_config.json, _data/, _hooks/, _modules/, integrations/, locales/ and your custom images in _images/ from your backup into the new jaksam_inventory before starting.
4

Start your server

On the first start your settings, items, hooks, modules, integrations, translations and custom images are imported into jaksam_inventory_data automatically. The server console and the /inventory menu show what was imported, and the old files are moved to jaksam_inventory/_migrated.
Two things are not moved automatically:
  • Custom colors from dist/assets/variables.css: open the theme menu and set your theme as the server default, or copy the variables you changed into jaksam_inventory_data/variables.css
  • Custom menu translations in dist/menu_translations/: these are still inside jaksam_inventory, so copy them back after every update

​
Versions before 1.28

This is the guide for installations still on version 1.27 or older, where your customizations are inside the jaksam_inventory folder itself.
Always create a backup before updating. Never delete your existing installation before you have a working backup.

​
Before You Start

Recommended: Keep your backup for at least a few days after the update. This makes it easy to roll back if something goes wrong.

Stop Your Server

Always stop your FiveM server before replacing the inventory files.

Create a Backup

Back up your customized files and folders before installing the new version.

Install the Update

Remove the old version and upload the latest Jaksam Inventory release.

Restore Customizations

Restore your backed-up files to the new installation.

​
What Should I Back Up?

​
Always Back Up

These files and folders should always be included in your backup:

​
Custom Files

Only back these up if you have modified or added them:
If you haven’t customized any of the files listed above, you don’t need to back them up.

​
Update Process

Follow these steps in order.

​
Quick Reference

​
Troubleshooting

Restore the _data/ folder from your backup and restart the server.
Restore the _hooks/ folder from your backup.
Restore current_config.json from your backup.
Restore dist/assets/variables.css from your backup if you customized the default theme.
Restore your customized _images/ folder.
Restore _locales/ and/or dist/menu_translations/, depending on which translation files you customized.
  1. Make sure the new jaksam_inventory folder is installed correctly.
  2. Make sure your backup files were restored to the correct locations.
  3. Wait approximately 30 seconds after starting the server, as the database may be updating automatically.
  4. Check your server console for errors.
  5. If the problem persists, restore your previous backup and contact support.

​
Important

Never delete your backup immediately after a successful update. Keep it for a few days in case you discover an issue later.
Once everything is working correctly, your Jaksam Inventory update is complete.