Plexus/Plex-FAWE
1
0
Fork 0
mirror of https://github.com/plexusorg/Plex-FAWE.git synced 2024-12-22 17:27:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ci skip] docs: Update documentation for Java 17

Browse Source
This commit is contained in:
NotMyFault 2022-01-27 21:04:22 +01:00
parent 272920fb25
commit 15076f3d93
No known key found for this signature in database
GPG Key ID: 158F5701A6AAD00C
4 changed files with 58 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
COMPILING.md → COMPILING.adoc
View File

@ -1,12 +1,14 @@
Compiling :toc:
========= :toclevels: 2
= Compiling
You can compile FastAsyncWorldEdit as long as you have some version of Java greater than or equal to 17 installed. Gradle will download JDK 17 specifically if needed, You can compile FastAsyncWorldEdit as long as you have some version of Java greater than or equal to 17 installed. Gradle will download JDK 17 specifically if needed,
but it needs some version of Java to bootstrap from. but it needs some version of Java to bootstrap from.
Note that if you have JRE 8 installed, Gradle will currently attempt to use that to compile, which will not work. It is easiest to uninstall JRE 8 and replace it with JDK 16. Note that if you have JRE 8 installed, Gradle will currently attempt to use that to compile, which will not work. It is easiest to uninstall JRE 8 and replace it with JDK 17.
You can get the JDK 17 [here](https://adoptium.net/). You can get the JDK 17 link:https://adoptium.net/[here] from Adoptium.
The build process uses Gradle, which you do *not* need to download. FastAsyncWorldEdit is a multi-module project with three active modules: The build process uses Gradle, which you do *not* need to download. FastAsyncWorldEdit is a multi-module project with three active modules:
@ -14,19 +16,19 @@ The build process uses Gradle, which you do *not* need to download. FastAsyncWor
* `worldedit-bukkit` is the Bukkit plugin * `worldedit-bukkit` is the Bukkit plugin
* `worldedit-cli` is the command line interface * `worldedit-cli` is the command line interface
## To compile... == To compile...
### On Windows === On Windows
1. Shift + right-click the folder with FastAsyncWorldEdit's files and click "Open command prompt". 1. Shift + right-click the folder with FastAsyncWorldEdit's files and click "Open command prompt".
2. `gradlew clean build` 2. `gradlew clean build`
### On Linux, BSD, or Mac OS X === On Linux, BSD, or Mac OS X
1. In your terminal, navigate to the folder with FastAsyncWorldEdit's files (`cd /folder/of/fawe/files`) 1. In your terminal, navigate to the folder with FastAsyncWorldEdit's files (`cd /folder/of/fawe/files`)
2. `./gradlew clean build` 2. `./gradlew clean build`
## Then you will find... == Then you will find...
You will find: You will find:
@ -38,10 +40,10 @@ If you want to use FastAsyncWorldEdit, use the `FastAsyncWorldEdit-<identifier>`
(The `-#` version includes FastAsyncWorldEdit + necessary libraries.) (The `-#` version includes FastAsyncWorldEdit + necessary libraries.)
## Other commands == Other commands
* `gradlew idea` will generate an [IntelliJ IDEA](https://www.jetbrains.com/idea/) module for each folder. * `gradlew idea` will generate an link:https://www.jetbrains.com/idea/[IntelliJ IDEA] module for each folder.
_Possibly broken_: _Possibly broken_:
* `gradlew eclipse` will generate an [Eclipse](https://www.eclipse.org/downloads/) project for each folder. * `gradlew eclipse` will generate an link:https://www.eclipse.org/downloads/[Eclipse] project for each folder.

44
README.adoc Normal file
View File

@ -0,0 +1,44 @@
image::fawe-logo.png[150,150,align=center]
'''
FastAsyncWorldEdit is a fork of WorldEdit that has huge speed and memory improvements and considerably more features
== A Minecraft Map Editor... that runs in-game!
* With selections, schematics, copy and paste, brushes, and scripting!
* Use it in creative, survival in single player or on your server.
* Use it on your Minecraft server to fix grieving and mistakes.
Java Edition required. FastAsyncWorldEdit is compatible with Bukkit, Spigot and Paper.
=== Download FastAsyncWorldEdit
* Spigot: https://www.spigotmc.org/resources/fast-async-worldedit.13932/
* Older, unsupported, versions: https://intellectualsites.github.io/download/fawe.html
=== Links
* link:https://discord.gg/intellectualsites[Discord]
* link:https://github.com/IntellectualSites/FastAsyncWorldEdit-Documentation/wiki[Wiki]
* link:https://github.com/IntellectualSites/FastAsyncWorldEdit/issues[Report Issue]
* link:https://intellectualsites.crowdin.com/fastasyncworldedit[Crowdin (Translations)]
* link:https://javadoc.io/doc/com.fastasyncworldedit/FastAsyncWorldEdit-Bukkit/latest/index.html[JavaDocs for the -bukkit module]
* link:https://javadoc.io/doc/com.fastasyncworldedit/FastAsyncWorldEdit-Core/latest/index.html[JavaDocs for the -core module]
=== Edit The Code
Want to add new features to FastAsyncWorldEdit or fix bugs yourself? You can get the game running, with FastAsyncWorldEdit, from the code here:
For additional information about compiling FastAsyncWorldEdit, see link:COMPILING.adoc[COMPILING.adoc].
=== Submitting Your Changes
FastAsyncWorldEdit is open source (specifically licensed under GPL v3), so note that your contributions will also be open source. The best way to submit a change is to create a fork on GitHub, put your changes there, and then create a "pull request" on our FastAsyncWorldEdit repository.
Please read link:https://github.com/IntellectualSites/.github/blob/main/CONTRIBUTING.md[CONTRIBUTING.md] for important guidelines to follow.
=== YourKit
image::https://www.yourkit.com/images/yklogo.png[200,200,align=left]
Thank you to YourKit for supporting our product by providing us with their innovative and intelligent tools
for monitoring and profiling Java and .NET applications.
YourKit is the creator of link:https://www.yourkit.com/java/profiler/[YourKit Java Profiler], link:https://www.yourkit.com/.net/profiler/[YourKit .NET Profiler], and link:https://www.yourkit.com/youmonitor/[YourKit YouMonitor].

48
README.md
View File

@ -1,48 +0,0 @@
<p align="center">
<img src="fawe-logo.png" width="150">
</p>
---
FastAsyncWorldEdit is a fork of WorldEdit that has huge speed and memory improvements and considerably more features
**A Minecraft Map Editor... that runs in-game!**
* With selections, schematics, copy and paste, brushes, and scripting!
* Use it in creative, survival in single player or on your server.
* Use it on your Minecraft server to fix grieving and mistakes.
Java Edition required. FastAsyncWorldEdit is compatible with Bukkit, Spigot and Paper.
## Download FastAsyncWorldEdit
* Spigot: https://www.spigotmc.org/resources/fast-async-worldedit.13932/
* Older, unsupported, versions: https://intellectualsites.github.io/download/fawe.html
## Links
* [Discord](https://discord.gg/intellectualsites)
* [Wiki](https://github.com/IntellectualSites/FastAsyncWorldEdit-Documentation/wiki)
* [Report Issue](https://github.com/IntellectualSites/FastAsyncWorldEdit/issues)
* [Crowdin (Translations)](https://intellectualsites.crowdin.com/fastasyncworldedit)
* [JavaDocs for the -bukkit module](https://javadoc.io/doc/com.fastasyncworldedit/FastAsyncWorldEdit-Bukkit/latest/index.html)
* [JavaDocs for the -core module](https://javadoc.io/doc/com.fastasyncworldedit/FastAsyncWorldEdit-Core/latest/index.html)
## Edit The Code
Want to add new features to FastAsyncWorldEdit or fix bugs yourself? You can get the game running, with FastAsyncWorldEdit, from the code here:
For additional information about compiling FastAsyncWorldEdit, see [COMPILING.md](COMPILING.md).
## Submitting Your Changes
FastAsyncWorldEdit is open source (specifically licensed under GPL v3), so note that your contributions will also be open source. The best way to submit a change is to create a fork on GitHub, put your changes there, and then create a "pull request" on our FastAsyncWorldEdit repository.
Please read [CONTRIBUTING.md](https://github.com/IntellectualSites/.github/blob/main/CONTRIBUTING.md) for important guidelines to follow.
## YourKit
<a href="https://www.yourkit.com">
<img src="https://www.yourkit.com/images/yklogo.png">
</a>
</br>
Thank you to YourKit for supporting our product by providing us with their innovative and intelligent tools
for monitoring and profiling Java and .NET applications.
YourKit is the creator of <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>, <a href="https://www.yourkit.com/.net/profiler/">YourKit .NET Profiler</a>, and <a href="https://www.yourkit.com/youmonitor/">YourKit YouMonitor</a>

2
build.gradle.kts
View File

@ -13,7 +13,7 @@ logger.lifecycle("""
You are building FastAsyncWorldEdit! You are building FastAsyncWorldEdit!
If you encounter trouble: If you encounter trouble:
1) Read COMPILING.md if you haven't yet 1) Read COMPILING.adoc if you haven't yet
2) Try running 'build' in a separate Gradle run 2) Try running 'build' in a separate Gradle run
3) Use gradlew and not gradle 3) Use gradlew and not gradle
4) If you still need help, ask on Discord! https://discord.gg/intellectualsites 4) If you still need help, ask on Discord! https://discord.gg/intellectualsites