Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/euphillya/skyllia
Skyblock Plugin for Folia (Minecraft) and PaperMC
https://github.com/euphillya/skyllia
folia folia-plugin folia-supported java minecraft minecraft-plugin minecraft-plugins papermc-plugin purpur-plugin skyblock skyblock-plugin
Last synced: 17 days ago
JSON representation
Skyblock Plugin for Folia (Minecraft) and PaperMC
- Host: GitHub
- URL: https://github.com/euphillya/skyllia
- Owner: Euphillya
- License: mit
- Created: 2023-12-16T09:24:59.000Z (11 months ago)
- Default Branch: dev
- Last Pushed: 2024-10-23T20:53:09.000Z (20 days ago)
- Last Synced: 2024-10-24T08:46:10.405Z (20 days ago)
- Topics: folia, folia-plugin, folia-supported, java, minecraft, minecraft-plugin, minecraft-plugins, papermc-plugin, purpur-plugin, skyblock, skyblock-plugin
- Language: Java
- Homepage:
- Size: 1.27 MB
- Stars: 45
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
[](https://bstats.org/plugin/bukkit/Skyllia/20874)
## Table of Contents
1. [Wiki](#wiki)
2. [Contact](#contact)
3. [Plugin Features](#plugin-features)
4. [Prerequisites](#prerequisites)
5. [Installation](#installation)
6. [Download Plugin](#download-plugin)
7. [Configuration](#configuration)
8. [API](#api)
- [Gradle Groovy](#gradle-groovy)
- [Example Usage](#example-usage)
9. [Commands & Permissions](#commands--permissions)
10. [Compatible Software](#compatible-software)
11. [Island Generation](#island-generation)
12. [Addons](#addons)
13. [Contribution](#contribution)
14. [License](#license)
## Wiki
- [FR_FR](https://github.com/Euphillya/Skyllia/wiki)
- [EN_EN](https://github.com/Euphillya/Skyllia/tree/dev/wiki/en_en/all_files)
- [ZH_CN](https://github.com/Euphillya/Skyllia/tree/dev/wiki/zh_cn/all_files)
## Contact
[](https://discord.gg/uUJQEB7XNN)
## Prerequisites
- A MariaDB database
- Paper 1.20.1+ or Folia 1.20+
- Java 21
- WorldEdit ([Folia](https://github.com/Euphillya/WorldEdit-Folia/actions) or [Original](https://modrinth.com/plugin/worldedit/versions?l=bukkit))
## Installation
1. Ensure you have the required prerequisites installed.
2. Download the latest version of Skyllia from the [Releases](https://modrinth.com/plugin/skyllia) 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
- [Development Builds](https://github.com/Euphillya/Skyllia/actions)
- [Release Versions](https://modrinth.com/plugin/skyllia)
## 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](https://github.com/Euphillya/Skyllia/wiki/Configuration).
## API
### Gradle Groovy
To add Skyllia API to your project, use the following configuration:
```groovy
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:
```java
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](https://github.com/Euphillya/Skyllia/wiki/Commands-and-Permissions) section in the Wiki.
## Compatible Software
| Software | Version |
|:----------------------------------------------------:|:-------------:|
| [PaperMC](https://papermc.io/downloads/paper) | 1.20.1-1.21.3 |
| [Purpur](https://purpurmc.org) | 1.20.1-1.21.3 |
| [Folia](https://papermc.io/software/folia) | 1.20-1.21.3 |
| [Spigot](https://www.spigotmc.org) (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
- [SkylliaOre](https://github.com/Euphillya/Skyllia-Ore) by Euphyllia (Ore Generator)
- [Insight Skyllia](https://github.com/Euphillya/Insights-Skyllia) by Euphyllia
- [PAPI Skyllia](https://github.com/Euphillya/Skyllia-PAPI) by Euphyllia
## 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](CONTRIBUTING.md).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
For more information and detailed documentation, please refer to the [Wiki](https://github.com/Euphillya/Skyllia/wiki).
Feel free to contribute, open issues, or join us on Discord for support and discussions!