Skip to content

Document that MODRINTH_PROJECTS version ID can override game/loader check #3721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 20, 2025
Merged

Document that MODRINTH_PROJECTS version ID can override game/loader check #3721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
32647f2
Document that MODRINTH_PROJECTS version ID can override game/loader c…
itzg Oct 20, 2025
8cf1eee
Missed closing parenthesis
itzg Oct 20, 2025
f7a4107
Add tip for version number and ID
itzg Oct 20, 2025
a3a75e4
Use image for project slug example
itzg Oct 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/img/modrinth-plugin-project-slug.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 10 additions & 9 deletions docs/mods-and-plugins/modrinth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Prefix : Project : Release Type
Where:

- **Project** is the project slug or ID, see below
- **Version** is the version ID or number. When omitted, the latest release version will be selected.
- **Version** is the version ID (such as "Oa9ZDzZq") or number (such as "2.21.2"). When omitted, the latest release version will be selected. Using version ID will override Minecraft and loader compatibility checks.
- **Release Type** is `release`, `beta`, or `alpha` indicating the latest version to select.
- **Prefix** is `datapack`, `fabric`, `forge`, or `paper`
- The `datapack` prefix is optional when running a vanilla server
Expand All @@ -36,14 +36,15 @@ Where:

!!! tip "Project Slug"

The project slug is the part of the URL that follows `/mod/`, `/plugin/`, or `/datapack/`. For example:

```
https://modrinth.com/mod/fabric-api
----------
|
+-- project slug
```
The project slug is the part of the URL that follows `/mod/`, `/plugin/`, or `/datapack/`. For example, this one is "essentialsx".

![](../img/modrinth-plugin-project-slug.png)

!!! tip "Version number and ID"

The version number and ID are located in the metadata panel on a version specific page, such as <https://modrinth.com/plugin/essentialsx/version/2.21.2>

![Version ID](../img/modrinth-version-id.drawio.png)

### Examples

Expand Down