Skip to content

Commit

Permalink
Update to v2, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
itsmeow committed Mar 6, 2020
1 parent fac6cf8 commit 82324ef
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,12 @@ See action yml.
[Here](https://github.com/itsmeow/curseforge-upload/blob/master/.github/workflows/test.yml) is an example workflow. It uploads test_jar.jar as "Test Jar" as an alpha build to [this project](https://minecraft.curseforge.com/projects/derpcats) with versions 1.12.2 and Java 8, a changelog simply stating "Test changelog message!" with a marked incompatibility with [this project](https://www.curseforge.com/minecraft/mc-mods/betteranimalsplus) and an optional dependency on [this project](https://www.curseforge.com/minecraft/mc-mods/claimit)

### Game Version IDs:
You can get these by making a request to
You can numerical (effecient) IDs by making a request to and picking your versions
https://(endpoint).curseforge.com/api/game/versions?token=(your_token)
However, this is not always convenient. You can also use names/slugs from that link, for example: "1.12.2" and "Java 8" will be automatically parsed into the proper id.
You may encounter issues with names/slugs that have multiple entries with different game version types. The minecraft endpoint has "1.12" 5 seperate times with different game version types for Bukkit, Minecraft 1.12, etc.
To fix this, you can prefix a game version with a type id or type id slug/name. For example "Minecraft 1.12:1.12" would get you ONLY the Minecraft 1.12 version and not the 4 others.
Another example is "java:Java 8". This filters to anything named "Java 8" with the type matching the slug/name "java".

### Getting an API token
Obtain them here: https://authors.curseforge.com/account/api-tokens
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ inputs:
description: 'The id of the parent file to put this file under. Defaults to none. (IDs are integers)'
required: false
game_versions:
description: 'The game version IDs to select on this file. Seperate IDs with "," (no quotes) (IDs are integers)'
description: 'The game version IDs to select on this file. Seperate IDs with "," (no quotes). You can specify numerical or slug/name IDs and they will be converted to numerical IDs. For slugs/names with duplicates, you can specify a type by prefixing the name/slug with "(type):" (no quotes). See README for more info.'
required: true
release_type:
description: 'The type of this release. Allowed values: alpha, beta, release'
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "curseforge-upload",
"version": "1.0.0",
"version": "2.0.0",
"description": "Upload to CurseForge",
"main": "curseforge-upload.js",
"scripts": {
Expand Down

0 comments on commit 82324ef

Please sign in to comment.