Getting Started & Global Config
This guide explains how to configure OmniSight using JSON. There are two layers of configuration:
- Global config:
mods/OMNISIGHT/config.json(server-wide defaults and system settings) - Player configs:
mods/OMNISIGHT/players/<username>_<uuid>.json(per-player overrides)
Quick Start
- Start the server once to generate
config.json. - Edit the JSON file with a text editor.
- Restart the server to apply changes.
Note: On startup, OmniSight validates and normalizes values. If a value is invalid, it is clamped or reset, and the file is saved back to disk.
Global Config (config.json)
These fields control system behavior and the defaults used when a new player joins.
| Field | Type | Default | Notes |
|---|---|---|---|
eyeHeight | number | 1.62 | Player eye height used for raycasting. |
maxReach | number | 10.0 | Max distance for block/entity lookups. |
rayStartOffset | number | 0.4 | Offset from eyes to start the raycast. |
stepSize | number | 0.1 | Step size for raycast scanning. |
lookUpdateIntervalTicks | number | 1 | How often to update look-at data (ticks). |
clockUpdateIntervalTicks | number | 10 | How often to update the clock (ticks). |
requiresOp | boolean | false | If true, only OPs can use /omni. |
defaultHudMode | string | OFF | OFF, SIMPLE, FULL, CLOCK. |
defaultHudSize | string | medium | small, medium, large. |
defaultInfoPosition | string | top_right | Info panel position. |
defaultClockPosition | string | top_right | Clock position. |
defaultClockVisible | boolean | true | Clock visible by default. |
defaultClockDisplay | object | - | Default clock layout (see Clock Display page). |
defaultSimpleDisplay | object | - | Default info panel settings (see Simple Display page). |
Valid Ranges (Clamped)
eyeHeight:0.0to10.0maxReach:1.0to100.0rayStartOffset:0.0to5.0stepSize:0.01to1.0lookUpdateIntervalTicks:1to100clockUpdateIntervalTicks:1to100
Supported Positions
OmniSight accepts flexible input (like TopRight, top-right, top right) and normalizes to snake_case.
- Info panel:
top_left,top_center,top_right - Clock:
top_left,top_center,top_right,bottom_left,bottom_center,bottom_right - Equipment HUD:
top_left,top_right,bottom_left,bottom_right