Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (34 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

40 lines (34 loc) · 2.49 KB
Raw

Integrating ForgeEssentials with another mod

To use ForgeEssentials and its powerful permission framework with from another mod, please take a look at the developer documentation in the wiki.

Developing ForgeEssentials

  1. Download ForgeEssentials with git
  2. Run ForgeGradle setup (E.g., ./gradlew genEclipseRuns when using eclipse)
  3. Configure the annotation processor as outlined below
  4. Add ``-Dmixin.env.compatLevel=JAVA_8` to VM Options for both server and client
  5. Add --mixin mixins.forgeessentials.json to the launch arguments of the server
  6. Add --mixin mixins.forgeessentials.json --tweakClass org.spongepowered.asm.launch.MixinTweaker --mixin mixins.forgeessentials.client.json to the launch arguments of the client

Configuring Annotation Processing

If you open ForgeEssentials in your IDE, you must turn on annotation processing, or your IDE will complain that it cannot find classes like Action_. You also might need to manually add hibernate-jpamodelgen-x.x.x.jar as annotation processor. Please refer to the respective IDE documentation on how to do this.

Eclipse

  • Go to Project Properties > Java Compiler > Annotation processing
    • Check Enable annotation processing
  • Go to Project Properties > Java Compiler > Annotation processing > Factory Path
    • Add the hibernate-jpamodelgen-x.x.x.jar.
      To find its location, check the referenced libraries in the project settings. It should be located somewhere in
      $HOME/.gradle/caches/modules-2/files-2.1/org.hibernate/hibernate-jpamodelgen/x.x.x.Final

IntelliJ IDEA

  • Go to Settings > Build, Execution and Deployment > Compiler > Annotation Processors
  • Check Enable annotation processing
  • Check Obtain processors from project classpath
  • Enter .apt_generated as "Production sources directory"
  • Under Annotation Processors, add this fully qualified name: org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor
  • Run Build > Rebuild Project
  • Right click .apt_generated directory and select Mark as > Source directory

FALLBACK

  • If none of the above options work for your IDEs, you can use do the following.
    • Add /misc/forgeessentials-1.16.5-annonations.jar to your build path.

Notes

  1. Please consider squashing all commits before initially submitting pull requests
  2. For a local .gitignore use .git/info/exclude
  3. If you have any questions, join us on IRC