Skip to content

redstone-llc/SystemsAPI

Repository files navigation

SystemsAPI Icon
SystemsAPI
GitHub last commit Maven Version
By Redstone Studios

Overview

SystemsAPI is a fabric library that abstracts Hypixel Housing's house systems for other mods to use. For an example implementation, see HTSL Reborn.

Warning

This project is a work in progress! Expect constant changes to API structure at this stage.

Features

  • Action importing
    • Error correction (catches when things don't go how they should, and tries again automatically)
    • Optimized importing (optimally keeps/changes existing actions to make imports quick!)
  • Action exporting
  • System abstraction (methods for programmatically interacting with any/all Housing systems.)
    • Functions
    • Events
    • Commands
    • Custom Menus
    • Regions
    • Scoreboard
    • Teams
    • NPCs
    • Inventory Layouts
    • House Settings
    • Gamerules
    • Roles
  • Scope and limit abstraction, for easy action validation

Usage

To use SystemsAPI in your mod, include the project in your maven/gradle project. Replace VERSION with the latest version, as shown in the Maven badge above (omit the V).

Gradle

repositories {
    maven {
        name = "redstoneReleases"
        url = uri("https://repo.redstone.llc/releases")
    }
}

dependencies {
    modImplementation("llc.redstone:SystemsAPI:VERSION")
}

Maven

<repositories>
    <repository>
        <id>redstone-releases</id>
        <name>Redstone Releases</name>
        <url>https://repo.redstone.llc/releases</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>llc.redstone</groupId>
        <artifactId>SystemsAPI</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>

About

A fabric library that abstracts Hypixel Housing's systems

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 2

  •  
  •