USING THE SHOPPING LIST BOARD & HUD
Current Recipe Hub Version: 11.0
Current Recipe Hub POS Version 11.0
Shopping List Board and Hud: Version 11.0
NOTE: For the FULL functionality of the Recipe HUB and shopping boards, you must have your Sorter at version 14 or above. You can get a redelivery of the latest Sorter using your Sorter hud in your package or visit any CasperVend redelivery terminal.
The Recipe Hub works with the VM Designs Modular Sorter and the Sorter is required for you to use the Recipe Hub add-on. The Recipe Hub is an amazing tool that greatly enhances your cooking and crafting. The Recipe Hub also works with the shopping list board (included) to make gathering your cooking and crafting needs easier!!
This document covers the initial setup to get things working with your Sorter and then covers the various buttons and options you’ll find on this item. Finally, we’ll touch on a few ways you can set up recipes.
For a normal update follow these steps:
NOTE: As of Version 10.0, this one crystal is used for normal and RU sorters. For your RU Sorter, go to the Sorter menu and go to Access > DNG RU and the center top prim should turn yellowish. Turning on DNG RU lets the Recipe HUB know that this sorter is your RU Sorter. You can only have ONE RU Sorter linked to Recipe HUBs. If you try to activate more than one you’ll get a popup warning.
There’s a setup and use video located on the VM Designs YouTube channel. See the link for that channel at the bottom of this document in the Conclusion section.
In your Recipe Hub folder you’ll have an item called “Recipe Hub Relay Loader.” This is the crystal that loads the necessary script into your sorter enabling your Sorter to talk to the Recipe Hub.
Step 1 - Rez the Recipe Hub Relay Loader crystal near your sorter(s).
Step 2 - Click the Recipe Hub Relay Loader crystal and wait for it to display “Waiting on Sorter”
Step 3 - Click your Sorter and go to Admin and then click Load. If you have many Sorters you can rez a crystal at each Sorter, just be sure to get one fully started before doing the next.
Step 4 - Allow the crystal to finish loading the script into your sorter. Do this for every Sorter you wish the Recipe HUB to access.
Step 5 - You can delete the crystal when it’s done, if it doesn’t automatically delete, because it’s copy so you should have the original in your inventory.
Step 6 - If you have a Sorter you use for Reduced Uses (RU) go to the menu for that Sorter and click Access > DNG RU so the Recipe HUB will know that’s your RU sorter. Note, you can only have ONE RU Sorter linked to your Recipe HUB(s)
NOTE: If you are looking at a normal sorter, the number displayed on the front of the crate should indicate how many of that item is in the crate. For example, if it says 4 for your DFS Milk Cartons, you should have 4 milk cartons in that sorter crate. However, if you are looking at an RU sorter, the number on the front of the crate is the best estimate of the total number of uses for all the items in that crate. For example, if you have one milk carton with 2 uses and two milk cartons with 3 uses each, you would see 8 on the crate because you have 3 milk cartons with a combined total usage of 8
Shopping List Board and HUD: Your folder also contains the Shopping List Board and HUD. If you plan to use the Shopping List Board or HUD, rez out however many boards you need and position them or wear the Shopping HUD and position it. The Shopping List Board and HUD menu and how to use them is covered below.
Once your Recipe HUB is setup, here are the typical steps to use it:
NOTE: If Breakout is “ON” in your Sorter, we recommend not using that sorter to connect to a recipe HUB because the Recipe HUB will not be able to find certain items. For example, if you’re making ale the Recipe HUB is looking for “Beer Keg” but your Breakout Sorter has “Beer Keg 2020” or “Beer Keg 2021” etc. and not just “Beeg keg.” If you wish to keep collectables sorted by year, setup a separate Sorter for your collectables that does not have the Recipe HUB script in it and put items you wish to cook with in another Sorter.
An optional part of the initial setup is to rez out position savers at various locations allowing you to “call” your recipe hub. If you only have one cooking location and use only one recipe hub, this is not necessary. However, if you have multiple cooking locations or use multiple recipe hubs, then continue with this section.
Rez out a Hub Pos Saver (POS) at each location where you think you’ll need to call a recipe hub. The arrow on the POS points to the top (where rows 1, 2, and 3 of the recipe hub will be).
The POS is set to Name Call, meaning it will only call a Recipe HUB if the Recipe HUB has a recipe loaded or if you have used the *standby notecard inside the Recipe HUB to name it.
POS indicator colors:
You can access the POS menu by doing a “Long Click” on the POS. A long lick means click and hold for a few seconds and then release to bring up the menu.
Done = Closes the menu.
Call All = Calls all hubs to the POS.
Open/Close = Changes the appearance of the POS.
Public = Puts the POS in Public mode meaning it will call the named Recipe HUB belonging to the person who clicks on the POS. This is handy for public kitchens or locations where multiple people might be cooking and crafting on the same farm.
Owner = Puts the POS in Owner mode meaning it will only call the Owner’s HUB if the HUB is named.
Now that your Sorter is setup to talk to the Recipe Hub, rez the item called Recipe Hub out on the ground and let’s take a tour of the buttons.
Rez Toggle = This is a toggle so normally clicking it once puts the HUB in rez mode and will rez items loaded into it as they are needed. Clicking this button again, turns off the rez mode.
Get Recipe = This button allows you to get recipes from VM Design’s servers. On click you will get a popup with a text block. Type in any portion of the name of a recipe and click Submit. You’ll be shown a list of recipes that match your keyword(s). Select the one you want and let it load into your Hub. This is the best way to get recipes
Test Req = This is the main button you should use when requesting items from your sorter. It opens a popup and asks you to enter the number of items you wish to cook. Then the Recipe Hub will do a “test request” from your Sorter based on the recipe and report the findings to local chat. If Auto Req (Auto Request) in the Extras menu is On and you have enough items, the HUB will automatically pull those items from your sorter and load them into the HUB.
Rez Clear = The hub will not rez a new item if it detects a previously rezed item on the sim. If you’re the item owner, you can simply pick up the previously rezed item. However, your admins can’t pick up your items so this button allows admins to clear currently rezed items from the hub’s memory (basically telling the Recipe HUB to ignore the currently rezed items). To use Rez Clear, click the specific number on the Hub for the un-rezed item and then click Rez Clear
Clear Rec = Clears the current recipe.
Replace = Checks your Reduced Uses sorter (if used) first and then your main sorter to pull any items needed to continue cooking. Click on the Recipe Hub number where you need the item to appear and then click the Replace button.
Restock = Checks your Sorter(s) for boxed up items and will restock them. You click the slot first and then the Restock button. For example, you’re making 20 items of a recipe and slot 6 needs milk crates. You only have 2 milk crates in your Sorter, good for 8 items (milk crates are 4 uses each) but you know you have 100 milk crates boxed up in that same Sorter. You click slot 6 on the Recipe HUB and then click the Restock button and the Sorter will pull the boxed up milk, unpack it, and restock your milk. Then you can do your Test Req (test request) and press on with your cooking.
Max = Shows you in local chat the maximum number of items you can make for the currently loaded recipe.
Shop On = Turns on the Shopping Board/Hud function. When On, this button changes to Done Shop to turn off the shopping mode.
Done = Closes the menu. NOTE: When you are finished with a popup menu, it’s best to use the Done button. If you click Ignore, the menu timeout timer is still running and you may get a popup later saying the menu has timed out. If this happens, click OK on the popup.
Extras = Opens the Extras Submenu.
RU Request Notes: The recipe HUB and RU sorter attempts to determine how many uses an item has and the HUB uses that value to pull items from the sorter. Most of the time, the number will be accurate; however, differences in some DFS items might cause an issue at various times. Also, keep the following situations in mind.
Notecard = Opens the Notecard Submenu.
Admin = Opens the Admin submenu:
NOTE: Some people like to use separate hubs for specific items such as a Prep Items Hub, Main Dishes Hub, Crafting Hub, etc. You can edit the *Standby notecard changing what’s shown on the Name line in the notecard to have it display as hover text on your hub identifying what that hub is used for. Just use Read NC when you’re finished cooking and select the *Standby to have this text always displayed.
If you have your recipe HUB on Group access so group members can use it, please keep the following in mind:
*Note* You only need to use recipe notecards if you have old items that you need to use so you need a custom NC or you are having people use Group Access to cook. Otherwise, you can skip the notecard and use the Get Recipe button described above.
Notecards contained in the Recipe Hub require a specific format so let’s cover those first. Here is a sample notecard for the Cranberry Smoothie recipe.
Recipe:DFS Smoothie Cranberry
Station:DFS Freezer
Time: 02 Min
No RU: 4
1:DFS Cranberry Basket|4
2:DFS Yogurt - Plain|4
3:DFS Ice Tray|1
4:DFS Honey Jar|1
5:DFS Milk Crate|4
--------------------
The first line needs to have the tag “Recipe” a colon and then the recipe name. The recipe name after the colon can be anything you wish. In this example we use “DFS Smoothie Cranberry” but you could use “Cranberry Smooth” or “Cran Smooth” if you like.
The second line uses the tag “Station” and a colon and then whatever station you’re going to use to cook or craft. You can use any name you like after the colon such as “DFS Stove” “Stove” “Frying Pan” “Waffle Iron” “Ice Box” “Freezer” etc.
The third line is the cooking time (2 minutes).
The fourth line is the number of items to cook or craft so you won’t have any ingredients with Remaining Uses (no left overs). In this case, you can make 4 Cranberry Smoothies which will use all the rezed ingredients with no leftovers.
The remaining lines have a number (for the HUB slot number) and then a colon. After the colon is the exact name (and it must be exact) of the item as it’s stored in your Sorter. After the name is the pipe symbol which looks like | and then after that is the number of uses for the item. If there’s no pipe and number the Recipe Hub assumes 1 use.
NOTE: Because the Recipe Hub needs to pull from your Sorter, the item name must match the crate name for that item. For example, DFS Beer Keg 2019 is just listed as DFS Beer Keg (the 2019 is dropped). If you’re not sure what an item is named or if your Hub is not pulling the item from your Sorter, click Assign, a random slot number, and then click the crate on your Sorter and you’ll see the correct name in the listing.
The information in the first four lines will display in open chat when you request the items from your Sorter.
** Don’t worry -- you don’t have to type all this!! **
Creating Recipes Option 1:
Use the Get Recipe as Described above to pull a recipe from the VM Design’s servers. If you wish, you can then go to Extras and NC Text to have the recipe display in open chat. Then you can copy and paste this info in a notecard. However, if you wish to make recipe notecards, you can also use Option 2 below.
Creating Recipes Option 2:
The second way to create recipe cards for your Recipe Hub is to use the Notecard maker on the VM Designs webpage. Click on the menu item called “NC Maker.” Once on the NC Maker page, you have two options to find your recipe:
One you have the recipe, copy and paste it into a notecard, name the notecard, and put the notecard into your Recipe Hub. You may need to tweak the notecard to ensure it’s in the proper format as shown above. You can also delete any lines that do not have an ingredient after the slot number.
NOTE: If you have recipe notecards and they do not load properly and you see nothing but symbols as hover text above your HUB, it means you have a carriage return (ENTER) after the last line in your notecard. Edit the notecard and place the cursor at the end of the last line in the notecard and press Delete several times and then save the notecard.
The Shopping List Board & HUD work with the Recipe Hub and Sorter to create a shopping list of items you need (but don’t currently have in your Sorter) to make the selected recipe. The HUD is very handy because you can wear it and refer to it as you’re out shopping.
Rez the size of board you need or attach the HUD. Position the board or HUD where you wish and then you’re ready to start using these shopping list tools. The best way to learn about this feature is to walk through a typical, simple, scenario.
Let’s assume you wish to make some vanilla icing and pretend you have the following items in your sorter for the icing: 2 milk crates, 1 vanilla basket, and 1 butter. (Yeah, I know you’re short some stuff, but hang in there!).
NOTE: The following instructions refer to the “Shopping List Board” but the HUD works the exact same way.
Step 1 - Turn on your Shopping List Board by clicking the words at the top to get a menu and then clicking Turn On. The board should light up.
Step 2 - Turn on shopping mode in the Recipe Hub by accessing the Recipe Hub and clicking Shop On. You’ll see the menu changes a bit removing options that don’t apply and adding some new options.
Step 3 - Get the vanilla icing recipe (of course in actual use you’d get whatever recipe you want). You can use the Get Recipe button or, if you have a notecard with the recipe loaded in the HUB you can use the Notecard option.
Step 4 - Click the Assign button on the Recipe Hub (Assign appears after you turn Shop On) menu and you’ll get a popup asking how many you plan to make. In our example, we’re going to enter 4. When you complete this step you’ll see this information is assigned to the Shopping List Board and the text appears at the bottom of the board. In our case, the Shopping List Board shows “4 X DFS Icing Vanilla.”
Step 5 - Next we need to do a Test Request which will determine what items we have and don’t have. Click Test Req on your Recipe HUB menu and enter the quantity. In our example, we’re putting in 4 to make 4 vanilla icing.
NOTE: Remember above I said to pretend you have only 1 vanilla basket (the recipe to make 4 vanilla icing requires 2 baskets) and only 1 butter (the recipe requires 2). POOF! The Shopping List Board (or HUD if you’re wearing it and have it on) now lists 1 vanilla basket and 1 butter, which is what we need to obtain in order to make our 4 icings. NOTE: The new items added to the Shopping List Board (or HUD) will be listed in RED.
CAUTION: If you have a recipe pending and items listed on your Shopping List Board, the main prim on your Sorter turns RED. This means some of the crates in the sorter have fewer items than actually shown on the crate because the Sorter is committing some items to a pending recipe. The RED main prim on the Sorter is a signal to not use the sorter. Do not add items or remove items from the Sorter when the main prim is RED. Also, let any admins or those who have access to the sorter or your edit rights to not use the Sorter when the main prim is RED.
To continue with our example, we know from the Shopping List Board that we’re short 1 vanilla and 1 butter. We need to make the butter so let’s pull up the butter recipe on the hub and continue the above steps.
Step 5 - Access the Recipe Hub (it’s still in shopping mode) and get the recipe for Butter.
Step 6 - Click Test Req and enter the quantity desired to see if we have enough items to make butter.
NOTE: Remember, I said to pretend we only have 2 milk in our Sorter. 1 milk is already reserved to make the icing leaving us 1 milk free. However, butter takes 2 so we now see 1 x Milk Crate on our shopping list. The Recipe Hub keeps track of what’s in the Sorter and what’s already committed to another recipe.
Your Shopping List Board now displays a list of everything you need to make your 4 vanilla icing. This is a very simple list and a simple recipe, but you can see how handy this might be for complicated recipes.
The *Manual* Button = When the Recipe Hub is in Shop Mode (Shop On), you’ll also see a Manual button. This allows you to manually add any quantity of the current recipe to the Shopping List Board. This is handy if you wish to make a list of recipes for your helpers to make or as a reminder of things you need to make later. Simply have a Shopping List Board “On,” have the Recipe Hub in shopping mode, select a recipe, and enter the quantity and it will appear on the Shopping List Board.
Step 7 - As you obtain the needed items you can click the name of that item on the Shopping List Board (or HUD) and select “Remove” to remove it. This allows you to update your shopping list.
Step 8 - Once you have all the items needed, you can click Done Shop on the Recipe Hub to put it back into normal mode. This action also clears the RED prim on your sorter and releases any reserved items. Then you can use the Recipe HUB like normal.
The Shopping List Board has a few more options so let’s cover those buttons here.
Clicking an item on the Shopping List Board
Clicking the wording at the top of the Shopping List Board
Thank you for using a V M Designs product. We appreciate your business and your loyalty to our brand. We also value our customers, so if you have any problems or questions, your best source of help is:
Thank you again,
Vikk
Founder & Owner, V M Designs
Scripting - Vikktor Fairport (Vikktor.McDunnough)
Graphics & textures - Vikktor Fairport (Vikktor.McDunnough)
Documentation - Bobbie Xanti (WindRunner Shan)
And a special thank you to the beta testers, document reviewers, and other contributors to this project.