Skip to main content

NiteaOptions

NiteaOptions options = NiteaOptions.builder("examplemod")
        .owner(ExampleMod.class)
        .release("1.0.0")
        .gameDir(FMLPaths.GAMEDIR.get())
        .tag("edition", "lite")
        .maxBreadcrumbs(50)
        .build();

Only the mod ID is required. Nitea detects the Minecraft version, loader and its version, side and environment on its own.

Builder​

builder(String modId)​

static Builder · required

Your mod ID. Lowercase, starts with a letter, then letters, digits, _ and - (Fabric), 2 to 64 characters. Throws IllegalArgumentException otherwise.

owner(Class<?>)​

Builder

A class of your mod. Its package marks your code for error attribution; its class loader finds your bundled nitea/<modid>.properties. Strongly recommended.

inAppPackages(String...)​

Builder · default owner's package

Your code's packages, when it spans several root packages.

release(String)​

Builder

Your mod version, attached to every event.

gameDir(Path)​

Builder · default working directory

Where config/ and crash-reports/ are. Pass FMLPaths.GAMEDIR.get() on NeoForge and Forge, FabricLoader.getInstance().getGameDir() on Fabric.

sdkKey(String)​

Builder

The project's SDK key. Prefer the bundled resource over hardcoding it.

endpoint(String)​

Builder · default https://nitea.cc

The Nitea API server.

tag(String, String)​

Builder

A tag attached to every event from this mod. Call it several times for several tags.

maxBreadcrumbs(int)​

Builder · default 100

How many breadcrumbs are kept and attached to each event, from 0 (off) to 100.

captureUncaught(boolean)​

Builder · default true

Report uncaught exceptions your mod caused.

scanCrashReports(boolean)​

Builder · default true

Report Minecraft crash reports your mod caused, on the next launch.

openReportLinks(boolean)​

Builder · default true

On the client, open the player's browser at the link to complete a bug report or suggestion. Only happens when your project has a public page.

environment(String)​

Builder · default detected

Overrides the detected environment, production or development.

minecraftVersion(String)​

Builder · default detected

Overrides the detected Minecraft version.

loader(String name, String version)​

Builder · default detected

Overrides the detected loader name and version.

side(String)​

Builder · default detected

Overrides the detected side, client or server.

debug(boolean)​

Builder · default false

Log every request and response, for troubleshooting.

build()​

NiteaOptions

Builds the options to pass to Nitea.init.