Documentation › Mushrooms › Installation

Installation

Get Mushrooms running on your server.

Download

Log in to the Cfx.re Portal, open Granted Assets and download the package.

Put the resource in your server

Extract it into your resources folder as smile_mushrooms. The web/ folder is only the UI source and is not needed on the server (html/ is the built UI).

The mushroom and drying rack models (borowik, s_drying_rack_m …) must be streamed. If they come as a separate props resource in your download, start it as well.

Add the items

Open install/ and follow the file for your inventory (ox_inventory.md, qb-inventory.md, qs-inventory.md, ps-inventory.md, codem-inventory.md, tgiann-inventory.md, jpr-inventory.md, ak47_inventory.md, origen_inventory.md or esx.md). Copy every PNG from install/images/ into your inventory's image folder. Full list: Items.

ox_inventory: the mushrooms and the rack need consume = 0. The script removes the item itself after a use; without it ox_inventory takes a second one.

Discord webhooks (optional)

Fill in the logs you want in config/config_webhooks.lua. Empty = off. See Discord Logs.

Start order

text
ensure oxmysql
ensure ox_lib
ensure smile_mushrooms

Database tables are created on the first start (the schema is also in install/smile_mushrooms.sql).

Admin access

Give yourself access to /mushadmin in Config.AdminAccess (config/config_main.lua) — by group, ACE or identifier. See Commands & Permissions.

Language

Set Config.Language in config/config_main.lua: en, pl, de, es, fr, ru or tr. The script and the UI both use locales/<lang>.json, including mushroom and forest names. Item labels in your inventory come from your item list, so translate those there if your server isn't in English.