RecipeManager

Workbench

RecipeManager 2

Complex recipes made easy !


Features

NOTE: I will refer to some .html files in here, those files can be found in your /plugins/RecipeManager/ folder after you loaded the plugin the first time. The html files will also be updated automatically on new versions.

  • Add new recipes:
    • Shaped or shapeless recipes with optionally multiple results;
    • Furnace recipes with optional custom cook time and optional special fuel;
    • Fuel recipes with custom burning time or even random time from specified range.
    • See 'basic recipes.html' for more info.
  • Making recipes more special with flags, featured flags:
    • @permission to limit a recipe (or result) to specific permission node(s);
    • @remove, @restrict and @overwrite to remove/restrict/overwrite existing recipes, including Minecraft recipes.
    • @ingredientcondition to make extra requirements from ingredients like enchantments, ranged data values, stack amounts, etc;
    • @keepitem to keep an ingredient from using up and optionally damaging it in the process;
    • @modmoney/@reqmoney and their experience and level counterparts to require/give/take money/exp/level from crafter;
    • @cooldown to limit the usage of the recipe;
    • And a lot more, see 'recipe flags.html' for all of them including documentation.
  • Flags can also be added to results to make them more special, some featured result flags:
    • @cloneingredient to clone an ingredient's features over to the result, like data value, amount, enchantments, etc;
    • @itemname and @itemlore to edit a result's display name and description with colors;
    • @potionitem and @fireworkitem to design your custom potions and fireworks;
    • @getrecipebook to get a RecipeBook as result, ones generated by this plugin with recipes in them;
    • And a lot more, see 'recipe flags.html' for all of them including documentation.
  • Flexible recipe files to add your recipes in:
    • You can use any kind of spacing and letter casing you want in recipe files, also supports comments;
    • Design your file names and folder structure as you want in the 'recipes' folder;
  • Auto-generated recipe books with high customization:
    • Pick which recipes to be added and to what volume;
    • Re-arrange them as you like;
    • Books that players have are automatically updated when edited by admin and reloaded;
    • For more information see 'recipe books.yml' file.
  • Other features:
    • Local documentation files for ease, the .html files that will be generated the first time you run the plugin;
    • Customizable settings, messages and item/data/enchant aliases in their respective YML files;
    • Supports Vault for economy and permission groups;
    • API for plugin developers, custom events and utility methods for most features;
    • MCStats / Metrics: http://mcstats.org/plugin/RecipeManager


Installing or updating

  1. Download the latest version of the plugin
  2. Place the RecipeManager.jar file in the plugins folder and start/restart the server
  3. Now the plugins/RecipeManager/ folder is created which contains configuration files (.yml) and documentation files (.html)

NOTE If you're upgrading from 1.x versions of RecipeManager, please first delete all files and folders except recipes folder from your RecipeManager folder before installing version 2, this will keep your folder clean because a lot of files have been renamed and this way will be less confusing.

Also some recipes or flags might not work like in 1.x versions, please re-test your recipes.


Using the plugin

  • Run the plugin at least once to allow the .html files to be generated then start with 'basic recipes.html'.
  • Plugin settings can be configured in "plugins/RecipeManager/config.yml"
  • When you're done editing, type rmreload in server console to reload everything without a server restart.
  • Commands and permissions can be found in 'commands & permissions.html' file.


Tutorials, example recipes, tips and tricks

User-contributed resources in the Resources forum section.


Changelog

In the jar file, auto-extracted when first ran to plugins/RecipeManager/changelog.txt and on GitHub: https://github.com/haveric/RecipeManager2/blob/master/mods/bukkit/src/changelog.txt


Having problems, found bugs ?

If you have any issues or found some bugs, please create a ticket. But first you should check other tickets if the issue has been already reported. Also check the latest file's known caveats (under changelog) before posting a ticket.

Note: I don't support any previous versions other than the absolute latest, so if you used a older version, update and test again :P


Source code

Source code is on github, feel free to look at it, improve on it and provide feedback: https://github.com/haveric/RecipeManager2 If you need, you can use code from my project but please give credits.


Support project

If you feel I deserve:

https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif

Thanks for your support !

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of haveric haveric Jul 05, 2015 at 19:02 UTC - 0 likes

    @RagingCat: Go

    It is limited by Minecraft/Bukkit as they use a short to represent the cook/burn times. Some quick math shows that you should be able to get a little over 27 hours at a max time, but I have not tested that. It wouldn't be too hard to make a furnace that is infinite or that lasts longer than that limit (you just have to reset it each time it runs out or gets below a certain point). I haven't really looked into making it last longer as nobody has requested it until now and it adds more complexity to furnaces. My main concern though is that it is already difficult to tell how long furnace recipes and fuel take when they are longer than the default times. Finding a good way to portray this information would make it a worthwhile feature.

  • Avatar of RagingCat RagingCat Jul 05, 2015 at 16:12 UTC - 0 likes

    @haveric: Go

    About fuel. The time doesn't go very high (into hours/days/months). Is that a limit decided by the plugin or the bukkit/spigot itself? Cause I would really like if I could make public furnaces last for such long time that it looks as if they're infinite.

  • Avatar of haveric haveric Jul 04, 2015 at 13:46 UTC - 1 like

    @RagingCat: Go

    Whoops, looks like I forgot to update the config version. At the top of config.yml, change the version number to 2.5 and it will stop complaining. (Edit: I'll have this fixed for the next release. As long as you see recipe-comment-characters in there, you can safely ignore the message.)

    For empty lore lines, I believe the only way to do this is to use a color like this:

    @lore &dtest1
    @lore &d
    @lore &dtest2
    
    Last edited Jul 04, 2015 by haveric
  • Avatar of RagingCat RagingCat Jul 03, 2015 at 14:55 UTC - 0 likes

    @haveric: Go

    Thank you, that was really helpful. :)

    I don't have any other questions (yet, lol). I'll edit this comment if I come up with a problem.

    EDIT: the new update made me feel like you're spying on our recipes hahaha I was literally making sugar into flour then I saw the update changes. Also the 2.5 version says I have outdated config.yml even thought I deleted it (I even deleted the whole folder)

    BTW. how do you skip a line in lore?

    Last edited Jul 04, 2015 by RagingCat
  • Avatar of haveric haveric Jul 03, 2015 at 13:29 UTC - 1 like

    @RagingCat: Go

    You'd want something like this:

    craft
    cobblestone + cobblestone
    = cobblestone
    @lore &dtest1
    
    craft
    cobblestone
    cobblestone
    = cobblestone
    @lore &ctest2
    
    craft
    @displayresult first // Makes it so it shows the first result that is valid instead of multiple results
    cobblestone
    = furnace
    @ingredientcondition cobblestone | lore &dtest1
    = cobblestone_stairs
    @ingredientcondition cobblestone | lore &ctest2
    

    You can change up how you're creating the ingredients however you want and you can add any number of results that you want as well. Let me know if you need any more help or just want to know if something is possible with RecipeManager.

  • Avatar of RagingCat RagingCat Jul 03, 2015 at 09:21 UTC - 0 likes

    @haveric: Go

    Thanks, one more question. Can I use the same item for example cobblestone with different lore to craft different items. By that I mean if I use cobblestone with lore "test1" I can craft a furnace or something, but if I use cobblestone with lore "test2", then I can craft let's say stairs.

  • Avatar of haveric haveric Jul 03, 2015 at 03:55 UTC - 1 like

    @RagingCat: Go

    You will want something like this:

    @override // This has to be at the top of the file to 
    // cause all recipes in the file to be overridden 
    // (or after the craft/combine/smelt line of individual recipes)
    
    craft
    air + book:0 + air
    diamond:0 + obsidian:* + diamond:0
    obsidian:* + obsidian:* + obsidian:*
    = enchantment_table:0:1
    @lore Crafted by: {player}
    
    smelt
    cobblestone:*
    = stone:0:1
    @lore Crafted by: {player}
    @permission foo.bar
    

    You'll have to add all of the recipes you want to add the lore/permission to, but this should be pretty easy with the /rmextract command.

  • Avatar of RagingCat RagingCat Jul 01, 2015 at 20:11 UTC - 0 likes

    @haveric: Go

    Where do I add the permission? Do I make a new smelting recipe that is same as vanilla for my case and just add the permission to that?

  • Avatar of haveric haveric Jul 01, 2015 at 15:27 UTC - 1 like

    @daryllooi: Go

    I don't believe this is possible with RecipeManager at this time. There might be a plugin that does this based off of custom lore, but I haven't looked into that.

  • Avatar of haveric haveric Jul 01, 2015 at 15:23 UTC - 1 like

    @RagingCat: Go

    There isn't an easy way to apply a lore to all recipes, but you can export all recipes using /rmextract and copy that file out of the disabled folder. Enable the @Override at the top of this file in order to override the existing recipes. Then just add the following after each result

    @lore Crafted by: {player}
    

    Note that by adding the crafted by lore, they will not stack if crafted by two different people.

    For the permissions, add

    @permission foo.bar
    

    where foo.bar is the permission node you want to have access to that recipe. If you get stuck, let me know and I'll see if I can help more.

Facts

Date created
Oct 11, 2011
Categories
Last update
Jul 03, 2015
Development stage
Release
Language
  • enUS
License
GNU Lesser General Public License version 3 (LGPLv3)
Curse link
RecipeManager
Downloads
46,537
Recent files
  • R: v2.5 for 1.8.1 Jul 03, 2015
  • R: v2.4 for 1.8.1 May 18, 2015
  • R: v2.3.4 for 1.8.1 Feb 18, 2015
  • R: v2.3.3 for 1.8.1 Feb 08, 2015
  • R: v2.3.2 for 1.8.1 Jan 26, 2015

Authors

Relationships

Optional dependency
Vault