Mirror von
https://github.com/IntellectualSites/FastAsyncWorldEdit.git
synchronisiert 2024-11-19 09:20:08 +01:00
[ci skip] docs: Update documentation for Java 17
Dieser Commit ist enthalten in:
Ursprung
272920fb25
Commit
15076f3d93
@ -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,
|
||||
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:
|
||||
|
||||
@ -14,19 +16,19 @@ The build process uses Gradle, which you do *not* need to download. FastAsyncWor
|
||||
* `worldedit-bukkit` is the Bukkit plugin
|
||||
* `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".
|
||||
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`)
|
||||
2. `./gradlew clean build`
|
||||
|
||||
## Then you will find...
|
||||
== Then 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.)
|
||||
|
||||
## 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_:
|
||||
* `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
Normale Datei
44
README.adoc
Normale Datei
@ -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
48
README.md
@ -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>
|
@ -13,7 +13,7 @@ logger.lifecycle("""
|
||||
You are building FastAsyncWorldEdit!
|
||||
|
||||
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
|
||||
3) Use gradlew and not gradle
|
||||
4) If you still need help, ask on Discord! https://discord.gg/intellectualsites
|
||||
|
Laden…
In neuem Issue referenzieren
Einen Benutzer sperren