Giter VIP home page Giter VIP logo

phantomloader's Introduction

Phantom Loader

Phantom Loader is an API that automates part of the process of creating Minecraft mods for multiple mod loaders by generating loader-specific code at build time.

About

Normally, when creating a mod for both Fabric and Forge, mod developers have to create separate modules for both mod loaders and add loader-specific code that has mostly the same function. Phantom Loader allows you to automatically generate Forge and Fabric initializer classes on build time by keeping all code, or most of the code, in the common module.

The Phantom Library also takes care of abstracting each mod loader's basic functionalities to allow the developer to only depend on the abstraction from the common module.

Before:

Project
 |--common
 |    |--src/main/java
 |    |    |--common/...
 |    |    |--AbstractRegistry.java
 |    |    |--CommonInit.java
 |    |--src/main/resources
 |    |    |--assets/...
 |    |    |--data/...
 |    |--build.gradle
 |--fabric
 |    |--src/main/java
 |    |    |--FabricRegistry.java
 |    |    |--FabricInitializer.java
 |    |--src/main/resources
 |    |    |--fabric.mod.json
 |    |--build.gradle
 |--forge
      |--src/main/java
      |    |--ForgeRegistry.java
      |    |--ForgeInitializer.java
      |--src/main/resources
      |    |--META-INF/mods.toml
      |--build.gradle

After:

Project
 |--common
 |    |--src/main/java
 |    |    |--content/...
 |    |    |--ModRegistry.java
 |    |--src/main/resource
 |    |    |--assets/...
 |    |    |--data/...
 |    |--build.gradle
 |--fabric
 |    |--build.gradle
 |--forge
      |--build.gradle

For developers

Documentation for setting up and using Phantom Loader can be found on the Wiki.

An example mod using Phantom Loader can be found here.

Credits

Author: HexagonNico

License

This software is licensed under the Apache License 2.0

phantomloader's People

Contributors

hexagonnico avatar

Stargazers

 avatar  avatar  avatar

phantomloader's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.