> For the complete documentation index, see [llms.txt](https://goonsquad.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://goonsquad.gitbook.io/docs/clothdesigner/usage.md). # Usage This page covers the player, designer, and admin workflows in GS Cloth Designer 1.5.0. *** ## Open the Designer Public access is enabled by default. Every supported framework player can approach a station and press the interaction key. With `AllowEveryone = false`, the normal flow requires a configured job/grade or an authorized pass. The default station is at: ``` -1194.96, -767.87, 17.32 ``` A server owner can also open the UI through an integration: * `openDesigner()` opens the normal studio using the configured access policy. * Client `summonDesigner(componentAmount, aiGenAmount)` opens an already server-authorized limited session for the local player. * The server export grants the limits and opens a limited session for a target server ID. Client-supplied limits cannot create or reset allowances. See [API & Exports](/docs/clothdesigner/exports.md#limited-designer-access). *** ## Create a Design 1. Choose male or female and select a clothing or prop category. 2. Select an available silhouette. 3. Add drawing, shape, text, image, or externally registered studio-tool layers. 4. Reorder and transform layers until the canvas and preview match the intended result. 5. Save a draft or print the finished design. The library only mounts previews close to the visible scroll area. Off-screen preview images and 3D models are released as the player scrolls, which keeps large template libraries responsive. ### Image Uploads The UI accepts PNG, JPEG, and WebP by default. When a selected file exceeds `MaxUploadBytes`, the player is notified before the browser reads it. The server validates MIME type, dimensions, base64 size, and payload limits again before saving or forwarding it. Uploads, URL imports, previews, and generated-media hosting share the configured upload queue. A full queue returns the configured busy message instead of starting more expensive work. ### 3D Preview Background The preview starts with a black background. Use the small switch below the preview to change it to light gray. The choice is stored in the player's NUI browser data and is restored the next time the designer opens. ### AI or Other Studio Tools AI is shown only when a compatible companion or third-party resource registers a studio tool. A generation returns an image layer that can be moved, resized, edited, or removed like another image. In a limited session: * Each successful AI request consumes one AI generation through the provider integration. * Failed generations can be refunded by the provider integration. * When `RequireRemainingComponentsForAI = true`, generation is blocked after the clothing allowance reaches zero even if AI uses remain. *** ## Save and Print **Save** stores a draft that the creator can continue editing. **Print** submits a review request with the shipped defaults. Approval publishes the design and attempts to add a metadata-bearing custom clothing item. If `RequireApproval = false`, a successful print publishes and grants the item immediately. With the recommended limited-pass setting, a clothing use is consumed only when printing succeeds or an admin approves the print request. The active allowance appears in the limited designer UI: ``` 2/2 pieces | 4/4 AI ``` If a pass allows two clothing pieces, the player chooses which two templates to create. A top, pants, shoes, or prop each consumes one clothing use when printed. Reprinting the same design in the same active pass does not consume a second clothing use. {% hint style="info" %} `ConsumeComponentOn = 'save'` changes the flow so a new saved design consumes the clothing use immediately. `print` is the recommended value. {% endhint %} *** ## Wear and Remove Clothing ### Inventory Item Equipping waits for image/texture preparation, checks the actual native clothing result and confirms the change with the server before recording success. Failed replacement restores the previously confirmed appearance. Use a printed item once to equip its design. Use that same item again while its design is equipped to remove it and restore the previous component or prop appearance. When several matching custom items exist and the inventory backend cannot identify the exact used slot, Cloth Designer opens a picker so the player can select the intended design. ### Player Wardrobe Open the created-clothing UI with: ``` /gscd_wardrobe ``` The wardrobe lists up to the 100 most recently updated published, pending, or rejected designs owned by that player. Players can preview approved clothing, wear it, or take it off. Inventory-item and wardrobe actions use the same server wearable state. Equipping in one UI is reflected in the other, and removing a design clears its persisted state so it does not return a moment later or after reconnecting. ### Persistence Equipped designs are restored after supported QBCore, Qbox, and ESX player-load events. The runtime stores the previous appearance for each component or prop so removing custom clothing restores the correct pants, footwear, hat, or other base item. *** ## Approval Workflow `Wardrobe.RequireApproval = true` is the shipped default. ### Player Flow 1. The player finishes a design and selects Print. 2. The design enters `pending_approval`; no wearable item is granted yet. 3. The player can see its pending status in `/gscd_wardrobe`. 4. Approval publishes the design and attempts to add the inventory item. 5. Rejection records the admin note and shows the rejected status in the player's wardrobe. ### Admin Flow Admins with the configured ACE open: ``` /gscd_clothing_review ``` The review UI shows the oldest pending requests first. Admins can preview, approve, or reject a design with a note. ```cfg add_ace group.admin gscd.clothdesigner.admin allow ``` For limited or Tebex sessions, approval consumes the clothing use. This can happen while the creator is offline. Approval also spends the creator's print quota. If the item cannot be delivered, the approved design is still available through the player's wardrobe when they return. *** ## Tebex Passes When Tebex integration is enabled, a package can grant any configured combination of clothing and AI allowances. If `AutoOpenOnPurchase = true`, an online buyer is taken directly into the limited designer. Offline entitlements remain pending. Players claim their next available pass with: ``` /gscd_claim_designer ``` The command name is configurable. See [Tebex Integration](/docs/clothdesigner/tebex.md). *** ## Print Quota Every character can complete five prints per six-hour shared window by default. The quota applies to public access, jobs, paid passes, reprints and the server print export. Saving a draft or submitting a pending request is free. Approval charges the creator and is refused if their quota is exhausted. Reconnects do not clear usage. A resource restart resets this in-memory quota. The six-hour boundary is shared across characters and anchored to resource startup. Staff can change `Designer.PrintLimit` and `Designer.PrintLimitResetHours`; `PrintLimit = 0` disables it. *** ## Template Capacity Each generated drawable has 26 texture variants. Cloth Designer allocates additional drawables when a silhouette runs out of texture slots. A template can temporarily show as full until pool expansion is materialized and the server is restarted. To add a template, place its YDD and any companion YTD in the correct `cloth_templates///` folder, then restart. See [Installation](/docs/clothdesigner/installation.md#adding-templates-later). *** ## Commands | Command | Purpose | Access | | --------------------------------------------------- | ------------------------------------------------------- | ----------------------------- | | `/gscd_wardrobe` | Preview, wear, and remove the player's created clothing | Player | | `/gscd_clothing_review` | Review pending designs | Configured wardrobe admin ACE | | `/gscd_claim_designer [package]` | Claim the next or named Tebex pass | Player | | `gscd_tebex_grant ` | Grant a configured Tebex pass | Console or `gscd.tebex` ACE | | `gscd_delete_design ` | Delete a design and release its wearable state and slot | Protected command ACE | | `gscd_rescan` | Rescan source templates | Protected command ACE | | `gscd_rebuild_pool` | Reattach and rebuild the generated pool | Protected command ACE | Maintenance commands are advanced tools. Normal template installation still ends with a server restart so FiveM can register generated apparel.