SANDBOX — this is a test environment. No servers are actually deployed and no real payments are charged.
Source-checkedLibraries & compatibility

ImGui

by VSCustodian · for Vintage Story

Wrapper for GUI library

694KDownloads
1.18.8Latest game version
Vintage Story ModDBSource

About ImGui

From Vintage Story ModDB

Wrapper for GUI library

You can support me on Patreon:


Description

This is a library that brings Dear ImGui to Vintage Story

To increase/decrease font size (and GUI size as a result), use hotkeys (CTRL + - and CTRL + = by default)

Details

From Dear ImGui git repository:

Dear ImGui is designed to enable fast iterations and to empower programmers to create content creation tools and visualization / debug tools (as opposed to UI for the average end-user). It favors simplicity and productivity toward this goal and lacks certain features commonly found in more high-level libraries.

Wrapper for ImGui.NET which in it self is wrapper for Dear ImGui - graphical user interface library. In order to use this wrapper you just need to add reference on ImGui.NET (1.89.7.1) and the mod dll itself (like with other mods dependencies, both are in this mod's archive), and add your methods for constructing ImGui windows to VSImGuiModSystem.SetUpImGuiWindows event. Another example: github.com/maltiez2/vsmod_configlib/blob/master/configlib/src/GUI/ConfigWindow.cs

Supports also Not actually (working on it, it seems I need to follow this procedure, if somebody will provide this binaries I'll inculde them in mod):

This mod will allow you to make development tools like tfedit or simple throw away debug/visualisation tools for working on your mod. It would not require your mod to depend on this library if you need it only for debugging. Just wrapp all the code you dont want to ship in #if DEBUG #endif . Bulding such tools is as easy as adding logs.

 

You might want to take a look at: ToastLib for additional functionality


Features

  • Quick and easy small debug tools - you can display and edit in real time any value in any part of your code no matter how deep it is with just a one line (static methods of DebugWindow class from VSImGui namespace)
  • No dependencies required for debug tools - just wrap all the ImGui and VSImGui methods calls you add in '#if DEBUG #endif'
  • Easy to build debug tools - add more sophisticated dev tools specific to your mod to speed up development and ease debugging (for example, Animation Manager library has in-game animation editor in its dev build)
  • Easy and quick to layout GUI with docking and a lot of built-in functionality like color pickers
  • Styles - you can change every color and size and even tile your window with a texture with a simple Style and WindowStyle classes, you can serialize style into json and load it from json

 


Examples and docs (outdated)

ImGui manual for C++, but .NET methods should have same names and similar arguments: https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html

ImGui wiki: https://github.com/ocornut/imgui/wiki

Example of showing demo window: api.ModLoader.GetModSystem<VSImGuiModSystem>().SetUpImGuiWindows += ImGuiNET.ImGui.ShowDemoWindow;

Example of adding debug widget

If you have some field or property in your class (or just some reference type value) you want to display or edit via GUI, you can call a static mehod of a DebugWindow class that will display a widget in a debug window with specified domain as name inside a tab with specified category. Given title serves as this widget id, and calling DebugWindow methods for same domain and title will replace existing widget instead of adding a new one. Some mehod require also an int id, it server same perpouse as title. You can call DebugWindow method in any place of code, any amount of time, but setter and getter delegates will be called once per frame.

<pre class="language-csharp">private float someValue; private void SomeMethod() { DebugWindow.FloatSlider("My debug window title", "Some sliders", "a slider", min: 0, max: 1.0f, getter: () =&gt; someValue, setter: value =&gt; someValue = value); }</pre>

If you want to not add ImGui as dependency you can wrap its mehods with #if DEBUG #endif and leave them only in debug build

<pre class="language-csharp">private float someValue; private void SomeMethod() { #if DEBUG DebugWindow.FloatSlider("My debug window title", "Some sliders", "a slider", min: 0, max: 1.0f, getter: () =&gt; someValue, setter: value =&gt; someValue = value); #endif

Read the full description on Vintage Story ModDB →

Highlights

From source data

Game versions

Built for Vintage Story 1.18.8.

Footprint

Rated a light load on a server.

ImGui on Nxeon

From our catalogue
One-click install
Supported on Nxeon Vintage Story servers. We download it from Vintage Story ModDB, place it, and restart the server.
Server side
Required on the server
Server load
light
Smallest plan we suggest
Vintage Story — 1 GB (1 GB RAM). This follows our own load rating above, not a benchmark.

Run ImGui on a Vintage Story server

Pick a server or deploy a new one above; it is installed in one click.

What kind of mod it is

From the catalog
Listed on Vintage Story ModDB as “Mod”

Libraries & compatibility

Foundations and fixes other mods build on. Usually installed because something else needs it.

Runs on your server

From source side support

Vintage Story ModDB lists ImGui as required on the server. Check its Vintage Story ModDB page to see whether players need it too.

Compatibility

Game
Vintage Story
Runs on
Serverrequired on the server
Game versions
1.18.8

Verified at the source

  • ✓Vintage Story ModDBOfficial listing, checked 2026-09-24Open ↗
  • ✓AuthorVSCustodian, as published on Vintage Story ModDB
  • ✓LicenseNot published by the sourceFree

ImGui, answered

Generated from the mod’s own source data.

Do my players need to install ImGui?

Vintage Story ModDB lists ImGui as required on the server. Check its Vintage Story ModDB page to see whether players need it too.

Is it free?

Yes. ImGui is free to download from Vintage Story ModDB.

How do I add it to my Nxeon server?

Use “Add to a server” on this page, or open NxLabs from your dashboard. We install it, restart your server and switch it on.

NxLabs

Run ImGui on a Vintage Story server.

Deploy in about a minute from $4.00 a month, then add ImGui in one click.