Installation Guide

Prerequisites

Ensure you have the following resources installed and running:

Resource	Purpose
qb-core	Core framework
oxmysql	Database operations
PolyZone	Location-based zones

---

Installation Steps

1. Download Resource

Place oxide-clothing in your resources folder:

resources/[qb]/oxide-clothing/

or

resources/[oxide]/oxide-clothing/

2. Database Setup

Fresh Installation

Run the install script to create the required tables:

source sql/install.sql

This creates three tables:

Table	Purpose
character_appearance	Stores face, hair, model, and eye color
character_clothing	Stores clothing components and props
character_outfits	Stores saved outfits

Migrating from qb-clothing

If you have existing player data in player_skins:

source sql/migrate.sql

The migration script:

1. Creates the new tables
2. Transforms existing skin data to the new format
3. Preserves all player customization

Note: Keep a backup of your database before migrating. It is not guaranteed the migration will work. Backup your data.

3. Server Configuration

Add to your server.cfg:

ensure qb-core
ensure oxmysql
ensure PolyZone
ensure oxide-clothing

Important: oxide-clothing must load after qb-core and oxmysql.

4. Remove Old Resource

If replacing qb-clothing:

1. Remove or comment out ensure qb-clothing from server.cfg
2. oxide-clothing provides qb-clothing so external resources will still work

---

Web UI (Optional)

The resource includes a pre-built UI in web/dist/. If you want to customize the UI:

Build from Source

cd web
npm install
npm run build

Development Mode

For hot-reload during UI development:

cd web
npm run dev

Then update fxmanifest.lua to use the dev server URL temporarily.

---

Verification

After installation:

1. Start your server
2. Join and create a new character
3. The character creator should open automatically
4. Check F8 console for [oxide-clothing] Resource started - v2.0.0

---

Updating

When updating oxide-clothing:

1. Check CHANGELOG.md for breaking changes
2. Run any new migration scripts if provided
3. Rebuild web UI if you've customized it
4. Restart the resource

---

Uninstallation

To remove oxide-clothing:

1. Remove ensure oxide-clothing from server.cfg
2. Optionally drop database tables:

   DROP TABLE IF EXISTS character_appearance;
   DROP TABLE IF EXISTS character_clothing;
   DROP TABLE IF EXISTS character_outfits;

---

Next Steps

• Configure stores and locations - Customize behavior
• Explore features - Learn about all capabilities
• Use the API - Integrate with your resources