Poggy Crafting

Overview#

Benches, campfires and the world's own ovens and forges open a recipe browser. It shows the whole tree behind an item: what it takes, what makes those ingredients, what it is used in, and where in the world each ingredient comes from.

• A recipe browser. Categories down the side, a search over recipe names, ingredients and rewards, and two filters: what you can make right now, and only what your job can reach. Locked recipes still show, greyed out, with the reason on a badge.
• Recipe chains. Open a recipe and see each ingredient, whether it can itself be crafted, and how far you are from having enough. Used In shows the other way.
• Where do I get this? Hover an ingredient for a card saying how it is obtained.
• Shopping list and gathering tracker. Add a recipe's ingredients to a per-character list, or pin it to a small window that fills in as items land in your inventory.
• Optional skillchecks, with partial rewards, bonus rewards, and recipes that explode or set you alight on a miss.
• Job and place locks on categories, recipes and benches, plus jobSkillcheck to let anyone attempt a job recipe on a hard skillcheck.
• Alternative ingredients ("any fish") and money in or out of a recipe.
• A placeable campfire item.

Poggy Crafting is a fork of VORP's vorp_crafting and, like the original, is open source under the GNU General Public License v2. The whole script ships readable.

Requirements#

No progress bar, prompt or menu resource is needed: the script draws its own.

Installation#

1. Download Poggy Crafting and put the poggy_crafting folder in your resources folder.
2. Add it to server.cfg, after poggy_core and oxmysql (and poggy_skillcheck, if you use it):

   ensure oxmysql
   ensure poggy_core
   ensure poggy_skillcheck
   ensure poggy_crafting

3. Copy docs/item_images/campfire.png into your inventory's item image folder.
4. Restart the server, then write your recipes.

There is no SQL to import. The shopping-list table is created automatically the first time the script starts, and on VORP the campfire item is added too. On RSG and QBCore RedM, whose items live in a Lua file, add a campfire item yourself, or set Config.CampfireItem = false.

Configuration#

Every setting can be changed in game: type /poggy, open Poggy Crafting, save, and restart the script (needs poggy_core 0.18.0 or newer). You can also edit the files by hand:

General

Where people craft

Three things open the browser, and a recipe can require any of them:

• Benches (Config.Locations, Locations → Benches): a fixed point with an id, a name, an optional blip, an optional job lock, and the categories it offers (0 for all).
• World props (Config.CraftingProps): every campfire, oven and forge the game already places. The group's title in lower case (campfire, oven, forge) is its place id.
• A placed campfire: the campfire item, used from the inventory.

Categories

Every recipe names a category (Config.Categories). Each has an ident, the text players read, and a Job and Location lock (0 for anyone / anywhere). A category the player cannot reach still shows, greyed out under Requires Access.

Recipes

Recipes live in config/recipes.lua (the Recipes tab). The smallest one:

{
    Text     = 'Bread Bait',
    Items    = { { name = 'bread', count = 1 } },
    Reward   = { { name = 'bait_bread', count = 5 } },
    Type     = 'item',
    Category = 'supplies',
    Job      = 0,
    Location = 0,
},

Add each ingredient to config/item_sources.lua (Where items come from) with a short source badge and one line of description, and hovering it in the browser tells players where to find it.

Skillchecks

Hiding recipes with no item icon

In /poggy each hidden recipe is marked with the reason and the exact icon file to add. Add the PNG and restart the server, and it comes back.

Commands#

Player command names are set in Config.Commands. Set one to false to remove it.

Permissions#

There are no ACEs. /campfire (off by default) is for admins as poggy_core defines them. Everything else is decided by jobs and places:

A recipe's own locks are checked as well as its category's, so a recipe can be stricter than its category, never looser. The server checks every lock itself on every craft, not just the menu, and checks the player is really at the bench they crafted at.

Using it in game#

For players

1. Walk up to a bench, campfire, oven or forge and press G, or type /craft.
2. Pick a category or search. A greyed-out recipe shows why on its badge: Requires: a job, or Craft at: the places where it works.
3. Open a recipe to see its chain, then craft. One craft makes at most 100 at once.
4. Add the ingredients to your shopping list, and pin it as a tracker while you gather. Use /gt to move it and /gthide to hide it.
5. Use the campfire item to build a campfire in front of you; /extinguish puts it out.

Adding a bench

1. Stand at the spot. Open /poggy → Poggy Crafting → Locations → Benches and click Add bench.
2. Give it a unique ID (recipes use it) and a Name, and use Use my position for X, Y, Z.
3. Choose its Categories (every category, or only some) and Jobs (anyone, or only some), and an optional map blip.
4. Save and restart the script.

To make a category or recipe work only there, set its Where to Only at these places and add the bench. Never reuse or rename a bench ID: recipes and categories that name it stop matching.

Skillcheck recipes

These need Poggy Skillcheck running. The ingredients are taken before the rounds start, so a miss costs them.

Pass every round for the full reward; pass some for that share (at least 1); pass none and you get nothing. Each hit in the bright band adds the great-hit bonus. With explodeOnFail or catchFireOnFail, one miss ends the craft with nothing.

Troubleshooting#

"That recipe needs poggy_skillcheck"

Start poggy_skillcheck, or set Config.Skillcheck.enabled = false.

No prompt at a campfire

Check Config.CraftingPropsEnabled is on, the prop is in Config.CraftingProps, and Config.CampfireJobLock allows your job.

A recipe is greyed out

Read the badge. Requires: means the job does not match: check the exact spelling and case. Craft at: means the wrong place; /craft counts as nowhere, so go to a bench or prop it names. Unavailable means a lock holds a number: pick Anyone or Only these in /poggy.

The console prints Job = 8 matches nothing

A Job, Location or Categories field holds a number other than 0. It must be 0 or a list of names.

An ingredient shows its raw name

The item has no label in your inventory. Add it to Config.ItemLabelOverrides.

An ingredient says "Unknown"

Add it to config/item_sources.lua.

Shopping list entries vanished

A recipe's Text was renamed. Text is the recipe's id.

A recipe is missing from the browser

Config.HideRecipesWithoutIcons is on and one of its items has no icon. /poggy names the item and the file, or run poggycrafting_icons in the console.

Two recipes with the same name

Recipes with the same name in different categories both work. The server warns at start when two share both a name and a category, since only the first can be crafted.

A config change did nothing

Restart poggy_crafting.

Updating#

Poggy Crafting updates through poggy_core's updater (see Updates). All four config and translation files are merged forward: your values and recipes survive an update, and new settings appear alongside them with their defaults.