A Minecraft plugin API
Switch branches/tags
1.13 better-data-test bleeding bugfix/1543 bye-skylands change-value cleanup/javadocs cleanup/warnings-bleeding compile-time-event event-gen-perf feature/ap-jar feature/change-value-event feature/clean-redstone feature/clickedslot feature/client feature/context-value-annotation feature/context feature/custominventory feature/data-generation feature/dropitemeventclose feature/elytra-data feature/entity-snapshot-init feature/errorreport feature/factory-gen-suppression feature/highest-block feature/improve-contextualservice feature/improvedargs-scaledback feature/improvedargs feature/itemcomparators feature/kt feature/locatable feature/location-ai feature/logging feature/minecart-data feature/more-inventory feature/ocd feature/perms-update feature/permsordering feature/plain-pages feature/player-gui feature/player-skins feature/plugin-configs feature/plugin-construction feature/pretty-printer feature/schematic-transparency feature/serializable-state-matcher feature/spawnprotection feature/stats-service feature/structure-storage feature/structures feature/tabcompletepos feature/tank-max-capacity feature/transferevent feature/vanillaarchetype feature/vd fix/inventorycommandcapture gradle-3.4 inventory-queries modifier-merge plugin-datamanipulator-implementation readme-warning refactor/commands-to-impl-1 refactor/entity-hierarchy refactor/extent refactor/inventory-events refactor/values release-3.1.0 release-4.0.0 release-4.1.0 release-4.2.0 release s5/user-name-lookup shield-damage stable-4 stable-4.2.0 stable-5 stable-5.1.0 stable-5.2.0 stable-6 stable-6.1.0 stable-7 temp-cause temp tempfix/breed-event update/bleeding value-copy xp-events
Nothing to show
Clone or download
Latest commit 6eb292f Aug 18, 2018

README.md

SpongeAPI Build Status

Currently not stable and under heavy development!
A Minecraft plugin API (not including an implementation). It is licensed under the MIT License.

Prerequisites

Clone

The following steps will ensure your project is cloned properly.

  1. git clone git@github.com:SpongePowered/SpongeAPI.git
  2. cd SpongeAPI
  3. cp scripts/pre-commit .git/hooks

Building

Note: If you do not have Gradle installed then use ./gradlew for Unix systems or Git Bash and gradlew.bat for Windows systems in place of any 'gradle' command.

In order to build SpongeAPI you simply need to run the gradle command. You can find the compiled JAR file in ./build/libs labeled similarly to 'spongeapi-x.x.x-SNAPSHOT.jar'.

Contributing

Are you a talented programmer looking to contribute some code? We'd love the help!

  • Open a pull request with your changes, following our guidelines.
  • Please follow the above guidelines and requirements for your pull request(s) to be accepted.