Installation

3 min readUpdated 2 weeks ago

Overview

ML Crafting shows its menu on a screen in the world, attached to the workbench, and players use it like a terminal. Stations, recipes, categories, blueprints and community projects are built in an in-game admin panel and saved in the database. Recipes support alternative ingredients, skill locks, blueprints and timed queues, and benches can burn fuel and wear down.

Quick Start

  1. Download from CFX Portal
  2. Extract to your resources folder as ml_crafting
  3. Add to server.cfg:
server.cfg
1ensure oxmysql
2ensure ox_lib
3ensure ml_bridge
4ensure ml_crafting
Load Order

ml_crafting must start AFTER ml_bridge. Start ml_skills, ml_fuel, ML Inventory and ml_battlepass before it if you use them. Keep the folder name ml_crafting.

Database

Tables are created on first start:

  • ml_crafting_bench_types, ml_crafting_bench_type_access, ml_crafting_bench_type_categories: station types, their access lists and categories
  • ml_crafting_bench_locations: every placed bench with its position, owner, camera and interaction point
  • ml_crafting_categories, ml_crafting_color_presets: recipe categories and the editor colors
  • ml_crafting_recipes, ml_crafting_recipe_ingredients, ml_crafting_recipe_results, ml_crafting_recipe_blueprints: recipes with ingredients, results and blueprints
  • ml_crafting_blueprints, ml_crafting_blueprint_uses: blueprints and the uses left per player
  • ml_crafting_players, ml_crafting_xp_log: progression, permanent unlocks and XP already given
  • ml_crafting_queue, ml_crafting_pending_refunds, ml_crafting_delivery_receipts: queued and finished crafts, and items owed to players whose inventory was full
  • ml_crafting_projects, ml_crafting_project_goals, ml_crafting_project_rewards, ml_crafting_project_contributions: community projects
  • ml_crafting_station_models, ml_crafting_default_interact, ml_crafting_config, ml_crafting_commit_guard, ml_crafting_migrations: custom station models, panel settings and schema updates
  • ml_crafting_bp_runs, ml_crafting_bp_outbox, ml_crafting_bp_cache, ml_crafting_bp_sources, ml_crafting_bp_guard: battlepass progress queue, only filled when ml_battlepass runs

Item Registration

There is no fixed item list. Register the items you use:

  • ml_workstation: station item (Config.PortableStations.GenericItemName). The station type comes from metadata.stationType. You can also bind an item to each station type in the admin panel
  • ml_blueprint: blueprint item (Config.Blueprints.GenericItemName) with metadata.blueprint, or one item per blueprint named blueprint_<label>
  • Every ingredient and result of your recipes. The recipe editor lists the registered items

Verify

The console prints the version banner, with a line that starts with:

cfg
1[ml_crafting] Resource started

In game, run /craftadmin with a staff account, create a station type and place a first bench. Players can use it at once.

  • /craftadmin does nothing: the account fails the Config.Admin.Permission group check, or AcePermission when set. The denied attempt is logged.
  • Bench not visible: benches spawn within Config.Interaction.SpawnDistance. For a bench created far away, walk Config.Stream.ReloadDistance meters or relog.
  • Black screen: screens render within Config.DUI.Range and at most Config.DUI.MaxActive at once. Turn on Config.Debug and check the F8 console.
  • Players see no recipes: HideUnavailable and HideMissingBlueprint hide what they cannot craft. Set ShowLockedPreview = true to show locked recipes.
  • No XP: the console prints a yellow [ml_crafting][XP] line when no skill category could be found. Bind a required skill on the recipe or map the category in Config.ExternalSkills.Mapping.
  • Station item does nothing: the item must be usable in your inventory and carry metadata.stationType. On an inventory without metadata, the console prints an INFO line and stations use default values.
Crafting Installation, FiveM Docs | Micio Mods