Jump to content

Hooking my forge mod into a Bukkit plugin


Flenix

Recommended Posts

Hey guys,

 

Before I start this thread, I know a lot of people here don't like bukkit or don't "agree" with trying to connect the two. However, due to the nature of my mod, it would be stupid for me to not do this.

If you are opinionated against bukkit, please just keep it to yourself, I just want to get the issue solved without flame wars breaking out :P

 

Right, onto my issue;

 

I'm currently making an economy mod for Forge. It has physical money, which can be stored in a bank (with the balanced stored as NBT data on the player).

 

What I want to do, is add support for Bukkit plugins, if the server is running BukkitForge or MCPC+. For this, I have two options:

 

Option 1:

Hook Vault directly. This would mean that my economy mod would directly support the Vault API, and most bukkit plugins which have economy support will work with it. But, it would be hard to create new accounts on this system, unless I somehow allow players to have multiple accounts which I'm not quite sure how I would do...

 

Option 2:

Create an interfacing bukkit plugin. This would just be a simple bukkit economy plugin, designed to sync with my mod's balances. Using this, I could also have other accounts created very easily - which is essential for plugins like Towny or Factions.

 

 

In terms of Option 1, I did post on the Vault forums about how exactly I'd do that:

make the mod hook vault's economy service and register it into the bukkit service API.

 

What I don't understand is how I would hook Bukkit in the first place with a forge mod, without it being a dependancy. If Bukkit isnt' installed, my mod should continue without the bukkit support, I don't want it crashing if Bukkit isn't there.

 

 

As for Option 2, the main thing I can't figure out is how I would sync the accounts, and what would happen if a non-player account was created. The Forge side is stored as NBT on the player, in the /world directory, and the Bukkit side (I assume) would be stored in some sort of flatfile or db, in the /plugins directory. Both sides need to read each other frequently to check for changes, and sync accordingly. But what if the bukkit plugin creates a new account for a town with the name "Foobar"? There's no player called foobar, so what would the forge mod do when trying to sync that one? I can't just create the NBT... if a player made a town called "Notch" then Notch logged in, he'd have access to that towns money.

 

 

Final note, I have considered there might be issues with sync. For example, say an account has 300 in. If a town claims land and loses 15, but at the same time a player deposits 25 into their account, the numbers would both be off - bukkit would think it was 285 and Forge 325. I would handle this by storing a copy of the balance each time it syncs, then when it resyncs it checks that balance comapred to itself, and instead of saying "I'm 325", it would say "I have added 25". Bukkit would reply with "I have taken 15, so we are adding 10 to the existing balance" and they'd agree to sync on 310. Is that the best way of handling that scenario, or is there something easier? I don't want to sync too often, I was thinking every 5-10 seconds so it shouldn't cause any form of lag.

 

 

I'm open to any ideas, I'm really not sure how I'm going to do this integration at all. I'm pretty much just rambling now.. help! :P

width=463 height=200

http://s13.postimg.org/z9mlly2av/siglogo.png[/img]

My mods (Links coming soon)

Cities | Roads | Remula | SilvaniaMod | MoreStats

Link to comment
Share on other sites

I don't know anything about Bukkit, but I'll give my opinion (on your ideas :P)

 

Option 1:

Reflection.

If Bukkit are good and give an appropriate answer to their registering methods, this could be as simple as any code, except you catch more exceptions.

 

Option 2:

Brings the syncing issue.

I don't know how Forge+Bukkit would load mod+plugin (order, dependency ?), might be messy.

 

About the syncing, I'll say that Forge should keep priority. Isn't the purpose of the Bukkit part for compatibility only ?

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Unfortunately, your content contains terms that we do not allow. Please edit your content to remove the highlighted words below.
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.



  • Recently Browsing

    • No registered users viewing this page.
  • Posts

    • rp.crazyheal.xyz mods  
    • I'm developing a dimension, but it's kinda resource intensive so some times during player teleporting it lags behind making the player phase down into the void, so im trying to implement some kind of pregeneration to force the game loading a small set of chunks in the are the player will teleport to. Some of the things i've tried like using ServerLevel and ServerChunkCache methods like getChunk() dont actually trigger chunk generation if the chunk isn't already on persistent storage (already generated) or placing tickets, but that doesn't work either. Ideally i should be able to check when the task has ended too. I've peeked around some pregen engines, but they're too complex for my current understanding of the system of which I have just a basic understanding (how ServerLevel ,ServerChunkCache  and ChunkMap work) of. Any tips or other classes I should be looking into to understand how to do this correctly?
    • https://mclo.gs/4UC49Ao
    • Way back in the Forge 1.17 days, work started for adding JPMS (Java Platform Module Support) to ModLauncher and ForgeModLoader. This has been used internally by Forge and some libraries for a while now, but mods (those with mods.toml specifically) have not been able to take advantage of it. As of Forge 1.21.1 and 1.21.3, this is now possible!   What is JPMS and what does it mean for modders? JPMS is the Java Platform Module System, introduced in Java 9. It allows you to define modules, which are collections of packages and resources that can be exported or hidden from other modules. This allows for much more fine-tuned control over visibility, cleaner syntax for service declarations and support for sealed types across packages. For example, you might have a mod with a module called `com.example.mod` that exports `com.example.mod.api` and `com.example.mod.impl` to other mods, but hides `com.example.mod.internal` from them. This would allow you to have a clean API for other mods to use, while keeping your internal implementation details hidden from IDE hints, helping prevent accidental usage of internals that might break without prior notice. This is particularly useful if you'd like to use public records with module-private constructors or partially module-private record components, as you can create a sealed interface that only your record implements, having the interface be exported and the record hidden. It's also nice for declaring and using services, as you'll get compile-time errors from the Java compiler for typos and the like, rather than deferring to runtime errors. In more advanced cases, you can also have public methods that are only accessible to specific other modules -- handy if you want internal interactions between multiple of your own mods.   How do I bypass it? We understand there may be drama in implementing a system that prevents mods from accessing each other's internals when necessary (like when a mod is abandoned or you need to fix a compat issue) -- after all, we are already modding a game that doesn't have explicit support for Java mods yet. We have already thought of this and are offering APIs from day one to selectively bypass module restrictions. Let me be clear: Forge mods are not required to use JPMS. If you don't want to use it, you don't have to. The default behaviour is to have fully open, fully exported automatic modules. In Java, you can use the `Add-Opens` and `Add-Exports` manifest attributes to selectively bypass module restrictions of other mods at launch time, and we've added explicit support for these when loading your Forge mods. At compile-time, you can use existing solutions such as the extra-java-module-info Gradle plugin to deal with non-modular dependencies and add extra opens and exports to other modules. Here's an example on how to make the internal package `com.example.examplemod.internal` open to your mod in your build.gradle: tasks.named('jar', Jar) { manifest { attributes([ 'Add-Opens' : 'com.example.examplemod/com.example.examplemod.internal' 'Specification-Title' : mod_id, 'Specification-Vendor' : mod_authors // (...) ]) } } With the above in your mod's jar manifest, you can now reflectively access the classes inside that internal package. Multiple entries are separated with a space, as per Java's official spec. You can also use Add-Exports to directly call without reflection, however you'd need to use the Gradle plugin mentioned earlier to be able to compile. The syntax for Add-Exports is the same as Add-Opens, and instructions for the compile-time step with the Gradle plugin are detailed later in this post. Remember to prefer the opens and exports keywords inside module-info.java for sources you control. The Add-Opens/Add-Exports attributes are only intended for forcing open other mods.   What else is new with module support? Previously, the runtime module name was always forced to the first mod ID in your `mods.toml` file and all packages were forced fully open and exported. Module names are now distinguished from mod IDs, meaning the module name in your module-info.java can be different from the mod ID in your `mods.toml`. This allows you to have a more descriptive module name that doesn't have to be the same as your mod ID, however we strongly recommend including your mod ID as part of your module name to aid troubleshooting. The `Automatic-Module-Name` manifest attribute is now also honoured, allowing you to specify a module name for your mod without needing to create a `module-info.java` file. This is particularly useful for mods that don't care about JPMS features but want to have a more descriptive module name and easier integration with other mods that do use JPMS.   How do I use it? The first step is to create a `module-info.java` file in your mod's source directory. This file should be in the same package as your main mod class, and should look something like this: open module com.example.examplemod { requires net.minecraftforge.eventbus; requires net.minecraftforge.fmlcore; requires net.minecraftforge.forge; requires net.minecraftforge.javafmlmod; requires net.minecraftforge.mergetool.api; requires org.slf4j; requires logging; } For now, we're leaving the whole module open to reflection, which is a good starting point. When we know we want to close something off, we can remove the open modifier from the module and open or export individual packages instead. Remember that you need to be open to Forge (module name net.minecraftforge.forge), otherwise it can't call your mod's constructor. Next is fixing modules in Gradle. While Forge and Java support modules properly, Gradle does not put automatic modules on the module path by default, meaning that the logging module (from com.mojang:logging) is not found. To fix this, add the Gradle plugin and add a compile-time module definition for that Mojang library: plugins { // (...) id 'org.gradlex.extra-java-module-info' version "1.9" } // (...) extraJavaModuleInfo { failOnMissingModuleInfo = false automaticModule("com.mojang:logging", "logging") } The automatic module override specified in your build.gradle should match the runtime one to avoid errors. You can do the same for any library or mod dependency that is missing either a module-info or explicit Automatic-Module-Name, however be aware that you may need to update your mod once said library adds one. That's all you need to get started with module support in your mods. You can learn more about modules and how to use them at dev.java.
    • Faire la mise à jour grâce à ce lien m'a aider personnellement, merci à @Paint_Ninja. https://www.amd.com/en/support 
  • Topics

×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.