Skip to content
This repository has been archived by the owner on Apr 19, 2018. It is now read-only.

Home

Jump to bottom
Nathan Wolf edited this page Mar 10, 2015 · 3 revisions

Magic Lib

This is a utility library used by the MagicWorlds plugin, or other plugins, to provide some useful functionality.

This plugin does nothing on its own, but it may be required by another plugin in order for that plugin to function properly.

Development builds of this project can be acquired at the provided continuous integration server. These builds have not been approved by the BukkitDev staff. Use them at your own risk.

Build ServerAPIIssues

Plugins Known to Use MagicLib

Magic Plugin : Magic provides this library, if you have Magic installed, do not install MagicLib. They are redundant and may conflict.

MagicWorlds : MagicWorlds uses the Material and WeightedAverage utilities in this lib.

Admins

If you were sent here from another plugin's page, simply download the MagicLib jar and place it in your server's plugin folder. Any plugins that require it will have access to its functionality.

There are no commands, configuration, or any other functionality provided by this plugin. It is only a developer library.

If you already have the Magic plugin, you do not need (and should not download) this library. The MagicLib is included within the Magic plugin. It is provided here stand-alone in case you don't want to use Magic, but you'd like to use another plugin that depends on it.

Developers

If you wish to use the MagicLib functionality, it is pretty simple to get started. Simple add the following to your pom.xml:

<dependencies> 
  <dependency>
     <groupId>org.bukkit</groupId> 
     <artifactId>bukkit</artifactId>  
     <version>1.6.4-R2.0</version> 
     <scope>provided</scope>
  </dependency> 
  <dependency>
     <groupId>com.elmakers.mine.bukkit</groupId>
     <artifactId>MagicLib</artifactId>
     <version>2.0</version>
     <scope>provided</scope> 
  </dependency> 
</dependencies>

<repositories>
   <repository> 
     <id>bukkit-repo</id>
     <url>[http://repo.bukkit.org/content/groups/public/</url>](http://repo.bukkit.org/content/groups/public/</url>)
   </repository> 
   <repository> 
     <id>elMakers</id>
     <url>[http://maven.elmakers.com/repository/</url>](http://maven.elmakers.com/repository/</url>)
   </repository> 
</repositories>

This will allow Maven to automatically download and build with MagicLib. In your plugin.yml, add the following:

softdepend: [Magic, MagicLib]

MagicLib and Magic are currently the only two officially supported providers of the MagicLib functionality. I'm still working this out, I realize it's not the best approach. You may also choose to hard-depend on just MagicLib, but that will make your plugin incompatible with Magic.

Alternately, you are welcome to mark the Lib and MagicAPI as "compile" instead of "provided", and then shade them into your plugin. Make sure to relocate them so you don't cause conflicts with Magic or MagicLib, please!

Bugs, Features, Issues

Please use our issue tracker for all bug reports, issues, feature requests, ideas, etc. It is searchable, so you can see if your problem is already known, or maybe your idea already had :) Comments here are always appreciated, but might get lost. And please don't try to report bugs in-game.

Players

Nothing to see here!

Clone this wiki locally