You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: mods/publishing.md
+16-2Lines changed: 16 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,16 @@
2
2
3
3
Once your awesome mod is finished, it's time to publish it for all the world to see! Geode comes with an in-game "Download" section where users can download mods from, which gets its content from [the Geode Index](https://api.geode-sdk.org/v1/mods).
4
4
5
+
Make sure to [read the **submission guidelines**](/mods/guidelines/) first to avoid common mistakes.
6
+
5
7
## Getting Your Mod on the Repo
6
8
7
-
> :warning: All mods submitted on the index **must provide the source code**! If your mod is open source, just include a link to a Github repository or equivalent. For closed source mods, see [the dedicated section](#what-about-closed-source-mods)
9
+
> :warning: All mods submitted on the index **must provide the source code**! If your mod is open source, just include a link to a Github repository or equivalent. For closed source mods, see [the dedicated section](#what-about-closed-source-mods).
8
10
9
11
Submitting a mod to the official mod index is as follows:
10
12
13
+
### Using Geode CLI
14
+
11
15
1. Make sure you have the [**latest** CLI](/getting-started/geode-cli) set up.
12
16
2. Build and release your mod somewhere - we highly recommend using GitHub releases, as this provides a straight-forward way to deal with versioning.
13
17
- Do **NOT** replace existing uploaded versions! This will change the hash and thus users will be unable to download the old version.
@@ -16,9 +20,19 @@ Submitting a mod to the official mod index is as follows:
16
20
6. Provide a **direct download link** to the .geode file (for example `https://github.com/HJfod/BetterEdit/releases/download/v6.3.3/hjfod.betteredit.geode`)
17
21
7. An **index admin** will have to validate that your mod meets the [index guidelines](/mods/guidelines) and approve your mod.
18
22
23
+
### Using the website
24
+
25
+
1. Log in on the website by using the "[Login](https://geode-sdk.org/login)" link at the bottom of the main page
26
+
2. Build and release your mod somewhere - we highly recommend using GitHub releases, as this provides a straight-forward way to deal with versioning.
27
+
- Do **NOT** replace existing uploaded versions! This will change the hash and thus users will be unable to download the old version.
28
+
3. Navigate to [your user page](https://geode-sdk.org/me) by clicking your username in the top left corner
29
+
4. Provide a **direct download link** to the .geode file (for example `https://github.com/HJfod/BetterEdit/releases/download/v6.3.3/hjfod.betteredit.geode`) in the **Submit a new mod** section.
30
+
19
31
## Releasing updates
20
32
21
-
To release an update, use `geode index mods update`. You will have to be already logged in with the index to use this command.
33
+
To release an update using Geode CLI, use `geode index mods update`. You will have to be already logged in with the index to use this command.
34
+
35
+
To release an update using the website, navigate to the mod page (available even for rejected mods) and copy the direct link into the `Modify` tab.
22
36
23
37
If you are using GitHub releases (or any other system), **do not update an existing release** - create a new one instead. Updating an existing release **will break that version of the mod**, as the Geode package is checksummed.
0 commit comments