Digitalroot.OdinPlusModUploader
1.0.9
Tool Renamed
dotnet tool install --global Digitalroot.OdinPlusModUploader --version 1.0.9
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local Digitalroot.OdinPlusModUploader --version 1.0.9
#tool dotnet:?package=Digitalroot.OdinPlusModUploader&version=1.0.9
nuke :add-package Digitalroot.OdinPlusModUploader --version 1.0.9
OdinPlus Mod Uploader
Introduction
This is a command-line tool that can be used to upload mod files to an existing mod on Thunderstore, ModVault and Nexus Mods.
Note: Thunderstore and ModVault support will be in a future release.
Installation
You can either download the binary for your platform from the Releases section on the right, or install it using the dotnet
CLI:
dotnet tool install -g OdinPlusModUploader
# then run with
opmu
Configuration and Usage
While you can pass all values at the command line. Please use environment variables for the sensitive information.
You have been warned!
Environment Variables
- NEXUSMOD_API_KEY
- NEXUSMOD_COOKIE
All Commands support the -?, -h, --help
options to show help and usage information
Commands:
OdinPlusModUploader -h
Description:
Uploads mods to Thunderstore, ModVault, or NexusMods
Usage:
OdinPlusModUploader [command] [options]
Options:
--version Show version information
-?, -h, --help Show help and usage information
Commands:
modvault, mv modvault.xyz commands.
nexusmods, nx nexusmods.com commands.
thunderstore, ts thunderstore.io commands.
OdinPlusModUploader nx -h
Description:
nexusmods.com commands.
Usage:
OdinPlusModUploader nexusmods [command] [options]
Options:
-?, -h, --help Show help and usage information
Commands:
check Check that an API Key and Cookie are valid.
upload <mod-id> <archive-file> Upload a file of 20.0GB or less to nexusmods.com
OdinPlusModUploader check -h
Description:
Check that an API Key and Cookie are valid.
Usage:
OdinPlusModUploader nexusmods check [options]
Options:
-k, --key <key> Api Key, ENV: NEXUSMOD_API_KEY
-c, --cookie <cookie> Session Cookie, ENV: NEXUSMOD_COOKIE
-?, -h, --help Show help and usage information
OdinPlusModUploader upload -h
Description:
Upload a file of 20.0GB or less to nexusmods.com
Usage:
OdinPlusModUploader nexusmods upload [<mod-id> <archive-file>] [options]
Arguments:
<mod-id> Nexus mod id.
<archive-file> File to upload.
Options:
-f, --file-name <file-name> (REQUIRED) Name for the file on Nexus Mods
-v, --version <version> (REQUIRED) Version for your uploaded file.
-t, --category <Archived|Main|Misc|Old|Optional|Updates> (REQUIRED) Mod file category [default: Main]
-d, --description <description> description
-g, --game <game> Game mod is for. [default: valheim]
-dmfu, --disable-main-file-update Skips replacing an existing file in the 'Main' category with the new one. [default: False]
-ddwm, --disable-download-with-manager Removes the 'Download With Manager' button. [default: False]
-dvu, --disable-version-update Skips updating mod's main version to match this file's version. [default: False]
-dmv, --disable-main-vortex Skips setting file as the main Vortex file. [default: False]
-drpu, --disable-requirements-pop-up Skips informing downloaders of this mod's requirements before they attempt to download this file [default: False]
-k, --key <key> Api Key, ENV: NEXUSMOD_API_KEY
-c, --cookie <cookie> Session Cookie, ENV: NEXUSMOD_COOKIE
-?, -h, --help Show help and usage information
Examples
nexusmods check -k "7a0e--MyVeryLongNexusApiKey--377" -c "%7B%22mechanism--MyVeryLongNexusSessionCookieValue--%22%7D"
nexusmods upload 1303 Digitalroot.Valheim.JVL.BT.Fix.v1.0.6.zip -v 1.0.6 -f TestFile -t Main -ddwm -dmv -d "My Test File"
Note: Strings can also be wrapped in quotes. The following command is the same as the example above it.
nexusmods upload 1303 "Digitalroot.Valheim.JVL.BT.Fix.v1.0.6.zip" -v "1.0.6" -f "TestFile" -t Main -ddwm -dmv -d "My Test File"
FAQ
Nexus Mods
Q1: Where do I find out more info about the Nexus Mods' Public API?
Q2: Does Nexus Mods' API Rate Limit?
Yes, see. Nexus Mods Public API
Q3: Where do I get my Nexus Mods' API key?
Q4: Where do I get my Nexus Mods' Session Cookie?
From your browser. This site covers how to do it in most browers. The cookie you are looking for is called
nexusid
and starts with%7B%22mechanism
. This is the html encoded value for{"mechanism
. If your browser displays a cookie value starting with{"mechanism
then you will need to html encode the value before using this tool.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
This package has no dependencies.
Version | Downloads | Last updated |
---|
Initial Release, works for NexusMods only.