> For the complete documentation index, see [llms.txt](https://rickys-organization-6.gitbook.io/hwc-documentions/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rickys-organization-6.gitbook.io/hwc-documentions/hwc-3d-printer.md).

# HWC 3D Printer

### 📥 Downloading Your Resource

After purchasing **HWC 3D Printer**, you must download it via the **CFX Portal**:

1. Go to: <https://portal.cfx.re/>
2. Log in with the account used to purchase
3. Navigate to:

```
Granted Assets
```

4. Locate:

```
HWC 3D Printer
```

5. Click **Download**

***

### 📂 Installing The Resource

#### 1️⃣ Extract The Download

* Extract the `.zip` file
* You will get a folder:

```
HWC_3D_Printer
```

***

#### 2️⃣ Add To Your Server

Place the folder inside your resources directory:

```
resources/[standalone]/HWC_3D_Printer
```

***

### ⚠️ IMPORTANT – Framework Setup Required

This resource supports:

* ✅ QBCore
* ✅ QBox
* ✅ ESX Legacy

👉 You MUST follow the correct setup for your framework below.

***

## 🔧 QBCore Installation

***

#### 1️⃣ Add Items

Open:

```
qb-core/shared/items.lua
```

Copy items from:

```
HWC_3D_Printer/Install Me/Qb/items.lua
```

***

#### 2️⃣ Add Images

Copy all images from:

```
HWC_3D_Printer/Install Me/images/
```

To:

```
qb-inventory/html/images/
```

***

#### 3️⃣ Configure Exports

Open:

```
shared/exports_config.lua
```

Set:

```
InventorySystem = { type = 'qb' }
ProgressBar = { type = 'qb' }
NotificationSystem = { type = 'qb' }
```

***

#### 4️⃣ Start Resource

```
ensure HWC_3D_Printer
```

***

## 🔧 QBox Installation

***

#### 1️⃣ Add Items

Open:

```
ox_inventory/data/items.lua
```

Copy items from:

```
Install Me/Ox/items.lua
```

***

#### 2️⃣ Add Images

Copy images to:

```
ox_inventory/web/images/
```

***

#### 3️⃣ Configure Exports

```
InventorySystem = { type = 'ox' }
ProgressBar = { type = 'ox' }
NotificationSystem = { type = 'ox' }
```

***

#### 4️⃣ Start Resources

```
ensure ox_lib
ensure ox_inventory
ensure HWC_3D_Printer
```

***

## 🔧 ESX Legacy Installation

***

#### 1️⃣ Add Items

Open:

```
ox_inventory/data/items.lua
```

Copy from:

```
Install Me/Ox/items_legacy.lua
```

***

#### 2️⃣ Add Images

```
ox_inventory/web/images/
```

***

#### 3️⃣ Configure Framework

Open:

```
configs/general_config.lua
```

Set:

```
Config.Framework = 'esx'
```

***

#### 4️⃣ Configure Exports

```
InventorySystem = { type = 'ox' }
ProgressBar = { type = 'ox' }
NotificationSystem = { type = 'esx' }
```

***

#### 5️⃣ Start Resources

```
ensure ox_lib
ensure ox_inventory
ensure HWC_3D_Printer
```

***

### ⚙️ Basic Configuration

All main settings are located in:

```
configs/
```

***

#### 🔧 General Settings

File:

```
configs/general_config.lua
```

You can configure:

* Debug mode
* Language
* Printer models
* Sounds
* UI settings
* Access control
* Cleanup system

***

#### 🧪 Items (What Can Be Printed)

File:

```
configs/items_config.lua
```

You can define:

* Printable items
* Materials required
* Print time
* Upgrade requirements

***

#### ❤️ Health & Battery System

File:

```
configs/health_config.lua
```

Controls:

* Printer durability
* Battery usage
* Smoke & spark effects

***

#### ⚡ Upgrades System

File:

```
configs/upgrades_config.lua
```

Includes:

* Head upgrade (speed + unlocks)
* Motors upgrade
* Frame upgrade

***

### 🎮 How Players Use It

***

#### 🖨️ Placing a Printer

* Use printer item from inventory
* Place it in the world

***

#### ⚙️ Using the Printer

Players can:

* Insert materials
* Select items to print
* Start printing

***

#### 🔄 Printing Process

* Ghost prop appears (preview of item)
* Welding glow effect plays
* Printer produces item over time
* Item becomes collectible when finished

***

#### 🔧 Maintenance

Players must manage:

* Printer health
* Battery level
* Repairs using tools

***

### 👑 Admin Features

Admins can:

* View all printers
* Repair printers
* Apply upgrades
* Delete printers
* Teleport to printers

***

#### 🔑 Admin Permission

Add to `server.cfg`:

```
add_ace group.admin hwc_3dprinter.admin allow
```

***

### 🧪 Debug Commands

When debug is enabled:

```
Config.Debug = true
```

***

#### Available Commands

```
/glow_test
/glow_stop
/glow_cleanup
```

***

### ⚠️ Important Notes

* Works with **QBCore, QBox, ESX Legacy**
* Requires a supported inventory system
* No core edits required
