|
2 | 2 |
|
3 | 3 | [](https://ci.explodingcreeper.me/view/HypherionMC's%20Projects/job/CurseGradle/) |
4 | 4 |
|
5 | | -An updated fork of the CurseGralde gradle plugin for publishing artifacts to [CurseForge](https://curseforge.com/). |
| 5 | +An updated fork of the CurseGradle gradle plugin for publishing artifacts to [CurseForge](https://curseforge.com/). |
6 | 6 |
|
7 | | -This project was originally created by Matthew Prenger, but hasn't been updated since 2020, and with Minecraft Switching to Java 16, this could pose some problems. So I forked and updated the project to support Gradle 7 and Java 16. |
| 7 | +This project was originally created by Matthew Prenger, but hasn't been updated since 2020. I intend to keep this plugin up to date, as well as add new features |
8 | 8 |
|
9 | 9 | ___ |
10 | 10 |
|
11 | 11 | * Discord: [Hypherion Development](https://discord.gg/PdVnXf9) |
12 | | -* [Wiki](https://github.com/matthewprenger/CurseGradle/wiki/) |
| 12 | +* [Wiki](https://readme.hypherionmc.me/cursegradle/getting-started/) |
13 | 13 | * [Changelog](https://github.com/exploding-creeper/CurseGradle/releases) |
14 | 14 |
|
15 | 15 | ___ |
16 | 16 |
|
17 | | -## Simple Quickstart with ForgeGradle |
18 | | -If you're using ForgeGradle, which you probably are, the following script is a bare-minimum. For more details about customization, check out the [Wiki](https://github.com/matthewprenger/CurseGradle/wiki). |
| 17 | +## Quickstart |
19 | 18 |
|
20 | | -### This plugin is still pending approval on the Gradle Plugin registry, so for now, please use the MAVEN method. |
| 19 | +To get started with CurseGradle, please check out [Getting Started](https://readme.hypherionmc.me/cursegradle/getting-started/) |
21 | 20 |
|
22 | | -To find out which versions are available, check [HERE](https://maven.explodingcreeper.me/me/hypherionmc/CurseGradle/). |
23 | | - |
24 | | -___ |
25 | | - |
26 | | -### Installation |
27 | | -#### Via Gradle Plugins |
28 | | - |
29 | | -```gradle |
30 | | -plugins { |
31 | | - id 'net.minecraftforge.gradle.forge' version '2.0.2' |
32 | | - id 'me.hypherionmc.cursegradle' version '<VERSION>' |
33 | | -} |
34 | | -``` |
35 | | - |
36 | | -#### Via My Maven (Recommended) |
37 | | -```gradle |
38 | | -buildscript { |
39 | | - repositories { |
40 | | - // These repositories are only for Gradle plugins, put any other repositories in the repository block further below |
41 | | - maven { url = 'https://maven.minecraftforge.net' } |
42 | | - maven { url = "https://maven.explodingcreeper.me" } |
43 | | - mavenCentral() |
44 | | - } |
45 | | - dependencies { |
46 | | - classpath group: 'net.minecraftforge.gradle', name: 'ForgeGradle', version: '5.1.+', changing: true |
47 | | - } |
48 | | -} |
49 | | -plugins { |
50 | | - id 'me.hypherionmc.cursegradle' version '<VERSION>' |
51 | | -} |
52 | | -apply plugin: 'net.minecraftforge.gradle' |
53 | | -``` |
54 | | - |
55 | | -#### Task Setup |
56 | | -```gradle |
57 | | -curseforge { |
58 | | - apiKey = '123-456' // This should really be in a gradle.properties file |
59 | | - project { |
60 | | - id = '12345' |
61 | | - changelog = 'Changes' // A file can also be set using: changelog = file('changelog.txt') |
62 | | - releaseType = 'beta' |
63 | | - } |
64 | | -} |
65 | | -``` |
66 | | -___ |
| 21 | +--- |
67 | 22 |
|
68 | 23 | Thanks to Matthew for creating the original plugin and if you want to contribute to this fork, you are welcome to do so. |
0 commit comments