Skip to content

Usage Guide

Jump to bottom
Zaldaryon edited this page Oct 13, 2026 · 13 revisions

Usage Guide

Installation

  1. Download the latest zip from GitHub Releases or Mod DB.
  2. Place the zip in the Mods folder inside your Vintage Story data directory. Do not unzip it.
  3. Start the game and join a world.

OptiTime runs on the client. A multiplayer server does not need to install it.

Check that it loaded

After joining a world, check client-main.log for [OptiTime] startup messages. If an option is unavailable, run .optitime status and look for the reason in the game log.

Commands

Commands use the .optitime prefix and are available to the local client in singleplayer and multiplayer.

Command What it does
.optitime or .optitime status Show option states and any reported reasons an option is inactive.
.optitime <option> Show information about one option.
.optitime <option> on Enable an option and save the change.
.optitime <option> off Disable an option and save the change.
.optitime profile on/off/dump/reset Start or stop profiling, print collected data, or clear it.
.optitime diag List available diagnostic counters.
.optitime diag <module> on/off/dump/reset Control and print counters for one module.

Most option changes require a game restart. The command response tells you when to restart. The suppress option changes compatibility messages without a restart.

Option names

ambientsound, bgfps, blur, dynlights, entityanim, entityinterp, flysound, framepace, guimgr, handbook, occlusion, particles, recipe, repulseagents, shaders, shadowentity, shadowveg, suppress, tickingblocks, weatherwind.

For example, .optitime bgfps off disables the background FPS limit. Run .optitime bgfps to see the option description.

Configuration

ConfigLib (optional)

If you have ConfigLib, use .configlib in game and select OptiTime. Settings are saved when changed.

JSON configuration

OptiTime creates ModConfig/OptiTime.json in the game data directory. You can edit it while the game is closed. Keep the existing entries when changing a value; the file contains settings beyond this example:

{
  "BackgroundFpsLimiterEnabled": true,
  "BackgroundMaxFps": 20,
  "ShaderOptimizations": true,
  "BlurOptimizationEnabled": true
}

Most settings need a game restart. Prefer the in-game command when you only need to change one option; it saves the setting and reports whether a restart is required.

Troubleshooting

OptiTime did not load

  • Confirm that the zip is in the game's Mods folder and that you are running Vintage Story 1.22.0 or newer.
  • Check client-main.log for the first [OptiTime] error or warning.

A world crashes or behaves differently

  • Check .optitime status and the game log for compatibility messages.
  • Disable one option at a time, restart when requested, and note whether the behavior changes.
  • When reporting the issue, include the full crash report, client-main.log, game and OptiTime versions, mod list, and steps to reproduce.

Shaders look different

  • Run .optitime shaders off and restart to disable OptiTime's shader options.
  • Run .optitime blur off to change the blur option separately.
  • Check Mod Compatibility for known shader interactions.

Commands do not work

  • Use the dot prefix: .optitime, not /optitime.
  • Run the command after joining a world.

For known interactions with other mods, see Mod Compatibility.

Clone this wiki locally