diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2022-05-23 20:12:47 +0100 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2022-05-23 20:12:47 +0100 |
| commit | 7cea3ec42aa084763a88221047ed50fff56444cf (patch) | |
| tree | 0cc346c1785362a76d948fee75622591ebaca774 /README.md | |
| parent | 075419c5e73ee2e134705fb373a1c7477bb7b514 (diff) | |
[ci skip] Update CONTRIBUTING.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 7 insertions, 12 deletions
@@ -20,12 +20,14 @@ The latest release version of Quests can be found on [Spigot](https://www.spigotmc.org/resources/▶-quests-◀-set-up-goals-for-players.23696/). The latest build of Quests (development version) can be found on [GitHub](https://github.com/LMBishop/Quests/actions). -Alternatively, you can build Quests via Gradle. Release versions of Quests are built using **Java 8**, you can change the target version in ``build.gradle``. -* ensure Java 8 is installed on your machine -* clone this repository -* run ``gradlew`` in the base directory +Alternatively, you can build Quests via Gradle. Release versions of Quests are built using **Gradle**, targeting **Java 8**. You can change the target version in ``build.gradle``. +* Ensure Java is installed on your machine +* Clone this repository +* Run ``./gradlew`` (Linux and macOS) or ``gradlew`` (Windows) in the base directory to build Quests + * The jar will be output in `/build/libs` + +*See [CONTRIBUTING.md](https://github.com/LMBishop/Quests/blob/master/CONTRIBUTING.md) for more information.* -The final jar will be in the `build/libs/` directory. #### 🧰 Custom Task Creating new Task Types within Quests is supported, [see the wiki](https://github.com/LMBishop/Quests/wiki/New-Task-Type) for help. @@ -65,13 +67,6 @@ See https://github.com/LMBishop/Quests/graphs/contributors #### 🤝 Contributing to Quests See [CONTRIBUTING.md](https://github.com/LMBishop/Quests/blob/master/CONTRIBUTING.md) -Quests is split into separate modules: -- **common** - contains abstract classes and common code used to create a Quests plugin -- **bukkit** - an implementation of Quests for Bukkit (this is where you will most likely make changes) -- **bungee** - for BungeeCord, this isn't a Quests plugin, see [this issue](https://github.com/LMBishop/Quests/issues/180) for more info - -For instructions on building Quests, see [Downloads / Building](#💾-Downloads-/-Building). - ## 📖 Wiki Quests provides a highly detailed and well maintained [wiki](https://github.com/LMBishop/Quests/wiki/). The information there is very useful to new users of the plugin. |