mirror of
https://github.com/plexusorg/Plex-FAWE.git
synced 2024-12-22 17:27:38 +00:00
[ci skip] Clarify how to compile the project
This commit is contained in:
NotMyFault
parent
ceacd7b669
commit
57451f6818
24
COMPILING.md
24
COMPILING.md
@ -4,36 +4,50 @@ Compiling
|
||||
You can compile FastAsyncWorldEdit as long as you have some version of Java greater than or equal to 8 installed. Gradle will download JDK 8 specifically if needed,
|
||||
but it needs some version of Java to bootstrap from.
|
||||
|
||||
The build process uses Gradle, which you do *not* need to download. FastAsyncWorldEdit is a multi-module project with two active modules:
|
||||
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 8.
|
||||
|
||||
You can get the JDK 8 [here](https://adoptopenjdk.net/?variant=openjdk8&jvmVariant=hotspot).
|
||||
|
||||
The build process uses Gradle, which you do *not* need to download. FastAsyncWorldEdit is a multi-module project with three active modules:
|
||||
|
||||
* `worldedit-core` contains the FastAsyncWorldEdit API
|
||||
* `worldedit-bukkit` is the Bukkit plugin
|
||||
* `worldedit-cli` is the command line interface
|
||||
|
||||
## To compile...
|
||||
|
||||
### NMS
|
||||
FastAsyncWorldEdit uses NMS (net.minecraft.server) code in a variety of spots. NMS is not distributed via maven and therefore FastAsyncWorldEdit may not build without errors if you didn't install it into your local repository beforehand.
|
||||
You can do that by either running Spigot's [BuildTools](https://www.spigotmc.org/wiki/buildtools/) targetting the versions needed or using Paper's paperclip with `java -Dpaperclip.install=true -jar paperclip.jar`.
|
||||
|
||||
### On Windows
|
||||
|
||||
1. Shift + right click the folder with FastAsyncWorldEdit's files and click "Open command prompt".
|
||||
2. `gradlew build`
|
||||
2. `gradlew build -x test`
|
||||
|
||||
### 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 build`
|
||||
2. `./gradlew build -x test`
|
||||
|
||||
## Then you will find...
|
||||
|
||||
You will find:
|
||||
|
||||
* The core FastAsyncWorldEdit API in **worldedit-core/build/libs**
|
||||
* FastAsyncWorldEdit for Bukkit in **worldedit-bukkit/build/libs***
|
||||
* FastAsyncWorldEdit for Bukkit in **worldedit-bukkit/build/libs**
|
||||
* the CLI version in **worldedit-cli/build/libs**
|
||||
|
||||
If you want to use FastAsyncWorldEdit, use the `FastAsyncWorldEdit-1.16-#` version.
|
||||
If you want to use FastAsyncWorldEdit, use the `FastAsyncWorldEdit-1.16-<commitHash>` version obtained in **worldedit-bukkit/build/libs**.
|
||||
|
||||
(The `-#` version includes FastAsyncWorldEdit + necessary libraries.)
|
||||
|
||||
## Other commands
|
||||
|
||||
* `gradlew idea` will generate an [IntelliJ IDEA](http://www.jetbrains.com/idea/) module for each folder.
|
||||
|
||||
* `gradlew build -x test` skips JUnit tests for compiling.
|
||||
|
||||
_Possibly broken_:
|
||||
* `gradlew eclipse` will generate an [Eclipse](https://www.eclipse.org/downloads/) project for each folder.
|
||||
|
||||
|
||||
@ -31,6 +31,11 @@ ask that you make note of the following guidelines.
|
||||
complicated algorithms.
|
||||
|
||||
|
||||
Additional Notes
|
||||
----------------
|
||||
If you're submitting a feature, base your code on `main` and PR against the
|
||||
`main` branch.
|
||||
|
||||
Checklist
|
||||
---------
|
||||
|
||||
|
||||
55
README.md
55
README.md
@ -1,10 +1,10 @@
|
||||
<p align="center">
|
||||
<img src="fawe-logo.png" width="300">
|
||||
<img src="fawe-logo.png" width="150">
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
FAWE is a fork of WorldEdit that has huge speed and memory improvements and considerably more features
|
||||
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!**
|
||||
|
||||
@ -12,61 +12,30 @@ FAWE is a fork of WorldEdit that has huge speed and memory improvements and cons
|
||||
* 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. WorldEdit is compatible with Forge, Fabric, Bukkit, Spigot, Paper, and Sponge.
|
||||
Java Edition required. FastAsyncWorldEdit is compatible with Bukkit, Spigot, Paper, and Tuinity.
|
||||
|
||||
## Download FastAsyncWorldEdit
|
||||
### 1.15+
|
||||
* [Download](https://www.spigotmc.org/resources/fast-async-worldedit.13932/)
|
||||
* [Jenkins](https://ci.athion.net/job/FastAsyncWorldEdit-1.16/)
|
||||
|
||||
Looking builds for older versions? Download them [here](https://intellectualsites.github.io/download/).
|
||||
* Spigot: https://www.spigotmc.org/resources/fast-async-worldedit.13932/
|
||||
* Older, unsupported, versions: https://intellectualsites.github.io/download/fawe.html
|
||||
|
||||
## Links
|
||||
|
||||
* [Spigot Page](https://www.spigotmc.org/threads/fast-async-worldedit.100104/)
|
||||
* [Discord](https://discord.gg/intellectualsites)
|
||||
* [Wiki](https://wiki.intellectualsites.com/FastAsyncWorldEdit/index)
|
||||
* [Report Issue](https://github.com/IntellectualSites/FastAsyncWorldEdit/issues)
|
||||
* [Crowdin](https://intellectualsites.crowdin.com/fastasyncworldedit)
|
||||
* [Crowdin (Translations)](https://intellectualsites.crowdin.com/fastasyncworldedit)
|
||||
* [JavaDocs](https://ci.athion.net/job/FastAsyncWorldEdit-1.16/javadoc/)
|
||||
|
||||
Edit the Code
|
||||
---------
|
||||
## Edit The Code
|
||||
|
||||
Want to add new features to WorldEdit or fix bugs yourself? You can get the game running, with WorldEdit, from the code here, without any additional outside steps, by doing the following *four* things:
|
||||
Want to add new features to FastAsyncWorldEdit or fix bugs yourself? You can get the game running, with FastAsyncWorldEdit, from the code here:
|
||||
|
||||
1. Download WorldEdit's source code and put it somewhere. We recommend you use something called Git if you already know how to use it, but [you can also just download a .zip file](https://github.com/EngineHub/WorldEdit/archive/master.zip). (If you plan on contributing the changes, you will need to figure out Git.)
|
||||
2. Install any version of Java greater than or equal to 8.
|
||||
* Note that if you do _not_ install JDK 8 exactly, Gradle will download it for you on first run. However, it is still required to have some form of Java installed for Gradle to start at all.
|
||||
3. Open terminal / command prompt / bash and navigate to the directory where you put the source code.
|
||||
4. Run **one** of these following commands:
|
||||
* Mac OS X / Linux: `./gradlew :worldedit-fabric:runClient`
|
||||
* Windows - Command Prompt: `gradlew :worldedit-fabric:runClient`
|
||||
* Windows - PowerShell: `.\gradlew :worldedit-fabric:runClient`
|
||||
For additional information about compiling FastAsyncWorldEdit, see [COMPILING.md](COMPILING.md).
|
||||
|
||||
🎉 That's it. 🎉 It takes a long time to actually transform WorldEdit into a mod. If it succeeds, **the Minecraft game will open and you can create a single player world with WorldEdit**.
|
||||
## 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.
|
||||
|
||||
---
|
||||
|
||||
For additional information about compiling WorldEdit, see [COMPILING.md](COMPILING.md).
|
||||
FAWE is a fork of WorldEdit that has huge speed and memory improvements and considerably more features
|
||||
|
||||
## Building
|
||||
FAWE uses gradle to build
|
||||
You can safely ignore `gradlew setupDecompWorkspace` if you are not planning to work on the forge side of FAWE.
|
||||
|
||||
```
|
||||
$ gradlew setupDecompWorkspace
|
||||
$ gradlew build
|
||||
```
|
||||
|
||||
The jar is located in `worldedit-bukkit/build/libs/FastAsyncWorldEdit-1.16-###.jar`
|
||||
|
||||
## Contributing
|
||||
Have an idea for an optimization, or a cool feature?
|
||||
- We will accept most PR's
|
||||
- Let us know what you've tested / what may need further testing
|
||||
- If you need any help, create a ticket or discuss on [Discord](https://discord.gg/intellectualsites)
|
||||
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for important guidelines to follow.
|
||||
|
||||
## YourKit
|
||||
<a href="https://www.yourkit.com">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user