mirror of
https://github.com/EngineHub/WorldEdit.git
synced 2024-12-27 05:00:08 +08:00
9534a9cfce
* Update so many dependencies, merge Forge/Fabric for final * Clean up contrib docs for Gradle change * Fix setting compat flags while using toolchain * Fix deprecation in doc printer * Restore proper forge JAR name * Add dist classifier for mod jar * Properly relocate new bStats * Fix jar used from fabric * Fix fabric bom * Dup the shaded classes for consistency * Sync Forge/Fabric log4j versions, de-dup * Downgrade both log4j. This will work * Update some plugins as well * Drop the fabric force stuff * Use duplicate strategy to directly merge jar
77 lines
4.0 KiB
Markdown
77 lines
4.0 KiB
Markdown
<h1>
|
|
<img src="worldedit-logo.svg" alt="WorldEdit" width="400" />
|
|
</h1>
|
|
|
|
**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. WorldEdit is compatible with Forge, Fabric, Bukkit, Spigot, Paper, and Sponge.
|
|
|
|
## Download WorldEdit
|
|
|
|
This place contains the Java code for WorldEdit, but if you want to just use WorldEdit, get the mod or plugin from these pages:
|
|
|
|
* For the mod: https://www.curseforge.com/minecraft/mc-mods/worldedit
|
|
* For the server plugin: https://dev.bukkit.org/projects/worldedit
|
|
|
|
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:
|
|
|
|
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`
|
|
|
|
🎉 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**.
|
|
|
|
When you make changes to the code, you have to restart the game by re-running the command for your changes to take effect. If there are errors in your Java syntax, the command will fail.
|
|
|
|
For additional information about compiling WorldEdit, see [COMPILING.md](COMPILING.md).
|
|
|
|
### Using a Java IDE
|
|
|
|
To edit WorldEdit in a Java IDE, follow these steps:
|
|
|
|
1. Download and install [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/).
|
|
2. In the IDE, open the folder that you saved WorldEdit's code in. This creates a new project in IDEA.
|
|
|
|
That's pretty much it.
|
|
|
|
If you want to be able to run the game also, follow these instructions:
|
|
|
|
1. Go to Run -> Edit Configurations.
|
|
2. Add a Gradle task:
|
|
1. Choose `worldedit-fabric` for the project.
|
|
2. For the tasks, type in `runClient`
|
|
3. Click OK
|
|
4. Under the Run menu again, go to "Debug [your new task]".
|
|
|
|
### Speeding up the Edit-Test-Edit-Test Cycle
|
|
|
|
It's a little annoying have to restart the game to test your changes. The best way to reduce the time is to run the server instead (using `runServer` instead of `runClient`) and then reconnect to the server after restarting it.
|
|
|
|
Submitting Your Changes
|
|
------------
|
|
|
|
WorldEdit 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 WorldEdit repository.
|
|
|
|
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for important guidelines to follow.
|
|
|
|
Links
|
|
-----
|
|
|
|
* [Visit our website](https://enginehub.org/)
|
|
* [Discord](https://discord.gg/enginehub)
|
|
* [Issue tracker](https://github.com/EngineHub/WorldEdit/issues)
|
|
* [Continuous integration](https://builds.enginehub.org) [](https://ci.enginehub.org/viewType.html?buildTypeId=bt10&guest=1)
|
|
* [End-user documentation](https://worldedit.enginehub.org/en/latest/)
|