Skip to content

Latest commit

 

History

History
136 lines (93 loc) · 4.92 KB

readme.md

File metadata and controls

136 lines (93 loc) · 4.92 KB
Raw

Skyllia - Skyblock Plugin for Minecraft

Skyllia is a Skyblock plugin designed primarily for Folia but also compatible with Paper (1.20.1+). The plugin has an API that you can use to add feature extensions to customize your server. The plugin will have very little innovative functionality, and it's not my intention at all that there should be external features (like quests, for example).

bStats

Table of Contents

  1. Wiki
  2. Contact
  3. Plugin Features
  4. Prerequisites
  5. Installation
  6. Download Plugin
  7. Configuration
  8. API
  9. Commands & Permissions
  10. Compatible Software
  11. Island Generation
  12. Addons
  13. Contribution
  14. License

Wiki

Contact

Join us on Discord

Prerequisites

  • A MariaDB database
  • Paper 1.20.1+ or Folia 1.20+
  • Java 21
  • WorldEdit (Folia or Original)

Installation

  1. Ensure you have the required prerequisites installed.
  2. Download the latest version of Skyllia from the Releases page.
  3. Place the downloaded .jar file into your server's plugins directory.
  4. Start your server to generate the default configuration files.
  5. Configure the plugin to your liking by editing the configuration files in the plugins/Skyllia directory.
  6. Restart your server to apply the changes.

Download Plugin

Configuration

Configuration files are located in the plugins/Skyllia directory. Customize settings to fit your server's needs. Detailed configuration instructions can be found in the Wiki.

API

Gradle Groovy

To add Skyllia API to your project, use the following configuration:

repositories {
    maven {
        url = uri("https://maven.pkg.github.com/Euphillya/Skyllia")
    }
}

dependencies {
    compileOnly("fr.euphyllia.skyllia:api:1.3")
}

Example Usage

Here is a simple example of how to use the Skyllia API:

import fr.euphyllia.skyllia.api.SkylliaAPI;
import fr.euphyllia.skyllia.api.skyblock.Island;

import java.util.UUID;

Island playerIsland = SkylliaAPI.getIslandByPlayerId(player.getUniqueId()).join();
UUID islandId = playerIsland.getId();

Commands & Permissions

Skyllia comes with a set of commands and permissions to manage the plugin effectively. For a full list of commands and their permissions, refer to the Commands & Permissions section in the Wiki.

Compatible Software

Software Version
PaperMC 1.20.1-1.21.3
Purpur 1.20.1-1.21.3
Folia 1.20-1.21.3
Spigot (Not Recommended) Cancelled

Island Generation

Each island is generated in a single region file, with configurable region distances to suit your server's needs.

Addons

Contribution

We welcome contributions from the community! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Commit your changes (git commit -m 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a Pull Request.

For more detailed guidelines, refer to the Contributing Guide.

License

This project is licensed under the MIT License. See the LICENSE file for details.

For more information and detailed documentation, please refer to the Wiki.

Feel free to contribute, open issues, or join us on Discord for support and discussions!