Skip to content

NxTCrew/NxTBase

Repository files navigation

Contributors Forks Stargazers Issues MIT License


NxTBase

Logo

Your NxT minecraft ecosystem
Explore the docs »

Report Bug · Request Feature

Maintainability Reliability Security

About The Project

NxT is a entire ecosystem of extensions for Minecraft networks. This is the base plugin of the ecosystem, which can load extensions and provide a base for them. You, as a User, can simple choose from a variety of extensions and install them to your server. You can also create your own extensions and share them with the community.

(back to top)

Built With

  • Kotlin
  • Spigot
  • Gradle
  • Ascend

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You need the following software to run this plugin:

  • Minecraft Spigot-based server software 1.19+ (Paper recommended)
  • Java 17

Installation

  1. Download the latest release
  2. Upload the plugin to your server
  3. Start your server and enjoy!
  4. Configure the plugin to your liking in the plugins/NxT/config.yml file

(back to top)

Roadmap

  • Extension system
    • Dynamic loading of extensions
    • Extension Ingame Command
      • Simple extension management with list and reload
      • Fully featured extension management
    • Extension API
    • Extension examples
    • Extension documentation
    • Extension cloud
  • Language system
    • Dynamic loading of languages
    • Language API
  • Dynamic loading of commands and listeners
  • Event system
    • Dynamic loading of events
    • Event API
  • Multiplatform support
    • BungeeCord support
    • Velocity support
    • Spigot support
  • GUI system
    • GUI API
    • GUI examples
    • GUI documentation
  • Database system
  • API
  • Documentation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Branch naming

  • feature/ for new features
  • fix/ for bug fixes
  • docs/ for documentation changes
  • refactor/ for code changes that neither fixes a bug nor adds a feature
  • style/ for formatting, missing semi colons, etc; no code change
  • test/ for everything related to testing
  • chore/ for updating build tasks, package manager configs, etc; no production code change

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/NxTCrew/NxTBase

(back to top)

Acknowledgments

(back to top)