Skip to content

Archy-X/AuraSkills

Repository files navigation

AuraSkills

The ultra-versatile Minecraft RPG skills plugin

GitHub Release Maven Central Version Spiget Downloads

Downloads    |    Wiki    |    Discord

About

AuraSkills (formerly Aurelium Skills) is a Minecraft plugin that adds skills, stats, abilities, and other RPG-related features. The plugin is fully configurable and customizable, enabling usage on a wide range of server types.

Features include:

  • Skills - Gain skill XP to level skills through general Minecraft tasks, such as Farming or Mining.
  • Stats - Get player buffs like increased health and damage by leveling skills, which can be as independent modifiers and on items.
  • Abilities - Skills have passive and active abilities that add gameplay mechanics, plus a full mana system.
  • Menus - Players can see everything related to skills in fully-configurable inventory GUIs.
  • Rewards - Customize rewards given for leveling skills, such as running commands or giving items.
  • Loot - Create custom loot tables for fishing, blocks, and mobs.

See the official website and wiki for a more complete list of features. The wiki also contains the list of server requirements to run the plugin.

Building

AuraSkills uses Gradle for dependencies and building.

Compiling from source

First, clone the project (requires Git to be installed):

git clone https://github.com/Archy-X/AuraSkills.git
cd AuraSkills/

Then build depending on your operating system:

Linux / macOS

./gradlew clean build

Windows

.\gradlew.bat clean build

The output jar can be found in the build/libs directory.

API

AuraSkills has an extensive developer API.

Read the full API documentation on the wiki, or view the Javadocs.

Release versions are published to the Maven central repository. Snapshot versions require adding the Sonatype OSS repository.

Maven

<repository>
    <id>sonatype-oss-snapshots1</id>
    <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
</repository>
<dependency>
    <groupId>dev.aurelium</groupId>
    <artifactId>auraskills-api-bukkit</artifactId>
    <version>2.3.3</version>
    <scope>provided</scope>
</dependency>

Gradle

Groovy DSL:

repositories {
    mavenCentral()
    maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots/' }
}

dependencies {
    compileOnly 'dev.aurelium:auraskills-api-bukkit:2.3.3'
}

Kotlin DSL:

repositories { 
    mavenCentral()
    maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}

dependencies { 
    compileOnly("dev.aurelium:auraskills-api-bukkit:2.3.3")
}

Contributing

We welcome contributions from the community. Please read the contributing guide for instructions on setting up a development environment and important guidelines you should know before submitting a pull request.

About

The ultra-versatile RPG skills plugin

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors 31

Languages