YF-Filtrer: documentation

Overview

• 3x sifted: the YF-Kush pollen goes through the sieve twice more, then to the press.
• Frozen sift: freezing the buds, washing in a filter bag, drying on a rack, scraping, then the press.
• Cutting and capsule filling shared by both products, played by hand.
• Placeable freezer and drying rack with screens, running in real time even when the player is offline.
• Each station sits on a storage cabinet.
• The equipment is added to the YF-Kush vendor.
• French and English included.

Requirements

OneSync enabled and game build 2545 or higher, as for YF-Kush.

Installation

Seven steps, in this order.

1. Install YF-Kush 1.1.0

   If you have 1.0.0, update it first: see the YF-Kush documentation.

2. Add the resource

   Get YF-Filtrer from the Cfx.re portal (see Getting your purchases). Copy the YF-Filtrer folder into your resources, without renaming it, and start it after YF-Kush.

   server.cfgCopy

   ensure ox_lib
   ensure oxmysql
   ensure ox_inventory
   ensure ox_target
   ensure YF-Kush
   ensure YF-Filtrer

3. Create the SQL table

   Run install/install.sql on your database. It creates yf_filtrer_stations and is safe to run again.

4. Declare the items

   Paste the content of install/items_en.lua (English labels) or install/items.lua (French) at the end of ox_inventory/data/items.lua, before the last closing brace.

5. Copy the images

   Copy the 45 yf_*.png images from install/images into ox_inventory/web/images.

6. Adjust the config

   Open shared/config.lua: language, durations, yields, equipment prices. Details in Configuration.

7. Restart the server

   A full restart is needed the first time. The console shows 12 passe(s) enregistree(s) and 6 article(s) chez le vendeur: the products are plugged into YF-Kush.

Items

50 items: the equipment, then every step of both chains for the four YF-Kush strains. The full block is provided in install/items_en.lua.

Configuration

shared/config.lua is the only file to edit. Gestures, positions and animations are fixed in the script.

Config.locale = 'en'

Config.filtrage = {
    x2 = { capacity = 10, perPollen = 2, clicks = 5 },
    x3 = { capacity = 10, perPollen = 2, clicks = 5 },
}

Config.congelateur = { capacity = 100, glace = 2, minutes = 15 }

Config.claie = { minutes = 10 }

Config.sacFiltrant = { perOutput = 40, perWater = 20, lots = 3, wear = 10 }

Config.meubles = { slots = 20, weight = 50000 }

The production chains

Both products start from 80 buds and end as 20 capsules of 5 g. The rates are the same for all four strains.

3x sifted

Frozen sift

The stations

The freezer and the drying rack are placed from the inventory, like the YF-Kush stations. They come on a cabinet whose storage ("Open the cabinet") can hold your goods, and stay in place after a restart. A station can only be picked up when it is empty and its cabinet too.

The equipment

The equipment is added to the YF-Kush vendor, in its currency and opening hours. Prices and stock are set in YF-Filtrer's Config.shop.

Selling

Like the YF-Kush bags, capsules are not bought back by the script: plug them into your dealing script. Suggested price of one capsule, balanced with YF-Kush:

Languages

Every text is in locales/. To add a language, copy locales/en.lua, replace Locales['en'] with the language code, translate while keeping the %d and %s, then set Config.locale. Item names are translated in items.lua.

Troubleshooting

Editable files

The script is protected by the Cfx.re escrow. These stay readable and editable: shared/config.lua, the locales/ folder and the install/ folder.