The-Fireplace-Minecraft-Mods / Grand-Economy

A Minecraft server-side economy mod and api for hooking into various economy mods/plugins.
https://www.curseforge.com/minecraft/mc-mods/grand-economy
Mozilla Public License 2.0
4 stars 8 forks source link
fabricmc-mod minecraft minecraft-mod

Grand Economy API

CurseForge Modrinth Maven Central

Adding Grand Economy to your dev environment

To use this with your mod, include the following in build.gradle:

Fabric:

repositories {
  maven {
    name 'Cloth Config'
    url 'https://maven.shedaniel.me/'
  }
  maven {
    name 'Mod Menu'
    url 'https://maven.terraformersmc.com/releases/'
  }
}
dependencies {
  modCompileOnly "dev.the-fireplace:Grand-Economy-Fabric:${project.grandeconomy_version}:api"
  modRuntimeOnly "dev.the-fireplace:Grand-Economy-Fabric:${project.grandeconomy_version}"
}

Forge:

repositories {
  maven {
    name 'Cloth Config'
    url 'https://maven.shedaniel.me/'
  }
}
dependencies {
  implementation(fg.deobf("dev.the-fireplace:Annotated-DI-Forge:${project.annotateddi_version}"))
  compileOnly(fg.deobf("dev.the-fireplace:Fireplace-Lib-Forge:${project.fireplacelib_version}:api"))
  runtimeOnly(fg.deobf("dev.the-fireplace:Fireplace-Lib-Forge:${project.fireplacelib_version}"))
  compileOnly(fg.deobf("dev.the-fireplace:Grand-Economy-Forge:${project.grandeconomy_version}:api"
  runtimeOnly(fg.deobf("dev.the-fireplace:Grand-Economy-Forge:${project.grandeconomy_version}"
}

And in gradle.properties:

grandeconomy_version=<mod version>+<minecraft version>

Using the Entrypoint

To use economy from Grand Economy and/or register your own economy, you'll want to use the entrypoint.

  1. Create a class that implements GrandEconomyEntrypoint
  2. Add whatever logic you want to in your GrandEconomyEntrypoint's init function
  3. Add your entrypoint class to the grandeconomy entrypoint in your fabric.mod.json

Example entrypoint

"entrypoints": {
    "main": [
        ...
    ],
    "grandeconomy": [
        "your.package.YourImplementationClass"
    ]
},