Bellsworne/SessionZero-Client
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Working on data and sztl

Browse Source
This commit is contained in:
Chris Bell
2025-11-30 19:32:36 -06:00
parent b1a43d038e
commit 27d3f0b452
16 changed files with 157 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
SessionZero/Data/Datapack.cs
View File

@@ -1,8 +0,0 @@
namespace SessionZero.Data;
public class Datapack
{
public required DatapackMetadata Metadata { get; set; }
}

35
SessionZero/Data/Dataset.cs
View File

@@ -1,35 +0,0 @@
using System.Collections.Generic;
using SessionZero.Data.Sztl;
namespace SessionZero.Data;
public class Dataset
{
public required DatasetMetadata Metadata { get; set; }
public Dictionary<string, SztlField> Fields { get; set; } = [];
public Dictionary<string, SztlFieldGroup> Groups { get; set; } = [];
/// <summary>
/// Returns an SzfField from a string path (use dot notation, eg 'stats.damage')
/// </summary>
/// <param name="fieldPath"></param>
/// <returns></returns>
public SztlField? GetField(string fieldPath)
{
var split = fieldPath.Split('.');
var fieldName = split[0];
if (split.Length == 1)
{
return Fields.GetValueOrDefault(fieldName);
}
else
{
// Todo: Recurse into Groups.Fields to find the path
}
return null;
}
}

6
SessionZero/Data/DatasetObjectTemplate.cs
View File

@@ -1,6 +0,0 @@
namespace SessionZero.Data;
public class DatasetObjectTemplate
{
}

11
SessionZero/Data/SzField.cs Normal file
View File

@@ -0,0 +1,11 @@
using SessionZero.Data.Sztl;
namespace SessionZero.Data;
public class SzField
{
public string Id { get; set; }
public object? Value { get; set; }
public SzFieldType Type { get; set; }
public bool IsTextBlock { get; set; }
}

34
SessionZero/Data/SzObject.cs Normal file
View File

@@ -0,0 +1,34 @@
using System.Collections.Generic;
using SessionZero.Data.Sztl;
namespace SessionZero.Data;
public class SzObject
{
public string Id { get; set; }
public string Uuid { get; set; }
public string TemplateId { get; set; }
public Dictionary<string, SzField> Fields { get; set; } = new();
public Dictionary<string, SzFieldGroup> FieldGroups { get; set; } = new();
public virtual object? GetFieldValue(string fieldPath)
{
throw new System.NotImplementedException();
}
public virtual T GetFieldValue<T>(string fieldPath)
{
throw new System.NotImplementedException();
}
public virtual string GetFieldValueAsString(string fieldPath)
{
throw new System.NotImplementedException();
}
public virtual string SetFieldValue(string fieldPath, object value)
{
throw new System.NotImplementedException();
}
}

14
SessionZero/Data/SzTemplate.cs Normal file
View File

@@ -0,0 +1,14 @@
using System.Collections.Generic;
using SessionZero.Data.Sztl;
namespace SessionZero.Data;
public class SzTemplate
{
public string Id { get; set; }
public string Name { get; set; }
public string DataType { get; set; }
public Dictionary<string, SztlField> Fields { get; set; } = new();
public Dictionary<string, SztlFieldGroup> SubGroups { get; set; } = new();
}

2
SessionZero/Data/DatasetObject.cs → SessionZero/Data/SzoFileHandler.cs
View File

@@ -1,6 +1,6 @@
namespace SessionZero.Data;
public class DatasetObject
public class SzoFileHandler
{
}

10
SessionZero/Data/Sztl/SzFieldGroup.cs Normal file
View File

@@ -0,0 +1,10 @@
using System.Collections.Generic;
namespace SessionZero.Data.Sztl;
public class SzFieldGroup
{
public string Id { get; set; }
public Dictionary<string, SzField> Fields { get; set; } = new();
public Dictionary<string, SzFieldGroup> SubGroups { get; set; } = new();
}

11
SessionZero/Data/Sztl/SzFieldType.cs Normal file
View File

@@ -0,0 +1,11 @@
namespace SessionZero.Data.Sztl;
public enum SzFieldType
{
Text,
Textblock,
Number,
Bool,
Formula,
Object
}

24
SessionZero/Data/Sztl/SztlField.cs
View File

@@ -1,25 +1,11 @@
using System;
namespace SessionZero.Data.Sztl;
public class SztlField
{
public required string Id { get; set; }
public required SztlFieldType FieldType { get; set; }
public object? Value { get; set; } = null;
public bool TrySetValue()
{
throw new NotImplementedException();
}
public T TryGetValue<T>()
{
throw new NotImplementedException();
}
}
public enum SztlFieldType
{
Number, Text, Textbox, Bool, Object, Formula
public required SzFieldType Type { get; set; }
public object? DefaultValue { get; set; }
public string? Description { get; set; }
public bool IsList { get; set; }
public bool IsTextBlock { get; set; }
}

5
SessionZero/Data/Sztl/SztlFieldGroup.cs
View File

@@ -4,6 +4,7 @@ namespace SessionZero.Data.Sztl;
public class SztlFieldGroup
{
public List<SztlField> Fields { get; set; } = [];
public List<SztlFieldGroup> SubGroups { get; set; } = [];
public string Id { get; set; }
public Dictionary<string, SztlField> Fields { get; set; } = new();
public Dictionary<string, SztlFieldGroup> SubGroups { get; set; } = new();
}

6
SessionZero/Data/Sztl/SztlFileHandler.cs Normal file
View File

@@ -0,0 +1,6 @@
namespace SessionZero.Data.Sztl;
public class SztlFileHandler
{
}

6
SessionZero/Data/Sztl/SztlParser.cs Normal file
View File

@@ -0,0 +1,6 @@
namespace SessionZero.Data.Sztl;
public static class SztlParser
{
}

7
SessionZero/Data/Sztl/SztlTemplate.cs
View File

@@ -1,7 +0,0 @@
namespace SessionZero.Data.Sztl;
public class SztlTemplate
{
}

9
SessionZero/Data/Sztl/SztlTokenizer.cs
View File

@@ -1,9 +0,0 @@
namespace SessionZero.Data.Sztl;
public class SztlTokenizer
{
enum TokenType
{
// TODO: Add token types
}
}

111
SessionZero/data.md
View File

@@ -53,41 +53,53 @@ datapack_name/
## DatasetObject Template File
- Metadata fields are denoted with a `!` and are required for this template:
- `data_type` is an arbitrary value used to denote what kind of dataset type the template is for.
- The `uuid` field can be left at 0, but when uploading to the SessionZeroDB a uuid will be assigned.
- The `id` must be unique within the datapack
- `compatible_systems` is arbitrary and only reflects if the template can be used in a datapack according to it's `compatible_systems` value
- Some default fields are required by the default parser:
- `name: text` must be present
- Metadata fields required for data object templates:
- `template_type`: must be `data`.
- `id`: denotes the template's id; must be unique within the datapack.
- `uuid`: can be left at 0, a uuid will be assigned when uploading to the SessionZeroDB.
- `version`: must follow semantic versioning.
- `data_type`: is an arbitrary value used to denote what kind of dataset type the template is for.
- `compatible_systems`: is arbitrary and only reflects if the template can be used in a datapack according to its own `compatible_systems` value.
- `description`
```ini
!id = "core_item"
!uuid = 0
!version = "1.0.0"
!data_type = "item"
!compatible_systems = "sz_core, d20"
!description = """
- Supported Field Types for `data` template types:
- text
- textblock
- bool
- number
```toml
[metadata]
template_type = "data"
id = "core_item"
uuid = 0
version = "1.0.0"
data_type = "item"
compatible_systems = ["sz_core", "d20"]
description = """
Core SessionZero item template
"""
[name]
type = "text"
# Top-level fields
name: text
description: textblock
[description]
type = "textblock"
# Example of a group
stats {
value: number
weight: number
[consumable]
type = "bool"
default_value = false
# Example of a sub-group
modifiers {
# Field with a default value
base: number = 1
}
}
# -- Stats group --
[stats.value]
type = "number"
[stats.weight]
type = "number"
[stats.modifiers.base]
type = "number"
default_value = 1
```
@@ -97,35 +109,24 @@ An instanced DatasetObject should only contain simple fields and values, no obje
```json
{
"id": "some_id",
"uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"id": "some_id",
"uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"template_id": "core_item",
"parent_dataset_id": "core_items",
"compatible_systems": ["sz_core", "d20"],
"fields": {
"name": "Human readable name",
"template_id": "some_template_id",
"parent_dataset_id": "some_dataset_id",
"description": "A description",
"icon": "path/to/icon",
"compatible_systems": ["sz_core", "d20"],
"fields": {
"groups": [
{
"id": "group_name",
"fields": [
{
"id": "field_name",
"type": "number",
"value": 1
}
],
"sub_groups": []
}
],
"top_level_fields": [
{
"id": "name",
"type": "string",
"value": "something"
}
]
"consumable": false,
"stats": {
"value": 10,
"weight": 2,
"modifiers": {
"base": 1
}
}
}
}
```