Skip to content

NexusMods Integration

FelisDiligens edited this page Dec 9, 2020 · 6 revisions

How do I log in?

First, open nexusmods.com in your default web browser and log in, if you haven't already.

Then open the NexusMods tab in the settings window:
https://i.imgur.com/yq5TwND.png

From there, click on "Log in". This will open your web browser.
In your web browser, click on "Authorize":
https://i.imgur.com/DoxfJQT.png

After that, you should be logged in. Have fun. :)

Having issues?

When you're on Windows 7, the login probably fails.
Please follow this guide to login with an API key: Troubleshooting: Login with NexusMods failed

What is the API (and my account) being used for?

The mod manager uses the API:

  • to download thumbnails and additional information about a mod for display,
  • to check for updates,
  • to allow you to endorse or abstain from endorsing a mod (or all mods).

The tool uses the API:

  • to display your profile picture, username, and rate limit for your convenience.

What is the rate limit?

The tool will display some information about your profile, if you're logged in. This is where you can check your rate limit:

https://i.imgur.com/wS8vyPt.png

Every time the tool makes a request to the API, you'll use up a bit of your rate limit.
Once you used it up completely, you won't be able to access the API for a while until it resets.
(You'll still be able to use the website, don't worry)

In total, you get 2500 daily requests in addition to 100 hourly requests.
This is plenty and you're unlikely to completely use it up.

Read more about it here: I have reached a daily or hourly limit / API requests have been consumed / Rate Limit Exceeded - What does this mean?

Information about your privacy

Since I want to be completely transparent about what my tool does and why, here you have all the necessary (and unnecessary) details about it. Because... why not? lol

What information about my profile is stored?

Your profile information is stored in the configuration folder of the tool in plain text.
This includes:

  • Your API key
  • Your user ID
  • Your username
  • Your profile picture
  • Your membership status
  • Daily and hourly rate limits
  • Daily rate limit reset time

When you log out, the tool will delete your profile information from the folder.

What information will be sent?

This goes without saying, but naturally any information will be sent encrypted over HTTPS.

If you want to know exactly what is being sent to NexusMods' servers when using the API, here you go:

API key

Your API key is directly linked to your NexusMods account.
That means, if you access the API through the tool, NexusMods will know, the request is sent by you.

It is needed for authentification and without it, the tool cannot access the API.

The API key is retrieved during the log in, the very moment you click on "Authorize".

User Agent string

Whenever the tool accesses the API, it sents a User Agent that looks somewhat like this:
Fo76QuickConfiguration/1.9.0 (Windows NT 10.0.19042.0; x64) .NETFramework/4.7.2

It contains:

  • The tool's version
  • The .NET Framework version that the tool is targeting
  • Your OS platform (probably Windows NT)
  • Your OS version (e.g. 7, 8, 8.1, 10)
  • Your OS architecture (32 bit or 64 bit)

From NexusMods' API reference:

Applications should send a valid user agent string identifying the application/library they are using and system information. This allows us to collect statistics and aides with debugging potential problems.

HTTP Request Headers

In addition to the API key and User Agent, the following headers will be sent:

  • Application-Version - The installed version
  • Application-Name - Will always be: Fallout 76 Quick Configuration

When retrieving mod information and thumbnails

Additionally to above, the following information will be sent, when you check for updates:

  • All IDs of your installed mods (required)

When endorsing a mod

Additionally to above, the following information will be sent, when you endorse a mod:

  • The mod ID (required)
  • The mod version you entered (required)