Omnisight docs

Getting Started & Global Config

Home

Getting Started & Global Config

Quick start steps and global configuration reference.

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

  1. Start the server once to generate config.json.
  2. Edit the JSON file with a text editor.
  3. 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.

FieldTypeDefaultNotes
eyeHeightnumber1.62Player eye height used for raycasting.
maxReachnumber10.0Max distance for block/entity lookups.
rayStartOffsetnumber0.4Offset from eyes to start the raycast.
stepSizenumber0.1Step size for raycast scanning.
lookUpdateIntervalTicksnumber1How often to update look-at data (ticks).
clockUpdateIntervalTicksnumber10How often to update the clock (ticks).
requiresOpbooleanfalseIf true, only OPs can use /omni.
defaultHudModestringOFFOFF, SIMPLE, FULL, CLOCK.
defaultHudSizestringmediumsmall, medium, large.
defaultInfoPositionstringtop_rightInfo panel position.
defaultClockPositionstringtop_rightClock position.
defaultClockVisiblebooleantrueClock visible by default.
defaultClockDisplayobject-Default clock layout (see Clock Display page).
defaultSimpleDisplayobject-Default info panel settings (see Simple Display page).

Valid Ranges (Clamped)

  • eyeHeight: 0.0 to 10.0
  • maxReach: 1.0 to 100.0
  • rayStartOffset: 0.0 to 5.0
  • stepSize: 0.01 to 1.0
  • lookUpdateIntervalTicks: 1 to 100
  • clockUpdateIntervalTicks: 1 to 100

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