woozymasta / spoutplugin Goto Github PK

SpoutPlugin is a plugin for Bukkit-based servers that exposes new API for other plugins to utilize.

Copyright (c) 2011-2012, SpoutDev <http://www.spout.org/>

SpoutDev is the team behind the Spout and Spoutcraft projects, I See You, and Pipe.

Visit our website or get support on our forums.
Track and submit issues and bugs on our issue tracker.

The latest and greatest source can be found on GitHub.
Download the latest builds from Jenkins.
View the latest Javadoc.

SpoutPlugin is licensed under the GNU Lesser General Public License Version 3.

SpoutPlugin uses Maven to handle its dependencies.

• Install Maven 2 or 3
• Checkout this repo and run: mvn clean install

For those using Maven to manage project dependencies, simply include the following in your pom.xml:

<dependency>
    <groupId>org.getspout</groupId>
    <artifactId>spoutplugin</artifactId>
    <version>dev-SNAPSHOT</version>
</dependency>

If you do not already have repo.spout.org in your repository list, you will need to add this also:

<repository>
    <id>spout-repo</id>
    <url>https://repo.spout.org</url>
</repository>

• Generally follow the Oracle coding standards.
• Use tabs, no spaces.
• No trailing whitespaces.
• 200 column limit for readability.
• Pull requests must compile, work, and be formatted properly.
• Sign-off on ALL your commits - this indicates you agree to the terms of our license.
• No merges should be included in pull requests unless the pull request's purpose is a merge.
• Number of commits in a pull request should be kept to one commit and all additional commits must be squashed.
• You may have more than one commit in a pull request if the commits are separate changes, otherwise squash them.
• For clarification, see the full pull request guidelines here.

Please follow the above conventions if you want your pull request(s) accepted.