FactionsBridge 1.2.2

Bridging the gap between Plugins and APIs.

  1. Retrix_Solutions
    Native Minecraft Version:
    1.16
    Tested Minecraft Versions:
    • 1.7
    • 1.8
    • 1.9
    • 1.10
    • 1.11
    • 1.12
    • 1.13
    • 1.14
    • 1.15
    • 1.16
    Source Code:
    https://github.com/CallumJohnson/FactionsBridge
    Contributors:
    CustomEnchants
    FactionsBridge
    A Plugin which Bridges the gap between multiple APIs and Plugins which use them.

    Due to the nature of Factions and their individualised implementations, it can be difficult to implement Factions into a Project without having to make a multitude of methods to support them all or choosing a specific branch to exclusively support. This project is being developed to hopefully mitigate this issue and create a unified interface, which any developer can depend, use and rely upon to make the distance for them when handling different Factions APIs.

    Plugins which are supported.
    As of Version 1.2.0, 12 different versions of Factions are supported.
    1. FactionsX https://www.spigotmc.org/resources/factionsx.83459/
    2. FactionsUUID https://www.spigotmc.org/resources/factionsuuid.1035/
    3. SavageFactions (Abandoned) https://www.spigotmc.org/resources/savagefactions-the-ultimate-factions-experience-abandoned.52891/
    4. SupremeFactions https://docs.supremedev.us/supreme-dev-supreme-factions
    5. KingdomsX https://www.spigotmc.org/resources/kingdomsx.77670/
    6. MassiveFactions https://www.spigotmc.org/resources/factions.1900/
    7. FactionsBlue https://www.spigotmc.org/resources/factions-blue.66627/
    8. Atlas Factions https://factions.atlas-studios.net
    9. SaberFactions https://www.spigotmc.org/resources/...aber-pw-the-complete-factions-solution.69771/
    10. MedievalFactions
      https://www.spigotmc.org/resources/medieval-factions-sovereign-nation-simulator.79941/
    11. LegacyFactions https://github.com/redstone/LegacyFactions/releases/tag/1.4.7
    12. UltimateFactions https://www.spigotmc.org/resources/%E2%AD%90ultimate-factions-%E2%96%BA-unique-faction-plugin-%E2%97%84-%E2%9C%85-1-8-1-16-5-%E2%9C%85-%E2%9C%A8-fully-configurable-%E2%9C%A8.81103
    How to use the API
    To begin, you need to remove Factions from your dependancies, this will hopefully be a full replacement and if it is not, please create an issue/contact me to get your desired functionality added into this project. Added FactionsBridge into your plugin.yml dependancies to ensure that your plugin is hooked correctly.
    Code (YAML):

    name
    : YourProject
    main
    : com.yourname.yourproject.YourProject
    version
    : 1.0-Snapshot-of-the-century

    # If you are shading the project in, include the following:
    softdepend
    : [Factions, FactionsX, FactionsBlue, KingdomsX, Kingdoms, LegacyFactions, MedievalFactions, UltimateFactions]

    # If you are depending on the standalone plugin, including the following:
    softdepend/depend
    : [FactionsBridge] # depending on your preference or requirements.
     
    If you are shading the project into your plugin, please make sure to 'connect' to the FactionsBridge class when you do.
    How do I connect for Shading?
    Code (Java):

    FactionsBridge bridge = new FactionsBridge();
    //     This will create all methodology using the Plugin Object you provide.
    bridge.connect(yourPluginObject); // 1.0.0->Present.

    // If you do not require factions but you want console output, use these parameters.
    bridge.connect(yourPluginObject, true,          false           ); // 1.1.2->Present.
    // ->> connect(plugin,           consoleOutput, requiresFactions)
    /*
        FactionsBridge will bridge the APIs and then allow you to use the following
        methods for access to the API methods.
    */

     
    How do I get access to the API?
    Code (Java):

    //     This is how to obtain the API.
    FactionsAPI api = FactionsBridge.getFactionAPI();
    /*
        The API class has many methods which will hopefully add all the
        functionality you could ever require.
     */

     
    There are also events which are bridged, these events are listened to within FactionsBridge and then ported into the API so you can use them at the same time.

    Code (YAML):

    FactionClaimEvent                    # When a Faction claims land. (1.2.0)
    FactionUnclaimAllEvent               # When a Faction unclaims all their land. (1.2.0)
    FactionUnclaimEvent                  # When a Faction unclaims land. (1.2.0)
    FactionCreateEvent                   # When a Faction is created. (1.2.0)
    FactionDisbandEvent                  # When a Faction is disbanded. (1.2.0)
    FactionRenameEvent                   # When a Faction is renamed. (1.2.0)
    FactionLeaveEvent                    # When a Player Leaves or is Kicked from a Faction. (1.2.0)
    FactionJoinEvent                     # When a Player Joins a Faction. (1.2.0)
     

    Side-note:
    This API is very unstable and is a very basic implementation of the concept, updates will come to increase stability and fix issues if they arise.

Recent Updates

  1. Beta - Version 1.2.2
  2. Beta - Version 1.2.1
  3. Beta - Version 1.2.0

Recent Reviews

  1. Splodgebox
    Splodgebox
    5/5,
    Version: 1.1.1
    Massive Shoutout to this API, Really helps out developers like me who get requests for support for new faction plugins every month. This just saves me the time of having to make a whole system to support multiple faction plugins.

    Honestly, a massive life saver, thank you so much for making this.
  2. Heron4gf
    Heron4gf
    5/5,
    Version: 1.0.3
    I didn't try or use this API, since I don't have a Faction server, but I really love the idea of a "Vault" for Faction plugins, future factions addons will probably just need to hook in this plugin to have a really good integration, keep it up!
  3. CustomEnchants
    CustomEnchants
    5/5,
    Version: 1.0.1
    Vouch for this dude
    I kinda helped him think of what to add to this api.
    Can't thank him enough for this.