iKvxx Wiki

Documentation disclosure: This wiki is written and maintained with the assistance of AI. Although the documentation is reviewed against the current source code, it may contain mistakes or become outdated. Please report any inaccuracies through the iKvxx issue tracker.

iKvxx is the C++17 interface for iKv, a compact object-and-array data format with readable text files and efficient binary files.

#include <ikvxx/ikvxx.hpp>

ikv::Value root(ikv::objectValue, "player_save");
root["title"] = "Demo";
root["version"] = 2;

auto player = root.makeObject("player");
player["name"] = "Ada";
player["alive"] = true;

root.write("save.ikv");

Start here

Getting Started — clone, build, link, and write a first file
iKv Format — versions, value model, and compatibility
Text Format — complete syntax and parsing rules
Binary Format — v1 and indexed v2 layouts
C++ API Overview — complete ikv::Value reference
Value Types — runtime types and conversions
Objects and Arrays — construction, lookup, and mutation
Parsing and Serialization — text, files, memory, versions, and refresh
Ownership, Errors, and Limits — lifetime and failure semantics
Examples — complete common workflows
iKv2 Text Examples — ready-to-use text documents
Build, Install, and Test — CMake, package consumption, and all tests

Core properties

C++17, with RAII ownership and exceptions
JsonCpp-inspired Value access
iKv1 and iKv2 text and binary compatibility
Auto-detection when reading
iKv2 output by default
Typed or mixed arrays
Lazy top-level lookup for iKv2 binary objects

iKvxx Wiki

Start here

Core properties

Repositories

iKvxx Wiki

Format Reference

C++ API

Development