# Selenium
\nA simple mod that allows YOU to make your own gui complete with editable hud.
\nThis mod aims at easing the lives of developers who don’t wish to spend the excessive time needed to create a gui.
\nThey can directly use this mod’s api to easily add buttons that control their functions.<\/p>\n
This includes:
\n– creating main tabs
\n– creating settings
\n– creating child settings
\n– choosing type (CHECK, NUMBER, TEXT)
\n– setting default value
\n– marking them as HUD
\n– reading\/writing your values later<\/p>\n
# The current api includes the following features
\nEnsures a main tab exists in Selenium.
\n“`
\nSeleniumApi.ensureMainTab(name)
\n“`
\nRegisters a top-level setting with default locked API permissions.
\n“`
\nSeleniumApi.registerSetting(ownerModId, key, mainTab, label, type, renderType, defaultValue, hud, subSettings)
\n“`<\/p>\n
Registers a top-level setting with explicit player-edit permissions.
\n“`
\nSeleniumApi.registerSetting(ownerModId, key, mainTab, label, type, renderType, defaultValue, hud, subSettings, permissions)
\n“`<\/p>\n
Registers a child setting under an existing parent with default locked API permissions.
\n“`
\nSeleniumApi.registerChildSetting(ownerModId, key, mainTab, parentId, label, type, renderType, defaultValue, hud, subSettings)
\n“`<\/p>\n
Registers a child setting under an existing parent with explicit player-edit permissions.
\n“`
\nSeleniumApi.registerChildSetting(ownerModId, key, mainTab, parentId, label, type, renderType, defaultValue, hud, subSettings, permissions)
\n“`<\/p>\n
Checks whether a Selenium setting with that id exists.
\n“`
\nSeleniumApi.hasSetting(id)
\n“`<\/p>\n
Reads a check\/toggle setting as a boolean.
\n“`
\nSeleniumApi.getToggle(id)
\n“`<\/p>\n
Sets a check\/toggle setting value.
\n“`
\nSeleniumApi.setToggle(id, enabled)
\n“`<\/p>\n
Reads a number setting as a double.
\n“`
\nSeleniumApi.getNumber(id)
\n“`<\/p>\n
Sets a number setting value.
\n“`
\nSeleniumApi.setNumber(id, value)
\n“`<\/p>\n
Reads a text setting value.
\n“`
\nSeleniumApi.getText(id)
\n“`<\/p>\n
Sets a text setting value.
\n“`
\nSeleniumApi.setText(id, value)
\n“`<\/p>\n
Declares a boolean on\/off setting type
\n“`
\nSeleniumApi.SettingType.CHECK
\n“`<\/p>\n
Declares a numeric setting type.
\n“`
\nSeleniumApi.SettingType.NUMBER
\n“`<\/p>\n
Declares a text\/string setting type.
\n“`
\nSeleniumApi.SettingType.TEXT
\n“`<\/p>\n
Defines what the player is allowed to do to an API-created setting.
\n“`
\nSeleniumApi.Permissions(allowHudEdits, allowGuiAdd, allowGuiEdit, allowHiding)
\n“`<\/p>\n
Returns the default API permissions: locked editing, hiding allowed.
\n“`
\nSeleniumApi.Permissions.defaults()
\n“`<\/p>\n
Returns permissions that let the player fully edit the setting and HUD.
\n“`
\nSeleniumApi.Permissions.fullyEditable()
\n“`<\/p>\n
Add a color setting type (stores the color as hex #RRGGBB)
\n“`
\nSeleniumApi.registerSetting(ownerModId, key, mainTab, label, SeleniumApi.SettingType.COLOR, renderType, “#FFFFFF”, hud, subSettings, permissions)
\n“`<\/p>\n
Add a bounded slider setting type (min\/max\/step) Add a selectable choice setting type (comma separated options) ### Commands<\/p>\n Selenium adds a few commands, namely:<\/p>\n “`\/selenium gui“`<\/p>\n > Opens the main gui, listing all the options allowing enabling\/disabling options<\/p>\n “`\/selenium edithud“`<\/p>\n > Allows the editing of the hud, by dragging and resizing the elements<\/p>\n “`\/selenium editgui“`<\/p>\n > Allows the creation\/deletion of new buttons<\/p>\n > Editing is disbaled by default, unless the develpoer chooses to enable it.<\/p>\n “`\/selenium tutorial“`<\/p>\n > Opens the tutorial screen<\/p>\n ## Hud rendering ## The main UI ## Editing main tab ## Editing an existing setting ## Creating a main tab (shown on the left side of the ui) ## Easily hide settings and access them ## The tutorial screen A simple mod that allows the player to create and customise their own gui. Mainly useful for other mod developers who don’t want to spend the time and energy in creating a gui<\/p>\n","protected":false},"featured_media":137006,"template":"","meta":{"_minecraft_slug":"selenium-thegwimweeper","_minecraft_project_id":"RU1tqjn2","_minecraft_author":"thegwimweeper","_minecraft_license":"MIT","_minecraft_downloads":10,"_minecraft_follows":0,"_minecraft_client_side":"required","_minecraft_server_side":"unsupported","_minecraft_storage_type":"zip","_minecraft_archive_name":"selenium-thegwimweeper.zip","_minecraft_size_bytes":125074,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T13:12:56.429579Z","_minecraft_date_created":"2026-05-05T21:35:26.574843Z","_minecraft_date_modified":"2026-04-23T20:28:46.342796Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/selenium-thegwimweeper","_minecraft_icon_attachment_id":137006,"_minecraft_imported_at":"2026-06-08T02:18:17+00:00","_minecraft_import_hash":"e754a81b089e32edf61cba295555971a","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,126,123,92],"mod_loader":[99],"minecraft_version":[41],"class_list":["post-137005","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-management","mod_category-technology","mod_category-utility","mod_loader-fabric","minecraft_version-1-21-11"],"yoast_head":"\n
\n“`
\nSeleniumApi.registerSetting(ownerModId, key, mainTab, label,
\n SeleniumApi.SettingType.SLIDER, renderType, “50”,
\n Map.of(“min”, “0”, “max”, “100”, “step”, “1”),
\n hud, subSettings, permissions)
\n“`
\n>You can pass metadata via a “`Map
\nThe default value is set by “50” by hardcoding it (This is where the slider starts by default)<\/p>\n
\n“`SeleniumApi.registerSetting(ownerModId, key, mainTab, label,
\n SeleniumApi.SettingType.CHOICE, renderType, “Medium”,
\n Map.of(“options”, “Low, Medium, High”),
\n hud, subSettings, permissions)
\n“`
\n>Same as slider, the metadata can be passed via a “`Map
\n<\/p>\n
\n<\/p>\n
\n<\/p>\n
\n<\/p>\n
\n<\/p>\n
\n<\/p>\n
\n<\/p>\n","protected":false},"excerpt":{"rendered":"