Player consent
Consent belongs to Nitea, not to your mod. A player who installs five mods using Nitea is asked once, and their answer applies to all five. You never build a consent screen yourself.
How players are asked
1. Consent screen
The first time the title screen opens, Nitea shows its consent screen instead. It lists every mod using Nitea and explains what a report contains. The player chooses Allow reports or Don't allow.
2. Saved once
The answer is saved in config/nitea/nitea.properties and never asked again.
3. Changed any time
A Nitea button next to the title screen's small icon buttons opens the preferences screen, where the player can opt in or out at any time.
What each state means
| State | What happens |
|---|---|
| Not chosen yet | Errors wait in memory (up to 25 per mod). Nothing leaves the computer. Player reports aren't sent. |
| Allowed | Waiting and new events are sent. A random installation ID is created to count affected players. |
| Not allowed | Waiting events are dropped, nothing is ever sent, the installation ID is deleted and the player isn't asked again. |
Crash reports written before the player allowed reporting are never sent.
Turning off a single mod
Players can keep Nitea on but turn off one mod, in config/nitea/nitea.properties:
examplemod.enabled=false
Checking from your code
if (ExampleMod.NITEA.isEnabled()) {
// an SDK key is set, the key was accepted and the player allowed reports
}
Mention Nitea in your mod's description, so players know what the consent screen is about when they see it.
Dedicated servers have no screen: see Dedicated servers. Launchers and modpack tools can read or set consent with NiteaConsent.