rlf / uSkyBlock

The best skyblock bukkit plugin around...
http://dev.bukkit.org/bukkit-plugins/uskyblock/
GNU General Public License v3.0
76 stars 112 forks source link

uSkyBlock

This is a continually updated and custom version of Talabrek's Ultimate SkyBlock plugin.

We are on Spigot. Currently Open Issues

Installation

This version depends on the following plugins:

Releases

https://www.spigotmc.org/resources/uskyblock-revived.66795/history

Pre-releases will end in -SNAPSHOT, and is considered unsafe for production servers.

Releases have a clean version number, has been tested, and should be safe for production servers.

New Maven group/artifactId

Starting with version 3.0.0-SNAPSHOT, we've changed our Maven groupId's for all submodules except uSkyBlock-API. If you're using uSkyBlock-Core or po-utils as dependency in your project, update your dependencies to:

<dependency>
    <groupId>ovh.uskyblock</groupId>
    <artifactId>uSkyBlock-Core</artifactId>
    <version>3.0.0</version>
</dependency>

We're moving new API features towards APIv2, which is available as:

<dependency>
    <groupId>ovh.uskyblock</groupId>
    <artifactId>uSkyBlock-APIv2</artifactId>
    <version>3.0.0</version>
</dependency>

Feel free to use any of the new APIv2 functions on servers running uSkyBlock 3.0.0+. The old API-methods will be deprecated and removed in the upcoming plugin releases.

Bukkit/Spigot 1.7.9/10 Releases

We provide pre-compiled versions (no support) here:

Config-files

Note: Config files might change quite a bit, and upon activation, the plugin will try to merge the existing ones with the new ones. A backup is kept under the uSkyBlock/backup folder.

Please make sure, that the config files are as you expect them to be, before using the plugin or releasing it to "the public".

Building/Compiling

See (https://github.com/rlf/uSkyBlock/wiki/Building)

API

uSkyBlock has an API (since v2.0.1-RC1.65).

To use it, simply drop the api-jar to the classpath of your own plugin, and write some code along these lines:

Plugin plugin = Bukkit.getPluginManager().getPlugin("uSkyBlock");
if (plugin instanceof uSkyBlockAPI && plugin.isEnabled()) {
  uSkyBlockAPI usb = (uSkyBlockAPI) plugin;
  player.sendMessage(String.format(
    "\u00a79Your island score is \u00a74%5.2f!", 
    usb.getIslandLevel(player)
  ));
}

For further details regarding the API, visit the Wiki page: https://github.com/rlf/uSkyBlock/wiki/uSkyBlock-API

Contributing

Fork-away, and create pull-requests - we review and accept almost any changes.

But please conform with the (https://github.com/rlf/uSkyBlock/wiki/Coding-Guidelines)

License

TL;DR - This is licensed under GPLv3

Explanation / History

Originally the uSkyBlock was a continuation of the skySMP plugin, which was licensed under GPLv3 (see http://dev.bukkit.org/bukkit-plugins/skysmp/).

Talabrek intended to share the code with the public, but simply didn't have the time available to do so.

Unfortunately, he had registered the plugin as All rights reserved on Bukkit, meaning the bukkit staff put the plugin under moderation - further increasing the work-load required to share the plugin.

Those trying to get hold on Talabrek, had a hard time, and eventually multiple developers got their hands on different versions of the uSkyBlock plugin, and tried to continue the work in various channels (wesley27 and wolfwork comes to mind).

On the very last day of 2014, we received the following e-mail from Talabrek:

Recently, now that a stable 1.8 and the future of spigot is looking hopeful, I have gotten back to work on the plugin. There is much to be done though, and I just don't have the time to do it, so I finally decided to make it available for the public to work on. This is when I noticed the work you and others have done on the plugin.

I don't have the time and energy to devote to actively developing this plugin anymore, but it is like a pet project to me so I would still like to have a role in it's development. You are making the best effort that I have seen, so I would like for you to continue.

If you are interested, I can make my current code available to you (it's much different than what you currently have now, but some parts might be useful).

-Talabrek

So, with Talabreks blessing, this repository will try to consolidate the many different "branches" out there.

References