search

hsyyid / EssentialCmds

EssentialCmds adds useful commands to Minecraft
https://bit.ly/2HPQ9tR
MIT License
31 stars 21 forks source link

readme

EssentialCmds Build Status

Currently not stable and under heavy development

A minecraft plugin for Sponge platforms. Contains many essential commands, features and other useful goodies.

Links

License

This plugin is licensed under MIT License. This means that you are allowed to code in any way you would like.

Prerequisites

Contributing

I really appreciate if people contribute to the project. I have a general set of rules I follow for my projects. Do read through it if you do plan on contributing.

Clone

The following steps will ensure your project is cloned properly

  1. git clone git@github.com:hsyyid/EssentialCmds.git
  2. cd EssentialCmds

Development Environment

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.

If you are a contributor, it is important that your development environment is setup properly. After cloning, as shown above, follow the given steps for your ide:

IntelliJ

  1. gradle idea --refresh-dependencies

Eclipse

  1. gradle eclipse --refresh-dependencies

Updating your Clone

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.

The following steps will update your clone with the official repo.

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.

We use Gradle for EssentialCmds.

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