hartl3y94/minix

Spigot Library for quick, easy and performance friendly plugins. Written in Kotlin and using Coroutines and ASYNC methods

Minix

Minix is the most advanced and performant framework to build plugins on!
With full in depth support for kotlin coroutines and many useful utilities and quality of life features for developers.
Minix makes developing performant, non-blocking code easy and concise.

Minix is currently in a state of heavy development for the upcoming 5.0.0 release, all features are subject to change and may not be fully documented.

Coming from version 4.x.x to 5.0.0 will require a lot of code changes, please be aware of this before starting development before the release of version 5.0.0.

Docs

*The docs can be found here

Plugin Information

Minix is a standalone plugin, so it can provide all of its features, this means you will have to install it on the server with your plugin, to depend on Minix add it as a dependency in your plugin.yml:

depend:
  - Minix

Getting started:

repositories {
        maven("https://repo.racci.dev/releases/")
}

dependencies {
    compileOnly("dev.racci:Minix:tag")
}

Replace tag with a release tag, eg 1.0.0.

Features

• Coroutines integration

• Async suspended functions

• A lot of use of kotlin lazy which is worse on memory usage but allows things to be only loaded when needed for better performance.

• CoroutineScheduler

• CoroutineTask

• CoroutineRunnable

• PluginService

  • Manages all minix plugins and allows plugins to be safe to use new versions of minix without code changes.

• Extensions:

  • Registers as a Koin injection automatically with the ability to bind to another class.
  • Provides a way of depending on other extension modules to start first and make sure they have successfully started.
  • Acts like it's own mini plugin with a enable and disable function, this allows you to more efficiently split your code up into smaller modules and helps with debugging.
  • Allows lots of the Ex Utils to be used without more interfaces, object calls, or the need to use the this keyword.

• Events:

  • PlayerOffhandEvent
  • PlayerPrimaryEvent
  • PlayerSecondaryEvent
  • PlayerDoubleOffhandEvent
  • PlayerDoublePrimaryEvent
  • PlayerDoubleSecondaryEvent
  • PlayerSneakOffhandEvent
  • PlayerSneakPrimaryEvent
  • PlayerSneakSecondaryEvent
  • PlayerSneakDoubleOffhandEvent
  • PlayerSneakDoublePrimaryEvent
  • PlayerSneakDoubleSecondaryEvent

• Event Flows:

  • Allows you to suspend and wait for an event such as player input.
  • Allows you to put easy timeouts.
  • A much more intuitive and easier to read way of getting inputs and such.

• Destructors:

  • Common
  • Event
  • Pattern

• Fluent Item Builders:

  • Item
  • Banner
  • Book
  • Firework
  • Head
  • Item
  • Map
  • Builder DSL

• Serializers:

  • Attribute Modifier
  • Duration
  • Enchant
  • Location
  • MiniMessage
  • NamespacedKey
  • Pattern
  • PotionEffect
  • Range
  • Item Stack
  • UUID
  • Vector
  • World
  • Recipes:
    • Blasting
    • Campfire
    • Furnace
    • Shaped
    • Shapeless
    • Smithing
    • Smoking
    • Stonecutting

• Utils:

  • Collections:

    • Collection Utils
    • ExpirationList
    • ExpirationMap
    • MultiMap
    • ObservableCollections
    • OnlinePlayerCollection

  • Jetbrains exposed:

    • Block
    • BlockPos
    • Cached
    • Chunk
    • ChunkPos
    • Item
    • Location
    • LocationPos
    • OfflinePlayer
    • World

  • Kotlin:

    • Infix Utils
    • Kotlin Utils
    • Lazy Utils

  • Minecraft:

    • Block
    • Inventory
    • Location
    • MaterialTagExtensions
    • NBT
    • Player
    • Plugin
    • Projectile
    • Range
    • Tame

  • Misc:

    • Enum
    • Math
    • Number
    • String
    • Koin
    • Reflection
    • TakeMaxTimePerTick
    • Time
    • Unsafe

Plugin Updater

Using the minix-updater is very easy however it does need to be configured. Using the format below you can easily configure the updater. Note that when using more than one provider only the first one will be used unless it fails multiple times. In this case it will traverse down the list and if none of them work, disable that updater.

When an update is found and is downloaded, a backup will be created of the current state and placed in plugins/Minix/MinixUpdater

Format

plugin-updaters=[
    {
        channels=[release]  # What release channels to update to options: [release, alpha, beta, snapshot]
        ignored=[]          # Any folders which should be ignored when backing up for an update
        name=Minix          # The name of the plugin this must be the same as what is in the `/plugins` output
        update-mode=UPDATE  # How to update the plugin options: [UPDATE, CHECK, DISABLED]
        providers=[
            {
                AlwaysUpdateProvider {
                    downloadUrl=api.example.com/download/
                    fileName=file.jar
                    releaseType=RELEASE
                }
            },
            {
                BukkitUpdateProvider {
                    projectID=12345
                    apiKey=12345 # Optional
                }
            },
            {
                GithubUpdateProvider {
                    projectOwner=DaRacci
                    projectRepo=Minix
                    userAgent=AGENT # Optional
                    jarSearchRegex=.*\.jar$ # Optional
                    md5SearchRegex=.*\.md5$ # Optional
                }
            },
            {
                JenkinsUpdateProvider {
                    host=jenkins.example.com
                    job=Minix
                    token=12345 # Optional
                    artifactSearchRegex=.*\.jar$ # Optional
                }
            },
            {
                SpigotUpdateProvider {
                    projectID=12345
                    fileName=file.jar # Optional
                }
            }
        ]
    }
]

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

📝 License

Copyright © 2021-2023 Racci
This project is licensed.

Special Thanks To

JetBrains, creators of the IntelliJ IDEA, supports Minix with one of their Open Source Licenses. IntelliJ IDEA is the recommended IDE for working with Minix or any Java / Kotlin project.