Skip to content

README.md

Latest commit

 

History

History
80 lines (60 loc) · 2.07 KB

README.md

File metadata and controls

80 lines (60 loc) · 2.07 KB

Bits

💾 A Utility library for Minecraft development.

License

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 (Paper, Velocity, +)
  • 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 {
    mavenCentral()
    maven { url = uri("https://repo.bitsquidd.xyz/repository/bit/") }
}

dependencies {
    // Core API (required)
    implementation("xyz.bitsquidd:api:0.0.12")

    // Platform implementation (optional)
    implementation("xyz.bitsquidd:paper:0.0.12")
    implementation("xyz.bitsquidd:velocity:0.0.12")
    implementation("xyz.bitsquidd:fabric:0.0.12")
}

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</groupId>
    <artifactId>api</artifactId>
    <version>0.0.12</version>
</dependency>

<!-- Platform implementation (optional) -->
<dependency>
    <groupId>xyz.bitsquidd</groupId>
    <artifactId>paper/velocity/fabric</artifactId>
    <version>0.0.12</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