NATIVE ATLASA field guide for builders
RED DEAD REDEMPTION II
Connect your AI
From the reference libraryRedM

clothing-store-colorways

jo_libs/redm_scripts/clothing-store-colorways.md

clothing-store-colorways

:necktie: Colorways

Documentation relating to the jo_clothingstore_colorways add-on for Clothing store script.

:::: tabs ::: tab BUY Buy the add-on :::

::: tab PREVIEW <iframe width="560" height="315" src="https://www.youtube.com/embed/GR9xSUI8GC4?si=Lrqr9_NxGr0R86RB" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> ::: ::::

1. Installation

::: warning Clothing store script is required to use this add-on :::

To install jo_clothingstore_colorways:

  • Drag and drop the resource into your resources folder
    • jo_clothingstore_colorways
  • Add this ensure in your server.cfg after ensure jo_clothingstore
    • ensure jo_clothingstore_colorways

Congratulation, the Colorways add-on is ready to be used!

2. Usage

  • Go in a clothing store and press Config.keys.colorways (default : C) to open the colorways menu
  • New color variations will be added to the current item variations slider

3. Configuration

<ScriptConfig scriptPath="redm/clothes-colorways" />

3. Configuration > Palette Configuration

Config.palettes controls which palettes are visible in the menu and which tint values can be selected for each palette.

Supported options per palette:

  • enabled: show or hide the palette in the menu
  • disabledTints: tint indices that cannot be selected
  • min: lowest allowed tint index
  • max: highest allowed tint index

Example:

Config.palettes = {
  tint_generic_clean = { enabled = true, min = 0, max = 31 },
  tint_hair = { enabled = true, disabledTints = { 1, 2, 3 }, min = 0, max = 25 },
  tint_makeup = { enabled = true, disabledTints = { 33, 34, 35, 36, 37, 38 } },
  tint_horse = { enabled = false }
}

These restrictions are applied to the tint sliders for the selected palette.

3. Configuration > Language Configuration

The script supports full translation through the language system. To override any text:

  1. Find the key you want to change in config/_default.lock/lang.lua
  2. Copy lang.lua to config/custom/ and add only the keys you want to override

Example:

Lang.colorways = "Цветовая гамма"
Lang.customColor = "Пользовательский цвет"
Lang.noPalette = "Вы не можете получить доступ к цветовой гамме"

Available translation categories include:

  • General UI & Common Terms
  • Palettes names

:::tip Only change the key you need to translate You only need to include the specific keys you want to change in config/custom/lang.lua. Don't copy the entire language file if you don't need to. :::

4. For developers > Actions

Actions are one of the two types of Hooks. They provide a way for running a function at a specific point in the execution of scripts. Callback functions for an Action do not return anything back to the calling Action hook. They are the counterpart to Filters.

Below is a complete list of all available actions in the jo_clothingstore script.

4. For developers > Actions > <Badge type="client" text="Client" /> init

Triggered when the addon is initialized

exports.jo_clothingstore_colorways:registerAction('init', function()
    -- Your code here
end)

4. For developers > Filters

Filters allow you to modify data or permissions synchronously at specific points in the script. Below is the complete list of jo_clothingstore filters and how to use them.

4. For developers > Filters > <Badge type="client" text="Client" /> canOpenColorPalette

Manage who can open the custom color menu

-- @param canAccess - boolean
exports.jo_clothingstore_colorways:registerFilter('canOpenColorPalette', function(canAccess)
  --return false to disable the access of the menu
  return canAccess
end)

4. For developers > Filters > <Badge type="client" text="Client" /> paletteValues

Manage the values of the palettes

-- @param values - table
exports.jo_clothingstore_colorways:registerFilter('paletteValues', function(values)
  -- manipulates values to add/remove/replace data and return new palettes values
  return values
end)

4. For developers > Filters > <Badge type="client" text="Client" /> updateHashpreviewBeforeBuy

Update hash preview before buying

-- @param hashpreview - table
-- @param currentData - table
exports.jo_clothingstore_colorways:registerFilter('updateHashpreviewBeforeBuy', function(hashpreview,currentData)
  return hashpreview
end)
Back to documentation