This document describes the Recipes Database feature that is accessible from BagApp and My Guild applications. It attempts to bridge differencies between KipeeCraft recipes and in-game Recipe-Book. It allows you to import, export and share your recipes as well as check your inventories for required recipe ingredients. On the other side the aim of the application is not to work as a tool to develop recipes.
The database allows import and export from and into formats supported by both other tools. This is not easy because both tools focus on something a little different. This is solved by a recipe analysis that tries detect possible issues and offer you solutions.
To make the database as most universal as possible it supports all crafting plans including those that are currently not possible to learn for Atys characters. Please take a look at Supported crafting patterns
The aim of KipeeCraft is to give you a tool to develop recipes that is based on patterns, a prescription how many of which type of ingredient belongs to a recipe. This means that KipeeCraft do not care about recipe composition limits based on a plan and also that one pattern might work for multiple crafting plans. For example, a Medium Quality Sleeves recipe will work the same for Basic Quality Vest.
At this moment, the import of single or multiple recipe files (packed in a ZIP archive) is supported along with import of the recipe content as a text. It was tested with recipes exported from KipeeCraft 1.2, 1.2 BETA!, 1.1 and 0.9 so the system should be able to properly import all your recipes including those with damaged or invalid list of ingredients, with loss of unidentified parts.
Note: File import is not available when used in-game because the client does not allow to upload files.
Export into KipeeCraft format is limited by existing ID that represents a pattern. In case the recipe does not match any ID the system will offer you options to convert the recipe into another suitable plan. KipeeCraft do not support recipe tags or groups but it is possible to store these information in the recipe comment. There is also no support for special ingredients like outpost materials because it does not play any role in final item colour or statistics. This information will be lost on conversion to supported pattern ID. KipeeCraft does not support Generic Raw Materials as an ingredient and this information will be lost on export.
Note: File export is not available when used in-game because the client does not allow to download files.
The in-game tool for recipes management is, unlike the KipeeCraft, sort of generator based on all possible but not necessary available ingredients and existing crafting plans. This means that you are able to create a recipe that is composed of materials that are not available to harvest on Atys. It also means that a Tryker boots recipe is something different than Matis boots recipe.
The Recipe Database supports import of both formats that the Recipe-Book allows to export in. You can import your recipes as text or as a single or multiple files (packed in a ZIP archive). Unidentified recipe ingredients will be lost on import.
Note: File import is not available when used in-game because the client does not allow to upload files.
Exporting a recipe into Recipe-Book format always require you to select a target crafting plan. The format do not support „PatternOpt” option used by KipeeCraft and this information will be lost on export, however plays no role in recipe composition or statistics. Virtual group is not supported but can be transformed into another tag.
Note: File export is not available when used in-game because the client does not allow to download files.
To import your recipes, navigate to the Recipes Database clicking the link in the main menu and then click the Import link in Right section menu.
As first you need to choose KipeeCraft or Recipe-Book format and select one of available import options. Import of a recipe hash is not yet supported.
KipeeCraft recipes
- Single recipe file allows you to upload single recipe file saved by KipeeCraft. This is not available in-game.
- Multiple recipe files packed with .zip allows you to upload multiple recipe files saved by KipeeCraft and packed in a ZIP archive. This is not available in-game.
- Recipe as text allows you to insert content of any KipeeCraft recipe file as plain text.
Recipe-Book recipes
- Recipe as text allows you to insert recipes export in textual format.
- Recipe as text in JSON format allows you to insert recipes export in JSON format.
- Recipe in a JSON data file allows you to upload single JSON file with recipes. This is not available in-game.
- Multiple recipes in a JSON data files packed with .zip allows you to upload multiple JSON files with recipes and packed in a ZIP. This is not available in-game.
As next step you need to provide a data with recipes, either as text or as a file. Click the Change method link to start over with Step 1. Once you are done click the Import button and given data will be processed. The import itself has some additional options that you can use:
- Recipe group allows you to add all imported recipes into one group. Select one of existing or insert a name to create new. You can change/remove that later for each recipe.
- Share with option gives you a way how to share your recipes. Select one of available options to set sharing for imported recipes.
- Add source info to recipe description checkbox will add a recipe source information, for example recipe file name, into its description text.
The Recipe Database allows you to browse all imported recipes along with all other recipes that are visible for your character via sharing of others. This means that you will also see recipes shared for everyone, for your guild by one of your guild members or for you by another Homin. The Recipe Browser is separated into categories and give you additional customization and filter options via ☑ Recipe DB Options.
To see a recipe details, click its name. You will be able to see all recipe details, tags, forum code with link for others, recipe composition including information about stored ingredients and (optionally) existing watchdog rule details. In case the recipe belongs to a virtual group, all other recipes in the same group are listed below.
To edit some recipe details click the Edit link either in the recipes browser or in Right section menu in a recipe details. Edit allows you to convert the recipe into different pattern that fits current composition. You can also edit recipe name, description and tags, create/change/remove its virtual group. You can also change the recipe share options. Change of the recipe composition is not possible.
To export a recipe, navigate to the Recipes Database clicking the link in the main menu, select the recipe category and click Export link by the recipe in the list. Other way is to click on Export link at the Right section menu of the recipe details page. The function itself supports export of multiple files however there is no user interface yet to set such options.
As first you need to select a format you want to export your recipe to. The system shows you list of issues expected during export into one or another format, however the system will allow you to export the recipe even with critical errors, as best as possible:
- Critical error, marked with red colour. Following issues will not be possible to solve and create a proper export. It depends on the target tool how it will handle these issues and you should expect information loss. Critical errors are mostly rare and are usually caused by broken recipes.
- Export warnings, marked with yellow colour. These issues will lead to a data loss on export, however it will not affect the recipe itself and the target tool should be able to properly identify and import the data you will export. It is common to see this type of issue because of any difference in recipe formats.
- Correctable issues, marked with green colour. All following issues can be corrected by some additional options in Step 2. It is common to see this type of issue.
In this step you can select a way how the export will be delivered. Please note that all exports into files is disallowed when used in-game because the client do not support downloading files. Format specific options include all additional options that you can use to correct detected issues. Once you are done with all settings, click the Export button to start the export.
All documents