> For the complete documentation index, see [llms.txt](https://lng.gitbook.io/lng-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lng.gitbook.io/lng-docs/companion-mod/basics/profiles-lngcompanion-city-citystate-json.md).

# profiles\LNGCompanion\City\CityState.json

***

#### 🛑 `CityState.json` Overview

⚠️ DO NOT EDIT THIS FILE MANUALLY ⚠️

The `CityState.json` is not a configuration file. It is the live, active database for the Apex City system. The mod uses this file to constantly read and write the real-time status of the city while the server is running.

***

#### ⚙️ What This File Does

If you open this file, you will see it tracks two main things:

1. `CurrentCoreHealth`: The exact integrity of the city at any given second.
2. `BuildingProgress`: A live tally of exactly which materials players have delivered to which building, and whether the building has triggered its `IsFullyBuilt` state.

#### 🚫 Why You Shouldn't Touch It

* Data Corruption: Editing this file while the server is running can cause the server to read a mismatch in data, potentially crashing the city event system.
* Wiping Player Progress: Manually changing the `DeliveredAmounts` or `IsFullyBuilt` variables can accidentally erase hours of work your players have put into rebuilding the city.

If you ever want to completely reset the Apex City back to zero (like during a server wipe), the only safe way to do it is to shut down the server completely, delete this `CityState.json` file, and restart. The mod will automatically generate a fresh, empty one.

***

#### 💻 Reference Snippet

*(For reference only. Again, do not manually edit!)*

JSON

```
{
    "CurrentCoreHealth": 0,
    "BuildingProgress": [
        {
            "MissionID": 1,
            "IsFullyBuilt": 0,
            "DeliveredClasses": [],
            "DeliveredAmounts": []
        },
        {
            "MissionID": 2,
            "IsFullyBuilt": 0,
            "DeliveredClasses": [],
            "DeliveredAmounts": []
        }
    ]
}
```

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://lng.gitbook.io/lng-docs/companion-mod/basics/profiles-lngcompanion-city-citystate-json.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.