Graphics settings of the player (settings.graphics) #

The Graphics tab of the Options screen: quality preset, resolution, window mode, VSync, frame rate limit, render scale, shadows, anti-aliasing, view distance, field of view and brightness. Readable offline: gripforge docs settings-graphics, or the MCP tool gripforge_docs (topic settings-graphics).

What it is for #

The kit is the player's graphics preferences, applied natively by each engine. Each option appears only where the target supports it. Only what the player changed is applied, so the game keeps its own tuning until then. The choices are saved in the player settings (gripforge.settings/<project>/settings.graphics), outside game saves, and applied again at the next start.

It is installed by default in every new game, with ui.menu, input.remap, audio.core and i18n.text. Remove it only when asked. It requires game.engine; the tab lives in ui.menu.

Turn it on #

gripforge_gamekit_install   { project_id: "gkp_…", id: "settings.graphics" }
gripforge_gamekit_configure { project_id: "gkp_…", id: "settings.graphics",
                              config: { "defaults": { "preset": "medium", "fpsLimit": 60 }, "hidden": ["fov"] } }

Only the keys that differ from the defaults need to be written. The full reference is gripforge kit api settings.graphics.

Options #

Presets set render scale, shadows, anti-aliasing and view distance: low is 70 %, off, off, 60 %; medium 85 %, medium, FXAA, 80 %; high 100 %, high, MSAA 2x, 100 %; ultra 100 %, ultra, MSAA 4x, 150 %. Changing one of them by hand switches to custom.

Settings and defaults #

Rows from other kits #

A kit adds rows to this tab by exposing, on its capability service, graphicsFields(lang), setGraphicsOption(id, value) and optionally resetGraphicsOptions(), and by calling registerSection('<capability>'). The rows appear before Restore defaults, with ids <capability>/<id>, and are reset with the tab. render.lod (its level of detail profile) is looked up without registration. Neither kit requires the other.

Service, events, variables #

Service settings.graphics: get(field), values(), chosen() (what the player changed), set(field, value), setPreset(p), presets(), supported(), resolutions(), setResolutions(list), reset() (the engine settings the kit changed are restored), reload(), registerSection(capability), sections(); options tab graphics (optionFields(lang), setOption(id, value)). Events: graphics.changed { changes, preset }, graphics.reset. Variables: graphics.preset, graphics.resolution, graphics.windowMode, graphics.vsync, graphics.fpsLimit, graphics.renderScale, graphics.shadows, graphics.antialiasing, graphics.viewDistance, graphics.fov, graphics.brightness.

Hooks and modding #

A graphics option is the player's choice, not a decision of the game, so the kit declares no hook. A mod may override defaults (a default preset, a frame rate limit) and resolutions; the values stay bounded by the config schema. hidden and only are not moddable: the game decides which options the player gets. What the player chose always wins over the defaults, modded or not.

{ "schema": "gripforge.mod/1", "id": "light_start", "name": "Light start", "version": "1.0.0",
  "requires": { "settings.graphics": "^1" }, "config": { "settings.graphics": { "defaults": { "preset": "medium" } } } }

When it does not do what you expect #