Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 45 lines (33 sloc) 1.829 kB
6e1af58 @LadyCailin Fixed a startup bug. Also, fixed the RESET color on Windows.
LadyCailin authored
1 CommandHelper
2 =============
3
4fd7111 @LadyCailin Added status badge
LadyCailin authored
4 [![Build Status](https://travis-ci.org/EngineHub/CommandHelper.svg?branch=master)](https://travis-ci.org/EngineHub/CommandHelper)
5
82a5747 @LadyCailin Added the first iteration of the pn-viewer tool.
LadyCailin authored
6 CommandHelper adds simple command aliases, complex macros,
6e1af58 @LadyCailin Fixed a startup bug. Also, fixed the RESET color on Windows.
LadyCailin authored
7 and the ability to script your own commands and events into Minecraft,
8 using the MethodScript scripting language.
9
10 Compiling
11 ---------
12
13 You need to have Maven installed (http://maven.apache.org). Once installed,
14 simply run:
15
16 mvn clean package install
82a5747 @LadyCailin Added the first iteration of the pn-viewer tool.
LadyCailin authored
17
6e1af58 @LadyCailin Fixed a startup bug. Also, fixed the RESET color on Windows.
LadyCailin authored
18 Maven will automatically download dependencies for you. Note: For that to work,
19 be sure to add Maven to your "PATH". If you get a message about tests failing,
20 try running:
82a5747 @LadyCailin Added the first iteration of the pn-viewer tool.
LadyCailin authored
21
6e1af58 @LadyCailin Fixed a startup bug. Also, fixed the RESET color on Windows.
LadyCailin authored
22 mvn -Pprovisional-build clean package install
23
24 Contributing
25 ------------
26
27 We happily accept contributions. The best way to do this is to fork
28 CommandHelper on GitHub, add your changes, and then submit a pull request.
29 We'll look at it, make comments, and merge it into CommandHelper if
82a5747 @LadyCailin Added the first iteration of the pn-viewer tool.
LadyCailin authored
30 everything works out. If you make a PR, and feel your code is being
31 nitpicked to death, don't worry! Whenever a code review is done, it tends
32 to find lots of minor errors, even in a very experienced programmer. Don't
33 get discouraged! We'll work with you to make the changes, and all contributions
34 are appreciated. If the feature you want to add makes a significant change,
35 however, it may be best to discuss the changes with the other contributors
36 before you begin work on the feature.
37
38 By submitting code, you agree to dual license your code under the
db896bc @LadyCailin Preferences are now sorted, and comments are prettier.
LadyCailin authored
39 the MIT License and GPL, barring the special restriction regarding code submissions,
6e1af58 @LadyCailin Fixed a startup bug. Also, fixed the RESET color on Windows.
LadyCailin authored
40 explained in the SPECIAL_LICENSE.txt file, which is attached.
41
e72aca8 @LadyCailin Updated readme
LadyCailin authored
42 For details about code formatting standards, and other basic information for
43 contributors, please see the CONTRIBUTING.txt file.
44
db896bc @LadyCailin Preferences are now sorted, and comments are prettier.
LadyCailin authored
45 Portions of CommandHelper are copyright by various contributors.
Something went wrong with that request. Please try again.