Skip to main content
Version: 26.1.x

Config Screen

dev.architectury.platform.client.ConfigurationScreenRegistry

Register a configuration screen for your mod - the screen opened from the mod's entry in the loader's mods list.

Registering a screen

ConfigurationScreenRegistry.register(
Platform.getMod(MyMod.MOD_ID), // your Mod
parent -> new MyConfigScreen(parent) // ConfigurationScreenProvider
);

The provider is given the parent screen (so you can return to it when the user closes your config), and returns the Screen to display.

Platform.getMod(id) returns the Mod for your mod id - see Mod Metadata.

Register from client-side code.