Skip to content

Commit 968b4da

Browse files
Update CONTRIBUTING.md and gradle stuff
- Update gradle to 7.6 - Update gradle plugins - Use essential repo - Fix version in gradle.properties
1 parent 977ae33 commit 968b4da

File tree

5 files changed

+27
-40
lines changed

5 files changed

+27
-40
lines changed

.github/docs/CONTRIBUTING.md

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,51 +12,32 @@ git checkout -b development --track origin/development
1212
### Requirements
1313
- **IDE** (One of them)
1414
- [IntelliJ IDEA](https://www.jetbrains.com/idea/) **(Recommended)**
15+
- Our team uses IDEA. We may not be able to provide support for other IDEs.
1516
- [Eclipse](https://www.eclipse.org/)
1617
- **(Plugin) Lombok** to help with things such as not having to manually create Getters and Setters.
17-
- [IntelliJ IDEA](https://plugins.jetbrains.com/plugin/6317-lombok)
18-
- **After installing the plugin**
19-
- Go to `Preferences`
20-
- Go to `Build, Execution, Deployment`
21-
- Go to `Compiler`
22-
- Go to `Annotation Processors`
23-
- Check ☑ `Enable annotation processing`.
18+
- IntelliJ IDEA (pre-installed)
2419
- [Eclipse](https://projectlombok.org/setup/eclipse)
2520

2621
### Getting started
2722
**Note:** You can use `gradle` instead of using gradle wrapper `./gradlew`.
2823

2924
1. Clone the repository
30-
2. Setup the development environment
25+
2. Wait for the gradle project to import.
26+
3. Setup the development environment
3127
```shell script
3228
./gradlew setupDecompWorkspace
3329
```
34-
3. Integrate the development environment with your IDE
30+
4. Integrate the development environment with your IDE
3531
- IntelliJ IDEA
36-
```shell script
37-
./gradlew idea genIntellijRuns
38-
```
32+
- Done automatically
3933
- Eclipse **(doesn't generate debug configuration)**
4034
```shell script
4135
./gradlew eclipse
4236
```
43-
- (Eclipse) Change **Text File Encoding** from `Default` to `UTF-8`
37+
- Change **Text File Encoding** from `Default` to `UTF-8`
4438
- Go to `Window` -> `Preferences` -> `General` -> `Workspace`
4539
- Change `Text File Encoding` from `Default` to `UTF-8`
46-
47-
4. Make sure to add the **VM** arguments to your debug configuration:
48-
```text
49-
-Dfml.coreMods.load=codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsLoadingPlugin
50-
-Dlog4j.configurationFile=file:$ProjectFileDir$/log-config.xml
51-
```
52-
5. Include your **Minecraft** username and password as arguments in the **debug configuration**.
53-
In order, to login into [Hypixel](https://hypixel.net) by your account.
54-
```text
55-
--username "<username>" --password "<password>"
56-
```
57-
> **Note:** Don't share your password with **anyone**.
58-
> **We aren't going to ask you about your password!**
59-
6. **You are now ready to build the mod!**
40+
5. **You are now ready to build the mod!**
6041
6142
### How to build
6243
1. Build the mod
@@ -75,9 +56,14 @@ git checkout -b development --track origin/development
7556
> so the access transformers are applied to the source code!
7657
>
7758
2. (Optional) Run the **Minecraft Forge** client
78-
- Using an IDE
79-
- Run the debug configuration you created in "Getting Started."
59+
- Using IntelliJ IDEA
60+
- Add the environment variable `FETCH_DATA_ONLINE=true` if you want to use data files from the CDN.
61+
- Run the "Minecraft Client" debug configuration.
62+
- Click the link in the console to log in with [DevAuth](https://github.com/DJtheRedstoner/DevAuth).
8063
- Using the command line
8164
```shell script
8265
./gradlew runClient --args="--username <username> --password <password>"
83-
```
66+
```
67+
68+
### Questions?
69+
Visit our [Discord Server](https://discord.gg/zWyr3f5GXz) for support.

build.gradle

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import java.text.ParseException
44

55
plugins {
66
id 'java'
7-
id 'gg.essential.loom' version '0.10.0.4'
7+
id 'gg.essential.loom' version '0.10.0.5'
88
id 'dev.architectury.architectury-pack200' version '0.1.3'
9-
id 'io.freefair.lombok' version "6.5.1"
9+
id 'io.freefair.lombok' version "6.6.1"
1010
id 'com.github.johnrengelman.shadow' version '7.1.2'
1111
id 'net.kyori.blossom' version '1.3.1'
1212
}
@@ -56,6 +56,7 @@ blossom {
5656
}
5757

5858
loom {
59+
//noinspection GroovyAssignabilityCheck
5960
launchConfigs {
6061
"client" {
6162
property('fml.coreMods.load', 'codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsLoadingPlugin')
@@ -77,7 +78,7 @@ sourceSets {
7778
}
7879

7980
configurations.create('bundle')
80-
configurations.implementation.extendsFrom(configurations.getByName('bundle'))
81+
configurations.implementation.extendsFrom(configurations.named('bundle').get())
8182

8283
repositories {
8384
mavenCentral()
@@ -145,7 +146,7 @@ jar {
145146

146147
remapJar {
147148
from(tasks.shadowJar)
148-
input.set(tasks.shadowJar.archiveFile)
149+
input.set(tasks.shadowJar.archiveFile.get())
149150

150151
archiveFileName = "${project.name}-${project.version}-for-MC-${project.minecraftVersion}.jar"
151152
}

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
org.gradle.jvmargs=-Xmx2G
44

55
# SkyblockAddons Properties
6-
version=1.7.0
6+
version=1.7.1
77
# Set by CI
88
buildNumber=0
99
acceptedMinecraftVersions=[1.8.9]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
distributionBase=GRADLE_USER_HOME
22
distributionPath=wrapper/dists
3-
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-all.zip
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-all.zip
44
zipStoreBase=GRADLE_USER_HOME
55
zipStorePath=wrapper/dists

settings.gradle

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ pluginManagement {
66
url 'https://oss.sonatype.org/content/repositories/snapshots'
77
}
88
maven {
9-
url 'https://maven.architectury.dev/'
9+
url 'https://maven.architectury.dev'
1010
}
1111
maven {
1212
url 'https://maven.fabricmc.net'
1313
}
1414
maven {
15-
url 'https://maven.minecraftforge.net/'
15+
url 'https://maven.minecraftforge.net'
1616
}
1717
maven {
18-
url 'https://repo.spongepowered.org/maven/'
18+
url 'https://repo.spongepowered.org/maven'
1919
}
2020
maven {
21-
url 'https://repo.sk1er.club/repository/maven-releases/'
21+
url 'https://repo.essential.gg/repository/maven-public'
2222
}
2323
}
2424
resolutionStrategy {

0 commit comments

Comments
 (0)