-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7b39396
commit fe49f5f
Showing
1 changed file
with
17 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,21 @@ | ||
# Crucials | ||
|
||
Crucials | ||
========== | ||
A plugin that offers crucial and helpful commands. | ||
-------------------------------------------------- | ||
|
||
Crucials has unique features that make it different from any other plugin that helps server administrators. It offers extra commands like `/saveserver` (coming again soon) which saves your entire network to a repo of your choice. | ||
|
||
Compiling from Source | ||
------ | ||
To compile Crucials, you will need JDK <version> or later, an internet connection, and preferably an IDE (IntelliJ | ||
is the best). | ||
|
||
NOTE: Crucials isn't fully functional yet. | ||
If you don't want to use an IDE, clone this repo and run `./gradlew build`. You can find the compiled jar in `build/libs` | ||
as `Crucials-<version>.jar`. Otherwise, clone this repo, set up a project that uses existing resources, and add a configuration that runs `gradle build`. | ||
|
||
## What Crucials offers | ||
Binaries | ||
------ | ||
You can download the jar files in the releases tab if you don't want to compile Crucials from source. Keep in | ||
mind, it usually won't be up-to-date with the latest commit. | ||
|
||
Crucials has unique features that make it different from any other plugin that helps server administrators. It offers extra commands like /saveserver which saves your entire network to a repo of your choice. | ||
(c) 2021-2024 Anston Sorensen |