README.md

💾 A Utility library for Minecraft development.

About

Bits is a multi-platform Minecraft utility library designed to streamline plugin development across Paper and Velocity platforms. It provides common utilities, abstractions, and helper classes to reduce boilerplate code and accelerate your development workflow.

Features:

• Multi-platform support
• Annotation-based Brigadier Command API
• Sendable lifecycle builders (Actionbars, Sidebars, Waypoints, +)
• Automatic Text formatting
• Common Plugin utilities (Color, Sound, Location, Item, Math, Permission APIs)

Note

This project is in active development, expect regular changes and additions!

Installation

Gradle (Kotlin DSL)

repositories {
    maven { url = uri("https://repo.bitsquidd.xyz/repository/bit/") }
}

dependencies {
    // Core API
    implementation("xyz.bitsquidd.bits:api:0.0.14")

    // Platform implementation
    implementation("xyz.bitsquidd.bits.paper:paper:0.0.14")
    implementation("xyz.bitsquidd.bits.velocity:velocity:0.0.14")
    implementation("xyz.bitsquidd.bits.fabric:fabric:0.0.14")
    
    // Optional: Platform-specific modules
    implementation("xyz.bitsquidd.bits.paper:sendable:0.0.14")
    implementation("xyz.bitsquidd.bits.paper:command:0.0.14")
    implementation("xyz.bitsquidd.bits.velocity:command:0.0.14")
}

Maven

<repositories>
    <repository>
        <id>repo.bitsquidd.xyz</id>
        <url>https://repo.bitsquidd.xyz/repository/bit/</url>
    </repository>
</repositories>

<dependencies>
<!-- Core API (required) -->
<dependency>
    <groupId>xyz.bitsquidd.bits</groupId>
    <artifactId>api</artifactId>
    <version>0.0.14</version>
</dependency>

<!-- Platform implementation (optional) -->
<dependency>
    <groupId>xyz.bitsquidd.bits.paper</groupId>
    <artifactId>paper</artifactId>
    <version>0.0.14</version>
</dependency>
<dependency>
    <groupId>xyz.bitsquidd.bits.velocity</groupId>
    <artifactId>velocity</artifactId>
    <version>0.0.14</version>
</dependency>
<dependency>
    <groupId>xyz.bitsquidd.bits.fabric</groupId>
    <artifactId>fabric</artifactId>
    <version>0.0.14</version>
</dependency>
</dependencies>

Libraries

• API - Core interfaces and abstractions
• Paper - Paper platform implementation
• Velocity - Velocity platform implementation
• Fabric - Fabric platform implementation
  • Client - Fabric client implementation
  • Server - Fabric server implementation

---

Made with 🦑 by ImBit