The 1.13/1.14/1.15/etc Port

[squeek502]

Figured I'd make an issue to coordinate/decide what all needs to happen for porting to the latest Forge version(s).

Things to decide:

• Is a 1.13 port worth it, or should AppleCore skip straight to 1.14?
  • Skipping to 1.14

Things to do:

• Figure out if anything has changed with how core mods interact with Forge
  • core mods now use javascript for ASM patching, example
• Update ASMHelper to work with 1.13/1.14 if necessary
  • Port of ASMHelper to Javascript in progress here
• Port the ASM patches:
  • BlockFood
  • ExhaustingActions
  • FoodEatingSpeed (also need to check if this is still necessary, but it probably is)
  • FoodStats
  • HungerHUD
  • PeacefulRegen
• Make sure that AppleCore incorporates/deals with any changes to vanilla mechanics in 1.13/1.14 (e.g. how health regen works, things like that). Check that constants in the API package still match the default values.
• Audit the API package to make sure the events still make sense, and to make sure AppleCore isn't duplicating anything new added to Forge
  • IEdible/IEdibleBlock still necessary?
  • ItemFoodProxy still necessary?
• Port the rest of the mod (should be pretty minimal outside of the ASM/API stuff)
  • Finish up all remaining TODO's

cc @primetoxinz @GirafiStudios @Cazsius

[squeek502]

Tried to get started with this, turns out probably the hardest part will be updating the build.gradle script for ASMHelper, as ForgeGradle and Gradle are much different now. Plus I completely forgot anything I knew back when I originally wrote that monstrosity, so it feels like I'm back to square one.

Maybe should look into a less hacky solution for including something like ASMHelper in a per-project manner.

EDIT: https://github.com/johnrengelman/shadow ?

[primetoxinz]

Frankly, you might not need ASMHelper. I'm not sure what the benefits of it were, but the new coremodding system in Forge is based in a sandboxed javascript loader.
If you are in need of assistance in porting I can help.

[primetoxinz]

Also, a 1.13 port is basically worthless. Forge has already moved on and it was not really stable during 1.13

[squeek502]

new coremodding system in Forge is based in a sandboxed javascript loader.

Whoops, didn't know that! Any docs for it? I was misled into thinking core mods hadn't changed by looking at a build.gradle of a 1.14 core mod and seeing FMLCorePlugin still in the manifest.

Looks like you're right that ASMHelper is worthless, or it would at least need a complete rewrite at this point.

If you are in need of assistance in porting I can help.

Pointing me in the right direction when I get stuck will help a lot. I haven't kept up with Forge changes at all and docs never seem to be easy to find.

[primetoxinz]

Unfortunately the docs on it are basically nonexistent.
The main repo for it has a scattered example, but it doesn't really explain anything: https://github.com/MinecraftForge/CoreMods
I managed to scrounge up the information from a bunch of mods that managed it somehow.
The basic requirements are as follows

- META-INF/coremods.json with a map of modid -> javascript file
This unfortunately means you can only have one .js file per

• After looking the coremod code I was actually wrong about this
  META-INF/coremods.json is a map of coremod name -> javascript file, a single mod can have as many different entries in this as they want.
• Put javascript anywhere in resources/, as long as the relative path is defined in your coremods.json
• You can't use nashorn's load functions to include additional js files
• Keep in mind that the java imports available in the sandbox are limited to the predefined list in net.minecraftforge.coremod.CoreModEngine

I used this as an example, it has a very simple coremod javascript file: https://github.com/TridentMC/FastBamboo
Mine is now signficantly more advanced than that example and might be more useful: https://gitlab.com/BetterWithMods/1.13/betterwithmods/blob/dev/projects/Core/src/main/resources/javascript/betterwithmods_core.js

If this doesn't really fit your style, it might be possible to register your own system for loading coremods but I imagine no one surrounding forge would be willing to give advice in that effort.

[squeek502]

Thanks for all the info @primetoxinz

Here's the branch I'm working in: https://github.com/squeek502/AppleCore/tree/1.14.3

[squeek502]

Ok, I think I finally have a solid path forward for this. Rewriting the transformers from scratch using Javascript sounds like a complete nightmare, so I think it's worth porting ASMHelper to Javascript so that the transformer code can be ported closer to 1:1. I've started porting ASMHelper here, and have set it up so that it's possible to port the ASMHelper tests as well to make sure the functionality stays the same. Here's the toMethodDescriptor test file for example:

var ASMAPI = Java.type("net.minecraftforge.coremod.api.ASMAPI");

function initializeCoreMod() {
	ASMAPI.loadFile('../../main/javascript/asmhelper.js');
	ASMAPI.loadFile('jankytest.js');

	assertEquals("(Linternal/class/name;Lclass/descriptor;)Lclass/name;", ASMHelper.toMethodDescriptor("class.name", "internal/class/name", "Lclass/descriptor;"));
	assertEquals("(FZ)V", ASMHelper.toMethodDescriptor("V", "F", "Z"));
}

See squeek502/ASMHelper@1d4a4e8 for some more context on how it's set up.

So the next step is getting ASMHelper ported fully to Javascript. After that, porting the AppleCore transformers to Javascript should be much easier.

[squeek502]

Stalled due to MinecraftForge/coremods#26

[James103]

@squeek502 Are you also porting to 1.15.2?

[squeek502]

Yeah, would probably just skip to 1.15 at this point. Still effectively blocked by MinecraftForge/coremods#26 though.

[James103]

Is it possible to port this to Fabric, or will it forever be Forge-only? A Fabric port may or may not work around the mentioned bug.

[squeek502]

Fabric port would definitely not have the same problem.

I'm not very involved in Minecraft modding anymore, and at this point am basically just updating my existing mods to newer versions, nothing more. I'm all for creating a Fabric version, but someone else would have to take the reins on that.

[Insane96]

Still effectively blocked by MinecraftForge/CoreMods#26 though.

That's sad, I was really looking forward to add lots of mechanics to Iguana Tweaks Reborn thanks to this

[Parker8283]

Hello friends, long time no see. A long time ago in a galaxy far far away, I made MinecraftForge/MinecraftForge#1758, which was the PR to lift the AppleCore changes up to Forge. However, I borked the PR and said I would fix it "tomorrow". Well, I guess tomorrow meant 5 years later, but now we are here! I am once again attempting to lift the core parts of the AppleCore API into Forge so that everyone can enjoy it and we can avoid the whole ASM problem altogether!

Currently, I have this branch that is my working branch. As of today, I think I have lifted the core parts and updated them to work better in the newer MC versions. I would love the feedback of the people who have helped to work on this mod and probably understand it better than I do. Just to make sure I don't miss anything or make some catastrophic errors. My goal is to make the PR to Forge by the end of this week. If anyone could spare any time and leave some comments for me, I would greatly appreciate it. I'm also in the SlimeKnights Discord if you wanted to do some closer-to-real-time chatter, do so in #progs-other-mods. Or you can DM me :)

Either way, just wanted to leave this here. Don't mean to pull the rug out from underneath this project, but I think our goal back in the day when squeek, prog, and I were updating Hunger Overhaul for 1.7 was to upstream these changes. Just never got around to it. Now with the new JS system, seems like a good time to try again!