Add recipe support #5204

Pikachu920 · 2022-11-13T05:02:02Z

Description

Adds recipe creation section like this:

on script load:
  create a crafting recipe:
    key: "dirty-diamond"
    result: diamond named "Dirty Diamond"
    ingredients:
      dirt, dirt and dirt
      dirt, diamond and dirt
      dirt, dirt and dirt
	  
  create a furnace recipe:
    key: "dirty-diamond-boots"
    result: diamond boots named "Dirty Diamond Boots"
    ingredient: diamond
    cook time: 1 second
    xp: 500
	
  create a campfire recipe:
    key: "chainmail-boots"
    result: chainmail boots
    ingredient: diamond boots
    cook time: 1 second
    xp: 500

Target Minecraft Versions: Any
Requirements: N/A
Related Issues: probably but I'll find them later

src/main/java/ch/njol/skript/sections/SecRecipe.java

Ankoki · 2022-11-15T19:41:48Z

Just a suggestion but do you think it would be worth this being a structure when they're released? I feel like as these aren't dependent on any event these can be utilised.

on join:
    send "§eWelcome §7%player%§e!"

create crafting recipe for gold sword with key "test":
    dirt, dirt, air
    air, dirt, air
    air, air, air

I just feel this is alot easier tbh, not that big of a difference but a nice enhancement to have

Fusezion · 2022-11-15T19:46:25Z

Just a suggestion but do you think it would be worth this being a structure when they're released? I feel like as these aren't dependent on any event these can be utilised.

https://discord.com/channels/135877399391764480/836220422223036467/1041449280776458300

I believe there was talk about whether they should be made as a structure but from what I remember we mostly put it down
not fully sure what the reasons were

Ankoki · 2022-11-15T19:56:41Z

I believe there was talk about whether they should be made as a structure but from what I remember we mostly put it down not fully sure what the reasons were

I see the reasoning here tbh, however arent structures able to be used as sections? i could be missing the ballpark completely but supporting both seems like something that structure is in range for, and if not that would be a nice imrpovment to structures

Fusezion · 2022-11-15T20:17:05Z

I believe there was talk about whether they should be made as a structure but from what I remember we mostly put it down not fully sure what the reasons were

I see the reasoning here tbh, however arent structures able to be used as sections? i could be missing the ballpark completely but supporting both seems like something that structure is in range for, and if not that would be a nice imrpovment to structures

I'm aware that you can add the entry stuff as it's public but structures are top level events so they should be limited to the same area events, functions and commands are right?

Fusezion · 2023-03-21T17:15:37Z

Noo! we want theses

src/main/java/ch/njol/skript/sections/recipe/SecCookingRecipe.java

TheLimeGlass

There should also be a Structure for recipe registration. This will allow for parsing time registration. Makes it easier and simpler for users while also having the sections.

Tests can be added.

src/main/java/ch/njol/skript/sections/recipe/SecCookingRecipe.java

src/main/java/ch/njol/skript/sections/recipe/SecShapedRecipe.java

src/main/java/ch/njol/skript/sections/recipe/SecCookingRecipe.java

sovdeeth · 2023-03-25T02:33:08Z

State of the syntax at time of writing:

create a crafting recipe for diamond named "Dirty Diamond" with the key "dirty-diamond":
    shape:
        dirt, dirt and dirt
        dirt, diamond and dirt
        dirt, dirt and dirt

Personal thoughts on the existing syntax:

I like that's it's a section. Most use cases of custom craft involve specific items that are rather unwieldy as literals (or impossible to write as literals), so the ability to use expressions and variables in the ingredients is, in my eyes, a key and essential feature.
I like that it's easy to see the recipe at a glance. Laying it out in a 3x3 makes it much easier to read and see what the shape looks like, versus a 1x9 list.
I'm not a huge fan of shape:. Since it's the only field in the section, I think it's rather superfluous. I get the idea that it's kind of a lead-in to writing the shape, and kinda takes the place of with the shape "XYZ", but since it's the only thing you're going to put there anyway it feels more like just an unnecessary word to type than a helpful label. If there was a result field too, it'd make more sense in my opinion.
- After slight discussions w/ pickle and pikachu, I also like the idea of keeping shape: but also moving result: into a field instead of in the parent node.

create a crafting recipe with the key "dirty-diamond":
    result: diamond named "Dirty Diamond"
    shape:
        dirt, dirt and dirt
        dirt, diamond and dirt
        dirt, dirt and dirt

I'm ok with the lack of an effect to start the shape lines. It's a new thing for skript, but I don't think it's bad. The section kind of acts like the effect for all the shape lines, making this more like a multi-line effect. I think it's intuitive and makes sense. However, I do have some alternatives if others find this too much of an upheaval.

Personal thoughts on additions:

I agree that a structure version could be useful. However, if it doesn't allow expressions in its ingredients, as I understood is the case in a discord discussion, it'd be rather limited to just very simple recipes of generic material to generic material. This doesn't mean it's not worth adding, it's just that we should make sure it's well documented to ensure that the section's abilities and the structure's abilities are not confused.
For the shape lines, my alternative suggestion:

crafting recipe:
    set [ingredients of] row 1 to x, y, z
    set [ingredients of] row 2 to x, y, z
    set [ingredients of] row 3 to x, y, z

This is mainly just to change the section as little as possible, but allow it to maintain the property of having an effect/section on each line of code. It could be extended with:

crafting recipe:
    set ingredients to x, y, z, a, b, c, 1, 2, 3

if desired.

To summarize:

I like the current implementation of the syntax, minus the shape: bit, which I find a bit unnecessary (edit: I think including both result: and shape: is the best option). I think the lack of effect on the shape lines is perfectly fine, though I have an alternative if needed. In my experience, specific custom items are very commonly used in custom recipes, which means that if a structure was made, it'd be of somewhat limited use and would have to be well documented as to the differences with the section version. I don't think that's a reason not for it to exist, though.
All in all, I think this is a valuable addition to skript, and I like the current direction.

TheLimeGlass · 2023-03-25T10:09:49Z

Potentially add support for KnowledgeBookMeta? #617

TheLimeGlass · 2023-03-25T11:46:01Z

Issue related #5261

Pikachu920 · 2023-06-11T19:28:29Z

src/main/java/ch/njol/skript/effects/EffDiscoverRecipe.java

+	static {
+		Skript.registerEffect(EffDiscoverRecipe.class,
+			"make %players% (discover|unlock) recipe[s] %strings%",
+					"make %players% (undiscover|lock) recipe[s] %strings%",


whitespace is messed up

Pikachu920 · 2023-06-11T19:29:21Z

src/main/java/ch/njol/skript/effects/EffDiscoverRecipe.java

+	@SuppressWarnings("unchecked")
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
+		discover = matchedPattern % 2 == 0;
+		players = (Expression<Player>) exprs[matchedPattern <= 1 ? 0 : 1];


store the condition in a variable

Pikachu920 · 2023-08-07T04:59:51Z

src/main/java/ch/njol/skript/sections/recipe/SecCookingRecipe.java

+		}
+
+		try {
+			Bukkit.getServer().addRecipe(recipe);


check this? it seems to return a boolean not throw an exception now that i look again

sovdeeth · 2024-07-16T06:47:51Z

Closing due to inactivity.

Pikachu920 force-pushed the feature/crafting branch from 097b075 to 450e304 Compare November 13, 2022 05:04

Add SecRecipe

00e8d53

Pikachu920 force-pushed the feature/crafting branch from 450e304 to 00e8d53 Compare November 13, 2022 05:06

Pikachu920 commented Nov 13, 2022

View reviewed changes

src/main/java/ch/njol/skript/sections/SecRecipe.java Outdated Show resolved Hide resolved

Pikachu920 commented Nov 13, 2022

View reviewed changes

src/main/java/ch/njol/skript/sections/SecRecipe.java Outdated Show resolved Hide resolved

AyhamAl-Ali added the enhancement Feature request, an issue about something that could be improved, or a PR improving something. label Nov 13, 2022

TheLimeGlass mentioned this pull request Dec 23, 2022

Add recipes #5261

Open

1 task

TheLimeGlass added the 2.8 Targeting a 2.8.X version release label Jan 3, 2023

Pikachu920 closed this Mar 21, 2023

Pikachu920 reopened this Mar 21, 2023

Try out a new approach

6a170cb

Fusezion reviewed Mar 25, 2023

View reviewed changes

src/main/java/ch/njol/skript/sections/recipe/SecCookingRecipe.java Show resolved Hide resolved

TheLimeGlass requested changes Mar 25, 2023

View reviewed changes

Switch to using EntryValidator

d3fa76d

Pikachu920 changed the title ~~Add SecRecipe~~ Add recipe support Mar 25, 2023

Pikachu920 added 6 commits March 26, 2023 20:14

Update key encoding mechanism

61d09c4

Remove debug var

28ad77a

Address reviews

f0ea27e

Silently fail for empty keys

4298a15

Add discovered recipe syntaxes

604c733

Add license header

6dc787c

Pikachu920 marked this pull request as ready for review May 3, 2023 02:57

Pikachu920 commented Aug 7, 2023

View reviewed changes

Moderocky force-pushed the master branch 2 times, most recently from bd134d0 to 3f08853 Compare September 16, 2023 16:59

Moderocky changed the base branch from master to dev/feature September 18, 2023 09:45

Moderocky requested a review from TheLimeGlass September 18, 2023 09:45

sovdeeth removed the 2.8 Targeting a 2.8.X version release label Dec 30, 2023

sovdeeth closed this Jul 16, 2024

APickledWalrus deleted the feature/crafting branch October 13, 2024 18:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add recipe support #5204

Add recipe support #5204

Pikachu920 commented Nov 13, 2022 •

edited

Loading

Ankoki commented Nov 15, 2022 •

edited

Loading

Fusezion commented Nov 15, 2022

Ankoki commented Nov 15, 2022

Fusezion commented Nov 15, 2022

Fusezion commented Mar 21, 2023

TheLimeGlass left a comment

sovdeeth commented Mar 25, 2023 •

edited

Loading

TheLimeGlass commented Mar 25, 2023

TheLimeGlass commented Mar 25, 2023

Pikachu920 Jun 11, 2023

Pikachu920 Jun 11, 2023

Pikachu920 Aug 7, 2023

sovdeeth commented Jul 16, 2024

Add recipe support #5204

Add recipe support #5204

Conversation

Pikachu920 commented Nov 13, 2022 • edited Loading

Description

Ankoki commented Nov 15, 2022 • edited Loading

Fusezion commented Nov 15, 2022

Ankoki commented Nov 15, 2022

Fusezion commented Nov 15, 2022

Fusezion commented Mar 21, 2023

TheLimeGlass left a comment

Choose a reason for hiding this comment

sovdeeth commented Mar 25, 2023 • edited Loading

State of the syntax at time of writing:

Personal thoughts on the existing syntax:

Personal thoughts on additions:

To summarize:

TheLimeGlass commented Mar 25, 2023

TheLimeGlass commented Mar 25, 2023

Pikachu920 Jun 11, 2023

Choose a reason for hiding this comment

Pikachu920 Jun 11, 2023

Choose a reason for hiding this comment

Pikachu920 Aug 7, 2023

Choose a reason for hiding this comment

sovdeeth commented Jul 16, 2024

Pikachu920 commented Nov 13, 2022 •

edited

Loading

Ankoki commented Nov 15, 2022 •

edited

Loading

sovdeeth commented Mar 25, 2023 •

edited

Loading