# :house: Housing - More Furniture

Documentation related to the `jo_housing_more_furniture` add-on for the [Housing](housing) script.

:::: tabs
::: tab BUY
[Buy the add-on](https://jumpon-studios.com/redm/housing-more-furniture)
:::

::: tab PREVIEW
<iframe width="560" height="315" src="https://www.youtube.com/embed/lZ-P8Jziqfg" title="RedM - Housing More Furniture" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
:::
::::

The add-on adds **8,396 furniture** to the build mode of Housing: 6,472 in 22 new categories, each with its own icon, and 1,924 in the 16 categories of Housing.

## 1. Installation

::: warning
The [Housing](housing) script is required to use this add-on, in version **1.6.7** or later, with `jo_libs` **2.17.2** or later. With an older version, the add-on stops when the server starts.
:::

To install `jo_housing_more_furniture`:

1. Install [Housing](housing#_1-installation) 1.6.7 or later and its requirements, with `jo_libs` 2.17.2 or later.
2. Download `jo_housing_more_furniture` from your [account](https://jumpon-studios.com/account).
3. Unzip it and place the `jo_housing_more_furniture` folder in your resources folder.
4. Start it after Housing in your `server.cfg`:

```cfg
ensure jo_libs
ensure jo_housing
ensure jo_housing_more_furniture
```

::: tip 💡 No SQL file, no item
The furniture of the add-on is bought and placed like the furniture of Housing: nothing to add to your database or your inventory. The add-on registers its furniture, prices and category names in Housing each time Housing starts.
:::

## 2. Usage

The furniture is bought in the build mode of Housing, see [Using a house](housing#using-a-house).

### Adding furniture

1. Enter the build mode of your house.
2. Press the "Add Furnitures" key (default: `A`).
3. Pick a category: the 22 new ones are listed with the categories of Housing.
4. Browse the thumbnails, or search a model name with the search prompt.
5. Buy the furniture, then place it as any furniture of Housing.

### Categories

:::: tabs

::: tab 🆕 New categories
| Category | Furniture |
| --- | --- |
| Ammo | 107 |
| Animal Trophies | 269 |
| Books & Papers | 447 |
| Camp | 329 |
| Chests & Trunks | 165 |
| Clocks | 17 |
| Clothing & Textiles | 351 |
| Doors & Windows | 523 |
| Drinks | 135 |
| Farm & Ranch | 91 |
| Fences | 499 |
| Games | 936 |
| Industrial | 200 |
| Instruments | 27 |
| Medical | 130 |
| Office | 84 |
| Outdoor | 78 |
| Religious | 131 |
| Shelves | 69 |
| Signs | 312 |
| Storage Containers | 1,078 |
| Tools | 494 |
:::

::: tab ➕ Categories of Housing
These categories already exist in the Housing script: the furniture added by the add-on is listed after the furniture of Housing.

| Category | Already in the Housing script | Added by the add-on | New total |
| --- | --- | --- | --- |
| Bathroom | 26 | 67 | 93 |
| Beds | 62 | 18 | 80 |
| Cabinets | 124 | 62 | 186 |
| Carpets | 12 | 15 | 27 |
| Chairs | 171 | 52 | 223 |
| Curtains | 129 | 161 | 290 |
| Decorations | 541 | 464 | 1,005 |
| Desks | 30 | 2 | 32 |
| Fireplaces | 21 | 29 | 50 |
| Food | 663 | 205 | 868 |
| Kitchen | 149 | 193 | 342 |
| Lamps | 237 | 88 | 325 |
| Plants | 185 | 315 | 500 |
| Sofas | 23 | 5 | 28 |
| Tables | 175 | 41 | 216 |
| Wall Decorations | 101 | 207 | 308 |
:::

::::

## 3. Configuration

The configuration files are located in the `config` folder within the resource. This folder contains two subfolders:

- **`_default.lock/`** - Contains the default configuration files. **Do not edit these files directly** as they may be overwritten during updates.
- **`custom/`** - This is where you place your custom configuration files to override the defaults.

### How to customize the configuration

1. Navigate to `jo_housing_more_furniture/config/_default.lock/`
2. Copy the file you want to modify (e.g., `prices.lua`)
3. Paste it into `jo_housing_more_furniture/config/custom/`
4. Edit the copied file in the `custom` folder

The script automatically loads files from `custom/` first, and only uses `_default.lock/` as a fallback. This system ensures your customizations are preserved when updating the script.

### Default configuration files

`jo_housing_more_furniture/config/_default.lock/lang.lua`

```lua
-- Names of the furniture categories in the build mode menu
-- A category of jo_housing (beds, lamps...) added here gets renamed too
Lang.fur_cat_ammo = "Ammo"
Lang.fur_cat_animal_trophies = "Animal Trophies"
Lang.fur_cat_books_papers = "Books & Papers"
Lang.fur_cat_camp = "Camp"
Lang.fur_cat_chests_trunks = "Chests & Trunks"
Lang.fur_cat_clocks = "Clocks"
Lang.fur_cat_clothing_textiles = "Clothing & Textiles"
Lang.fur_cat_doors_windows = "Doors & Windows"
Lang.fur_cat_drinks = "Drinks"
Lang.fur_cat_farm_ranch = "Farm & Ranch"
Lang.fur_cat_fences = "Fences"
Lang.fur_cat_games = "Games"
Lang.fur_cat_industrial = "Industrial"
Lang.fur_cat_instruments = "Instruments"
Lang.fur_cat_medical = "Medical"
Lang.fur_cat_office = "Office"
Lang.fur_cat_outdoor = "Outdoor"
Lang.fur_cat_religious = "Religious"
Lang.fur_cat_shelves = "Shelves"
Lang.fur_cat_signs = "Signs"
Lang.fur_cat_storage_containers = "Storage Containers"
Lang.fur_cat_tools = "Tools"
```

`jo_housing_more_furniture/config/_default.lock/prices.lua`

```lua
-- ===================================
-- Furniture Prices
-- ===================================

-- Need to build or adjust a price table quickly?
-- Use the official Price Generator here:
--   https://docs.jumpon-studios.com/DeveloperResources/price-generator

-- Prices accept any PriceGroupInput, including PriceGroupClass instances.
-- A flat { money = ..., gold = ... } table creates alternative payment options.

-- Pricing of the categories added by this script
-- Its furnitures in a category of jo_housing (beds, lamps...) use the price of jo_housing: Config.furnituresCategoriesPrices of jo_housing
-- -1 removes a whole category of this script from the menu (for a category of jo_housing, lamps = -1: only the lamps of this script)
Config.furnituresCategoriesPrices = {
    -- fences = -1, -- example : the fences category removed from the menu
    ammo               = { money = 100, gold = 1 },
    animal_trophies    = { money = 100, gold = 1 },
    books_papers       = { money = 100, gold = 1 },
    camp               = { money = 100, gold = 1 },
    chests_trunks      = { money = 100, gold = 1 },
    clocks             = { money = 100, gold = 1 },
    clothing_textiles  = { money = 100, gold = 1 },
    doors_windows      = { money = 100, gold = 1 },
    drinks             = { money = 100, gold = 1 },
    farm_ranch         = { money = 100, gold = 1 },
    fences             = { money = 100, gold = 1 },
    games              = { money = 100, gold = 1 },
    industrial         = { money = 100, gold = 1 },
    instruments        = { money = 100, gold = 1 },
    medical            = { money = 100, gold = 1 },
    office             = { money = 100, gold = 1 },
    outdoor            = { money = 100, gold = 1 },
    religious          = { money = 100, gold = 1 },
    shelves            = { money = 100, gold = 1 },
    signs              = { money = 100, gold = 1 },
    storage_containers = { money = 100, gold = 1 },
    tools              = { money = 100, gold = 1 },
}

-- Specific pricing per furniture model, over the price of its category
-- -1 removes a furniture of this script from the menu
Config.furnituresPrices = {
    -- p_gen_tablepoker01x = { money = 250, gold = 5 }, -- example : specific price
    -- s_tent03x = -1,                                      -- example : removed from the menu
}
```

### Prices

`prices.lua` sets the prices of the furniture of the add-on:

- `Config.furnituresCategoriesPrices`: the price of each of the 22 new categories, used by all its furniture. By default `{ money = 100, gold = 1 }`: the player pays either $100 or 1 gold.
- `Config.furnituresPrices`: the price of one model, used instead of the price of its category.
- A price set to `-1` removes the category or the model from the menu.

The furniture added to a category of Housing (Beds, Lamps…) uses the price of that category in the configuration of Housing (`Config.furnituresCategoriesPrices` of `jo_housing`).

Use the [Price Generator](/DeveloperResources/price-generator) to build other prices (items, several payment options…).

The prices and the names of the add-on are sent to Housing: for a same category or model, they replace the ones of the configuration of Housing.

### Category names

`lang.lua` holds the names of the 22 new categories in the build mode menu. A category of Housing added to this file (for example `Lang.fur_cat_lamps = "Lights"`) is renamed too.

## 4. FAQ

:::details "jo_housing requires an update" or "No such export ... in resource jo_housing"
Your version of Housing is older than 1.6.7, the version the add-on needs. Update [Housing](housing) (and `jo_libs` to 2.17.2 or later), then restart both resources.
:::

:::details How do I remove a category or a furniture ?
Set its price to `-1` in the configuration of the add-on: a category priced `-1` disappears from the menu, a model priced `-1` is removed from its category.

For a category of Housing (Beds, Lamps…), `-1` only removes the furniture added by the add-on: the one of Housing stays.
:::

:::details Can I rename a category ?
Yes, with the language file of the add-on. A name set there also replaces the name of a category of Housing.
:::
