README.md

CanaryLib

Last Build Last Successful Build ChangeLog

CanaryMod is a Minecraft Server wrapper and library with built-in data management features as well as player permissions and groups management. CanaryMod provides a stable and feature-rich framework that makes sure that Plugins written today, will still work in months without the need of updating on each Minecraft update. As server owner, this allows you to spend more time on managing your server, making it awesome, instead of waiting for all your plugins to update each time.

As a Plugin Developer, our Mod allows you to concentrate on the things that make your Plugin great and unique - you won’t ever need to bother about implementing data storage or resolving dependencies with other plugins. We do the dirty work for you, you go and make amazing plugins. It’s as easy as that!

This repository contains the library.

Plugin Development

Maven

    <dependency>
        <groupId>net.canarymod</groupId>
        <artifactId>CanaryLib</artifactId>
        <version>[0.9,)</version> <!-- Will always use the latest version found (including snapshots)-->
    </dependency>

Repository:

    <repository>
        <id>vi-repo</id>
        <name>Visual Illusions Repository</name>
        <url>http://repo.visualillusionsent.net</url>
    </repository>

Non-Maven

Add CanaryLib (unshaded or shaded) and VIUtils 1.1.1 (if using unshaded) to the build path of your Plugin project. VIUtils downloads can be found at http://wiki.visualillusionsent.net/VIUtils or http://repo.visualillusionsent.net/net/visualillusionsent/viutils/

Java Docs

Official JavaDocs

http://build.canarymod.net/job/CanaryLib/javadoc/

JavaDoc Alternate Locations http://canary.playblack.net/docs/ http://docs.visualillusionsent.net/CanaryLib/

VIUtils Library Docs http://docs.visualillusionsent.net/VIUtils/

Pull Requests

It helps us when others take the time to submit fixes rather than just pointing out bugs/inconsistencies. However, We have standards for the sources we have. Things like formatting and generally following the Sun/Oracle coding standards

Source Formatting and requirements

• No tabs; use 4 spaces instead.

• No trailing whitespaces.

• No CRLF line endings, LF only.

  • Git can handle this by auto-converting CRLF line endings into LF when you commit, and vice versa when it checks out code onto your filesystem. You can turn on this functionality with the core.autocrlf setting. If you’re on a Windows machine, set it to true — this converts LF endings into CRLF when you check out code. (git config --global core.autocrlf true)
  • Eclipse: http://stackoverflow.com/a/11596227/532590
  • NetBeans: http://stackoverflow.com/a/1866385/532590
  • IntelliJ: http://stackoverflow.com/a/9872584

• JavaDocs well written (as necessary)

• Matching how we format statements

    public class MyClass { //note the whitespace
        public void function() {
            if (something) {
                // do stuff
            }
            else if (somethingElse) {
                // do other stuff
            }
            else {
                // do else stuff
            }
        }
    }