@@ -7,17 +7,17 @@ The SpongeAPI implementation targeting vanilla Minecraft and 3rd party platforms
7
7
* [ Source]
8
8
* [ Issues]
9
9
* [ Documentation]
10
- * [ Discord] : [ #sponge ]
10
+ * [ Discord ] : ` #sponge`
11
11
12
12
## Latest Builds
13
13
14
14
### Sponge
15
15
16
- ** 1.16.4 ** : ![ Snapshots] ( https://img.shields.io/nexus/maven-snapshots/org.spongepowered/sponge?label=Sponge&server=https%3A%2F%2Frepo-new.spongepowered.org%2F )
16
+ ** 1.16.5 ** : ![ Snapshots] ( https://img.shields.io/nexus/maven-snapshots/org.spongepowered/sponge?label=Sponge&server=https%3A%2F%2Frepo-new.spongepowered.org%2F )
17
17
18
18
### SpongeVanilla
19
19
20
- ** 1.16.4 ** : ![ Snapshots] ( https://img.shields.io/nexus/maven-releases/org.spongepowered/spongevanilla?label=SpongeVanilla&server=https%3A%2F%2Frepo-new.spongepowered.org%2F )
20
+ ** 1.16.5 ** : ![ Snapshots] ( https://img.shields.io/nexus/maven-releases/org.spongepowered/spongevanilla?label=SpongeVanilla&server=https%3A%2F%2Frepo-new.spongepowered.org%2F )
21
21
22
22
23
23
## Prerequisites
@@ -32,32 +32,35 @@ The following steps will ensure your project is cloned properly.
32
32
33
33
## Setup
34
34
** Note** : Sponge uses [ Gradle] as its build system. The repo includes the Gradle wrapper that will automatically download the correct Gradle
35
- version. Local installations of Gradle may work but are untested. To execute the Gradle wrapper, run the ` ./gradlew ` script on Unix systems or only
36
- ` gradlew ` on Windows systems.
35
+ version. Local installations of Gradle may work (as long as they are using Gradle 6.8+) but are untested. To execute the Gradle wrapper, run the
36
+ ` ./gradlew ` script on Unix systems or only ` gradlew ` on Windows systems.
37
37
38
- Before you are able to build Sponge, you must first prepare the environment (some IDEs may do this for you).
39
-
40
- - Run ` ./gradlew build --refresh-dependencies `
41
-
42
- Even if this fails to compile Sponge, it will download all the dependencies so you can get started.
38
+ To have browsable sources for use in-IDE, run ` ./gradlew :decompile ` . This command will need to be re-ran after any change to
39
+ Minecraft version or to ` .accesswidener ` files. If sources are not appearing properly, an IDE refresh should fix things.
43
40
44
41
### IDE Setup
45
42
__ For [ Eclipse] __
46
- 1 . Run ` ./gradlew eclipse `
47
- 2 . Import Sponge as an existing project (File > Import > General)
48
- 3 . Select the root folder for Sponge and make sure ` Search for nested projects ` is enabled
49
- 4 . Check Sponge when it finishes building and click ** Finish**
43
+ 1 . Make sure the Buildship plugin is installed (available on the [ Eclipse Marketplace] )
44
+ 2 . Import the project as an * Existing Gradle Project* (via File > Import > Gradle)
45
+
46
+ While we do our best to support any IDE, most of our developers use IntelliJ, so issues may pop up with Eclipse from time to time.
47
+ We'll be happy to work to resolve those issues if reported via [ our issues page] [ Issues ] or fixed via PR.
50
48
51
49
__ For [ IntelliJ] __
52
50
1 . Make sure you have the Gradle plugin enabled (File > Settings > Plugins).
53
51
2 . Click File > New > Project from Existing Sources > Gradle and select the root folder for Sponge.
54
52
3 . Make sure _ Use default gradle wrapper_ is selected. Older/newer Gradle versions may work but we only test using the wrapper.
55
53
54
+ For both Eclipse and IntelliJ, a variety of run configurations will be generated which allow running the client and server in development. These run
55
+ configurations will be re-generated on each project import, so any desired modifications should be done on copies of the configurations.
56
+
57
+ While these run configurations have Java versions attached to them, be aware that IntelliJ ignores that information entirely, and Eclipse will
58
+ only be able to align those java versions with whatever JREs it is aware of.
59
+
56
60
## Building
57
- __ Note:__ You must [ Setup the environment] ( #setup ) before you can build Sponge.
58
61
59
- In order to build Sponge you simply need to run the ` gradlew ` command. On Windows systems you should run ` gradlew ` instead of ` ./gradlew ` to
60
- invoke the Gradle wrapper. You can find the compiled JAR files in ` ./build/libs ` .
62
+ In order to build Sponge you simply need to run the ` gradlew build ` command. On Windows systems you should run ` gradlew build ` instead
63
+ of ` ./gradlew build ` to invoke the Gradle wrapper. You can find the compiled JAR files in ` ./build/libs ` and ` ./vanilla /build/libs` .
61
64
62
65
## Updating your Clone
63
66
The following steps will update your clone with the official repo.
@@ -72,6 +75,7 @@ Are you a talented programmer looking to contribute some code? We'd love the hel
72
75
* Please follow the above guidelines for your pull request(s) to be accepted.
73
76
74
77
[ Eclipse ] : https://eclipse.org/
78
+ [ Eclipse Marketplace ] : http://marketplace.eclipse.org/content/buildship-gradle-integration
75
79
[ Gradle ] : https://gradle.org/
76
80
[ Homepage ] : https://spongepowered.org/
77
81
[ IntelliJ ] : http://www.jetbrains.com/idea/
0 commit comments