Starting point and recommended setup order for 0r-tattoo_designer
This guide covers the current 0r-tattoo_designer resource.
0r-tattoo_designer is a FiveM tattoo authoring and application system. Authorized users create text and image designs, position them on a live ped preview, save projects, and publish selected projects to the Tattoo Shop. Authorized artists can use self-service shop sessions; other players join as customers in professional sessions.
What the system does#
- Text and image tattoo authoring
- Template Images from vendor or customer-owned CDN catalogs, with favorites
- Live ped preview with body-zone, scale, rotation, and placement controls
- Saved projects in MySQL and expiring project sharing
- Published projects exposed as Tattoo Shop presets
- Persistent character-owned tattoo applications
- Runtime tattoo textures for the owner and nearby players
- Illenium appearance lifecycle resynchronization for custom runtime overlays
- Artist self-service and artist/customer professional sessions
The supported authoring modes are only text and image. Template Images become editable image drafts through the normal workflow; they are not a separate published shop library. Tattoo Shop presets originate only from projects published by Tattoo Designer.
The authoring scope is limited to six standard body zones: torso, zone_head, left_arm, right_arm, left_leg, and right_leg. It supports male/female freemode peds. A project can contain at most 64 layers; the default image-layer limit is 12. Unsaved drafts are temporary Lua process state and are cleared when the resource or server restarts. Save the project before relying on an export or publication.
Resource layout#
The package contains three resources. Keep them in the same resource group and start them together:
[tattoo_designer]/
0r-tattoo_runtime_assets/ # Stable overlays, runtime slots, and studio map
0r-tattoo_designer/ # Studio, shop, UI, and server logic
0r-tattoo_exports/ # Generated output from published projects
The 0r-tattoo_exports data/ and stream/ contents are generated. Do not edit them manually; use the project workflow and Export Reload.
Recommended reading order#
- Installation
- Database
- Configuration
- Modules and Custom Providers
- Tattoo Shop and Appearance
- Publishing and Export Reload
- Events, Exports, and Commands
- Troubleshooting
Requirements#
- OneSync-enabled FiveM server
ox_liboxmysql- Node.js 22+ on the server host for the worker, or an explicit
Config.Worker.NodePath - A current stable FXServer artifact
The customer delivery contains generated resources and does not include a source workspace or build toolchain. The host Node executable selected by Config.Worker.NodePath is separate from the embedded bridge runtime selected by node_version '22' in fxmanifest.lua.
Quick checklist#
After installation, verify:
- The three tattoo resources start without errors.
- An authorized player can open
/tdesigner. - Database migration and read-only schema verification complete with
currentVersion=2. - An authorized artist can save and build a project.
- Export Reload completes and the published project appears in the Tattoo Shop.
Next: Installation.