Back to mods

Vintage Story Mod DB · Vintage Story mod

dumpjson

This is a debugging tool for mod developers. It adds no game content. Typos in the json files are a common mistake for mod developers. This mod helps debug those issues by showing what the game parsed the json files into. When the client starts up, it receiv

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which dumpjson release should I use?

Updated 11 days ago
Latest stable file 1.0.1
Game version 1.22.2, 1.22.3, 1.22.4
Loader Built-in Vintage Story mod system

dumpjson 1.0.1 targets 1.22.2, 1.22.3, 1.22.4. It must be installed on the client. Do not install it on the dedicated server. No extra mods listed for this file.

Where it goes

Is dumpjson required on the client, server, or both?

It must be installed on the client. Do not install it on the dedicated server.

Client Required
Dedicated server Not supported
Loader for this release Built-in Vintage Story mod system
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This Vintage Story file is marked client-only.

What else does dumpjson 1.0.1 need?

1.0.1. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add dumpjson without breaking your instance.

Built for dumpjson 1.0.1. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.0.1. It targets 1.22.2, 1.22.3, 1.22.4; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    It must be installed on the client. Do not install it on the dedicated server.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.0.1. It opens that exact file at the source.

About this project

What does dumpjson add?

This is a debugging tool for mod developers. It adds no game content.

Typos in the json files are a common mistake for mod developers. This mod helps debug those issues by showing what the game parsed the json files into.

When the client starts up, it receives the block types, item types, and entity types from the server. This mod runs on the client side, intercepts that packet, then saves those different resources as new json files in a 'dump' folder under the game logs folder. The dumped json data is after the variant processing and json patches.

The files are under the Logs directory, wherever that is configured on your system. For instance on Linux the logs go to "$HOME/.config/VintagestoryData/Logs/dump".

Note that the dumped format is very similar to the input json file, but there may be slight differences since it is actually the serialized packet from the server instead of the block load type.

Also take a look at PatchDebug, which is more focused on debugging json patches.

As an example, here is part of the dump/blocks/gravel-basalt.json:

...
  "code": "gravel-basalt",
  "entityClass": null,
  "behaviors": [
    {
      "code": "UnstableFalling",
      "attributes": "{\n  \"fallSound\": \"effect/rockslide\",\n  \"dustIntensity\": 1,\n  \"fallSidewaysChance\": 0.75\n}",
      "clientSideOptional": 0
    }
  ],
...

 

Compare that to the original file:

...
        code: "gravel",
        behaviors: [{name: "UnstableFalling", properties: { fallSound: "effect/rockslide", dustIntensity: 1, fallSidewaysChance: 0.75 }}],
        variantgroups: [
                { loadFromProperties: "block/rock", code: "rock" },
        ],
...

Project description from Vintage Story Mod DB.

Pick your setup

dumpjson releases for each Vintage Story version.

Choose the version and loader you play, then open the matching release.

5 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

dumpjson versions and loaders

2 of 2 releases match

Looking for an older file? The official Vintage Story Mod DB project page is in Resources.