Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kristiker/keyvalues3
Source2 KeyValues3 library for Python
https://github.com/kristiker/keyvalues3
json-like keyvalues kv3 source2 valve
Last synced: 2 months ago
JSON representation
Source2 KeyValues3 library for Python
- Host: GitHub
- URL: https://github.com/kristiker/keyvalues3
- Owner: kristiker
- License: mit
- Created: 2022-11-18T22:58:15.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-16T17:56:56.000Z (7 months ago)
- Last Synced: 2024-11-01T02:42:10.364Z (2 months ago)
- Topics: json-like, keyvalues, kv3, source2, valve
- Language: Python
- Homepage: https://developer.valvesoftware.com/wiki/Dota_2_Workshop_Tools/KeyValues3
- Size: 134 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## keyvalues3
KeyValues3 is a Valve developed data format. It is similar in structure to JSON, but supports binary encodings, versioning, and data annotations. The text syntax also has some minor ergonomic improvements (support for single- and multi-line comments, trailing commas, and multi-line strings.)
## Usage
```py
import keyvalues3 as kv3
bt_config = kv3.read("tests/documents/bt_config.kv3")
>>> bt_config.keys()
dict_keys(['default', 'low', 'fair', 'normal', 'tough', 'hard', 'very_hard', 'expert', 'elite'])
>>> bt_config["elite"]["reaction_time"]
0.12
```
```py
# The root value is most of the time a dict
>>> type(bt_config.value)
>>> bt_config.original_encoding
Encoding(name='text', version=UUID('e21c7f3c-8a33-41c5-9977-a76d3a32aa0d'))
>>> bt_config.format
Format(name='generic', version=UUID('7412167c-06e9-4698-aff2-e63eb59037e7'))
# To write it back
>>> kv3.write(bt_config, "tests/documents/bt_config.kv3", use_original_encoding=True)
# Write to a stream
>>> import sys
>>> kv3.write({"key": [1,2,3]}, sys.stdout)
{
key = [1, 2, 3]
}
```
## Install [](https://badge.fury.io/py/keyvalues3)
```bash
pip install keyvalues3
```
## Supported encodings
| Encoding 👩💻 | Read 📖 | Write ✍️ |
| ----------- | :-----: | :-------: |
| Text UTF-8 | Yes ✔️ | Yes ✔️ |
| Text UTF-8 Headerless | Yes ✔️ | Yes ✔️ |
| Binary Uncompressed | No ⛔ | Yes ✔️ |
| Binary LZ4 | No ⛔ | Yes ✔️ |
| Binary (Other newer) | No ⛔ | No ⛔ |
## Using dataclasses
Dataclasses (marked with `@dataclass`) are also supported for serialization (uses `asdict()`)
```py
@dataclass
class RenderMeshFile(_Node): # _Node defines _class, name, notes, and children (+ helper methods)
filename: resourcepath = ""
import_translation: list[float] = field(default_factory=lambda: [0, 0, 0])
import_rotation: list[float] = field(default_factory=lambda: [0, 0, 0])
import_scale: float = 1.0
align_origin_x_type: str = "None"
align_origin_y_type: str = "None"
align_origin_z_type: str = "None"
parent_bone: namelink = ""
import_filter: dict = field(
default_factory=lambda:dict(
exclude_by_default = False,
exception_list = [ ]
)
)
```
You can find more ModelDoc dataclasses [here](https://github.com/kristiker/source1import/blob/6644b3133cc79b3c455cc91ab4259f3f0e27d797/utils/shared/modeldoc.py#L61-L88).
## Credits
Valve Corporation® for making KeyValues3.
[ValveResourceFormat](https://github.com/ValveResourceFormat/ValveResourceFormat/blob/master/ValveResourceFormat/Resource/ResourceTypes/BinaryKV3.cs) for reverse engineering the binary formats.