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

Documentation updates

Browse Source
This commit is contained in:
Chris Bell 2025-10-16 13:33:02 -05:00
parent 78dadfa692
commit 07b1f7e5fd
11 changed files with 1317 additions and 477 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

354
docs/design-doc.md Normal file
View File

@ -0,0 +1,354 @@
# **SessionZero Design Document**
## **1. Introduction**
### **1.1 Purpose**
SessionZero is a free and open-source TTRPG companion app designed to streamline tabletop role-playing game management. It emphasizes flexibility, modularity, and federation through a **system-agnostic datapack format**, supporting both offline and self-hostable online play. The goal is to empower players and GMs with full control over their data, rulesets, and session management.
### **1.2 Scope**
The project will begin as a cross-platform desktop application (Windows and Linux), offering tools for creating and managing TTRPG data such as characters, datasets, templates, and sessions. The backend supports user accounts, a database for shared content (SessionZeroDB), and prepares for future federation capabilities. Phase 2 introduces federation, while Phase 3 focuses on mobile support and plugin extensibility.
### **1.3 Objectives**
* Provide a modular, open-source companion app for any TTRPG system.
* Implement a JSON-based datapack format for extensible content storage.
* Support both local use and self-hostable online instances.
* Create a foundation for future federation and mobile support.
## **2. System Overview**
SessionZero consists of three main layers:
1. **Frontend (Client):** Cross-platform desktop application (.NET Avalonia).
2. **Backend (Server):** ASP.NET backend managing user accounts, SessionZeroDB, and P2P connections.
3. **Datapack System:** A structured archive format for storing and sharing game data.
## **3. Technology Stack**
* **Core:** C# / .NET 9.0 (minimal API)
* **Client:** Avalonia UI (cross-platform desktop)
* **Database:** PostgreSQL (primary data store for shared/online content)
* **Offline/Local:** Local file storage, perhaps SQLite for local instances.
* **Networking:** WebSockets for real-time session updates; SignalR/gRPC considered for P2P/federation.
## **4. Core Data Concepts**
### **4.1 Datapack**
The top-level container (.szp file), bundling all system-specific data (templates, datasets, assets).
### **4.2 Template**
A reusable definition of a data structure (e.g., a **Character Template** defining character sheet fields, or a **Session Template** defining campaign structure).
### **4.3 Dataset**
A structured collection of external data records (e.g., a bestiary, a list of items, or spells).
### **4.4 Instance**
The runtime data created from a Template (e.g., "Aelric's Character Sheet" based on the "Fantasy Character" Template).
### **4.5 Schema**
Formal JSON Schemas used to validate the structure of Datapacks and their contents.
## **5. Datapack Specification**
A datapack is a self-contained archive (.szp) that holds all data and assets for a specific TTRPG system, module, or expansion. It serves as the foundation for SessionZero's extensible content model. Each pack can define **datasets**, **templates**, and optionally contain instance data (though instances are usually stored separately as save files). The structure emphasizes modularity, portability, and reliable dependency management between packs.
### **5.1 Directory Structure**
```text
pack-name/
├── szpack.json # Pack metadata and manifest
├── media/
│ └── images/ # Image assets (referenced by objects)
└── objects/
├── datasets/ # User-defined structured data (e.g. items, NPCs)
├── character-templates/ # Templates defining character structures
└── session-templates/ # Templates defining session/campaign structures
```
### **5.2 Pack Metadata (szpack.json)**
Each datapack contains a root metadata file that defines its identity, authorship, dependencies, and compatibility information. This structure aligns with the C# Datapack and DatapackDependency models.
```json
{
"id": "c9a3f9c8-8b8a-4f1f-9f3b-2d8c7f2c6c62",
"name": "Example Pack",
"version": "1.0.0",
"author": "UserName",
"license": "CC-BY-SA-4.0",
"description": "A fantasy setting datapack containing items and NPCs.",
"createdAt": "2025-10-15T00:00:00Z",
"sessionZeroVersion": "1.0.0",
"dependencies": [
{
"id": "c2e6d0a4-2a8f-4a51-b36e-9f8f2c7b1d11",
"name": "Core-Ruleset",
"version": "1.2.0"
}
]
}
```
### **5.3 Common Object Metadata**
Objects within the datapack (datasets, templates) inherit from **SzObject**. The **szType** field is required to identify the object type. **Image paths are relative to the media/images folder.**
```json
{
"id": "core-items",
"name": "Core Items",
"szType": "dataset",
"description": "A collection of basic weapons and armor.",
"icon": "core-items.png",
"version": "1.0.0",
"schemaVersion": "1.0.0"
}
```
*Note: The system resolves the icon field path (e.g., "core-items.png") to datapack/media/images/core-items.png.*
### **5.4 Dataset Objects**
Datasets are structured collections of data entries. The entry structure includes TopLevelFields and optional Groups of fields, aligning with the DatasetEntry C# model.
```json
{
"id": "core-items",
"szType": "dataset",
"datasetType": "items",
"name": "Core Items",
"description": "Weapons, armor, and consumables for the base ruleset.",
"version": "1.0.0",
"schemaVersion": "1.0.0",
"entries": {
"sword": {
"id": "sword",
"name": "Sword",
"description": "A basic weapon.",
"icon": "weapons/sword.png",
"topLevelFields": {
"damage": { "type": "Number", "value": 10 },
"weight": { "type": "Number", "value": 3 }
},
"groups": [
{
"id": "stats",
"name": "Stats",
"fields": {
"rarity": { "type": "Text", "value": "Common" }
}
}
]
},
"potion": {
"id": "potion",
"name": "Healing Potion",
"description": "Restores a small amount of HP.",
"icon": "consumables/potion.png",
"topLevelFields": {
"healAmount": { "type": "Number", "value": 20 },
"consumable": { "type": "Boolean", "value": true }
}
}
}
}
```
*Note: The field retrieval path is expected to be EntryName.FieldName or EntryName.GroupName.FieldName, matching the logic in Dataset.cs.*
### **5.5 Character Templates**
Character templates define the fields and structure for characters. Note the use of the specific **DatasetLink** object for list fields, requiring a Datapack ID, Dataset ID, and Version.
```json
{
"id": "default-character",
"szType": "character-template",
"name": "Generic Character",
"description": "A base character layout usable across multiple systems.",
"icon": "character.png",
"version": "1.0.0",
"schemaVersion": "1.0.0",
"sections": [
{
"id": "core",
"name": "Core Stats",
"groups": [
{
"id": "attributes",
"name": "Attributes",
"fields": [
{ "id": "strength", "name": "Strength", "type": "Number", "defaultValue": 10 },
{ "id": "dexterity", "name": "Dexterity", "type": "Number", "defaultValue": 10 },
{ "id": "intelligence", "name": "Intelligence", "type": "Number", "defaultValue": 10 }
]
},
{
"id": "inventory",
"name": "Inventory",
"fields": [
{
"id": "equipment",
"name": "Equipment",
"type": "List",
"datasetLink": {
"datapackId": "c9a3f9c8-8b8a-4f1f-9f3b-2d8c7f2c6c62",
"datasetId": "core-items",
"version": "1.0.0"
}
}
]
}
]
}
]
}
```
### **5.6 Session Templates**
Session templates are blueprints for setting up a campaign. This example uses **CharacterTemplateLink** and a list of **DatasetLink** objects for **RequiredDatasets** as defined in SessionTemplate.cs.
```json
{
"id": "basic-session",
"szType": "session-template",
"name": "Basic Fantasy Campaign",
"description": "A classic campaign setup with standard fantasy rules.",
"icon": "session.png",
"version": "1.0.0",
"schemaVersion": "1.0.0",
"characterTemplateLink": {
"datapackId": "c9a3f9c8-8b8a-4f1f-9f3b-2d8c7f2c6c62",
"templateId": "default-character",
"version": "1.0.0"
},
"requiredDatasets": [
{
"datapackId": "c9a3f9c8-8b8a-4f1f-9f3b-2d8c7f2c6c62",
"datasetId": "core-items",
"version": "1.0.0"
}
],
"sections": [
{
"id": "session-info",
"name": "Session Info",
"groups": [
{
"id": "details",
"name": "Details",
"fields": [
{ "id": "setting", "name": "Setting", "type": "Text", "defaultValue": "Thalindra" },
{ "id": "gmNotes", "name": "GM Notes", "type": "MultiText" }
]
}
]
}
]
}
```
### **5.7 Instances (Stored Separately)**
Instances, such as a specific character or a running campaign's state, are typically stored outside of the core, reusable datapacks but follow a similar structure, referencing a template.
```json
{
"szType": "character-instance",
"templateId": "default-character",
"name": "Aelric Stormhand",
"fields": {
"strength": 14,
"dexterity": 11,
"inventory": ["sword", "potion"]
}
}
```
### **5.8 Validation and Schema Versioning**
Formal, versioned JSON Schemas define the structure of szpack.json and core object types.
* Each object declares a **schemaVersion** (global versioning per SessionZero release).
* Validation tools confirm compliance before import/export.
* Internal references (DatasetLink, CharacterTemplateLink, etc.) are resolved within the pack automatically.
* External references are verified via dependencies in szpack.json.
**Session Datapack vs Templates:**
* **Session Template:** A reusable blueprint for campaign/session setup. Lives under objects/session-templates/.
* **Session Datapack:** The persisted, evolving state of an ongoing campaign. It is stored as a special pack and does not appear alongside normal content packs in the UI. Snapshots are versioned with timestamps. Export/import uses the same .szp format with a distinct type flag in szpack.json.
## **6. Networking & Synchronization**
### **6.1 Session Model**
A "Session" is a single game instance, hosted by a GM. It uses a centralized, shared document model (SessionZeroDB/PostgreSQL) with real-time updates pushed via WebSockets.
### **6.2 Data Flow**
1. **GM Action:** GM updates an NPC in their local client.
2. **Client:** Pushes the update to the server via API/WebSockets.
3. **Server:** Validates, commits to DB, and broadcasts the change to all connected players (including the GM).
4. **Players:** Receive the update and apply it to their local model.
### **6.3 Offline Mode**
The application supports full offline functionality, using local storage. When connectivity is restored, the system uses conflict-resolution logic (timestamp-based or operational transformation) to reconcile changes with the SessionZeroDB.
## **7. Federation**
### **7.1 Concept**
Federation allows different SessionZero instances (e.g., self-hosted servers) to share and discover content (Datapacks, public Datasets, Templates). This requires standardized APIs for content retrieval and identity verification.
### **7.2 Identity**
* Users have a unique global identifier (UID).
* Datapacks are identified by their UUID (id).
### **7.3 Data Sharing**
Publicly shared Datapacks are discoverable through a federation layer, allowing users to import content from other trusted servers.
## **8. Licensing**
### **8.1 Source Code License**
* **AGPL-3.0 (Affero General Public License):** Ensures open-source continuity and attribution, prevents uncredited commercial rebranding.
### **8.2 User Content License**
* **Creative Commons BY-SA 4.0:** Allows sharing and adaptation with attribution.
## **9. Development Phases**
### **Phase 1: Core Platform (MVP)**
* Client (UI, datapack editing, session management)
* Backend (accounts, SessionZeroDB, P2P prep)
* JSON datapack format implementation
### **Phase 2: Federation**
* Cross-server communication
* Access controls and search indexing
### **Phase 3: Mobile and Plugins**
* Cross-platform mobile apps
* Plugin and API extensibility
## **10. Testing & Quality**
* **Unit Tests:** Core services (DataPackService, StorageService, NetworkingService) with fixtures for characters/datasets/templates.
* **Schema Validation:** CI job validates sample packs against JSON Schemas (see section 5.8) and rejects PRs with invalid packs.
* **Integration Tests:** Import/export round-trips, dependency resolution, and session snapshot/recovery.
* **Compatibility Matrix:** Validate on Windows and Linux for net9.0; browser target smoke tests where applicable.
## **11. Accessibility & Internationalization**
* **Accessibility:** Keyboard navigation across all primary views, sufficient color contrast, focus indicators, and screen-reader-friendly labels.
* **Internationalization:** Resource-based localization for UI strings; UTF-8 throughout; prepare for RTL support; date/number formatting via invariant + locale-aware overlays.

661
license.txt Normal file
View File

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<http://www.gnu.org/licenses/>.

484
readme.md
View File

@ -1,76 +1,53 @@
# SessionZero Design Document
# SessionZero
## 1. Introduction
A free and open‑source, system‑agnostic TTRPG companion app. SessionZero helps you create, manage, and share tabletop content using an extensible JSON datapack format. It supports fully offline use, and is designed to be self‑hostable with future federation capabilities.
### 1.1 Purpose
SessionZero is a free and open-source TTRPG companion app designed to streamline tabletop role-playing game management. It emphasizes flexibility, modularity, and federation through a **system-agnostic datapack format**, supporting both offline and self-hostable online play. The goal is to empower players and GMs with full control over their data, rulesets, and session management.
## At a glance
- Cross‑platform desktop client (Avalonia, .NET 9)
- Lightweight ASP.NET server for shared play and sync
- JSON datapacks for datasets, character templates, and session templates
- Offline‑first; self‑hostable; roadmap includes federation and mobile
### 1.2 Scope
For a deep dive into goals, architecture, and data formats, see docs/design-doc.md.
The project will begin as a cross-platform desktop application (Windows and Linux), offering tools for creating and managing TTRPG data such as characters, datasets, templates, and sessions. The backend supports user accounts, a database for shared content (SessionZeroDB), and prepares for future federation capabilities. Phase 2 introduces federation, while Phase 3 focuses on mobile support and plugin extensibility.
### 1.3 Objectives
## Repository layout
- SessionZero.sln – Solution file
- docs/
- design-doc.md – Full design overview and datapack specification
- rambling.md – Notes and ideas
- src/
- SessionZero.Client/ – Avalonia desktop application
- SessionZero.Server/ – ASP.NET Core server (minimal API)
- SessionZero.Shared/ – Shared models and schema abstractions used by both client and server
- samples/ – Placeholder for sample datapacks (.szp) and source folders
- tools/ – Project tooling stubs
- license.txt – AGPL‑3.0 license text
* Provide a modular, open-source companion app for any TTRPG system.
* Implement a JSON-based datapack format for extensible content storage.
* Support both local use and self-hostable online instances.
* Create a foundation for future federation and mobile support.
## 2. System Overview
## Technology stack
- Language/Runtime: C# on .NET 9.0
- UI: Avalonia (cross‑platform desktop)
- Web/Server: ASP.NET Core minimal API, WebSockets planned for real‑time
- Data: JSON datapacks for content; PostgreSQL planned for shared online content
SessionZero consists of three main layers:
1. **Frontend (Client):** Cross-platform desktop application (.NET Avalonia).
2. **Backend (Server):** ASP.NET backend managing user accounts, SessionZeroDB, and P2P connections.
3. **Datapack System:** A structured archive format for storing and sharing game data.
## Core concepts (from the design)
- Datapack: Top‑level container (.szp) bundling datasets, templates, and media
- Dataset: Structured records (e.g., items, NPCs). See src/SessionZero.Shared/Models/Dataset.cs
- Template: Reusable structures for characters or sessions
- CharacterTemplate: src/SessionZero.Shared/Models/CharacterTemplate.cs
- SessionTemplate: src/SessionZero.Shared/Models/SessionTemplate.cs
- Schema: Versioned JSON schema ideas captured in docs and src/SessionZero.Shared/Schema/Schema.cs
## 3. Functional Requirements
Read the full specification and examples (including JSON snippets) in docs/design-doc.md, Section 5.
### 3.1 Core Features (Phase 1)
* **User Authentication:** Email and password-based account creation and login.
* **Local Single-User Mode:** Fully functional offline mode without any account. In offline/no-user sessions the local user assumes the GM role by default (GM can also act as a player).
* **Datapack Management:**
* Create, edit, and package datapacks.
* Import/export datapacks.
* Link media assets (e.g., images) within datapacks.
* **Data Creation/Editing:**
* Datasets, characters, character templates, and session templates.
* **Session Management:**
* GM control over player sheets and session datapacks.
* Player view limited to their own characters.
* Integrated chat/log system for simple in-session communication.
* **SessionZeroDB:**
* Database for hosting and retrieving community content.
* Attribution and license information for each uploaded pack.
## Datapack basics
A datapack directory typically looks like this:
### 3.2 Federation (Phase 2)
* Federated servers can communicate for global content discovery.
* Configurable access controls for visibility (private, public, or indexed).
* P2P session management.
### 3.3 Mobile/Plugin System (Phase 3)
* Native mobile clients for Android/iOS.
* Plugin architecture for extending UI and data management capabilities.
## 4. Non-Functional Requirements
* **Cross-Platform Support:** Windows and Linux for MVP.
* **Performance:** Efficient JSON parsing and fast local caching.
* **Scalability:** Designed for multiple users per server instance.
* **Security:** Hashed passwords, secure token authentication.
* **Data Portability:** All user data exportable in open formats.
## 5. Datapack Specification
A datapack is a self-contained archive (.szp) that holds all data and assets for a specific TTRPG system, module, or expansion. It serves as the foundation for SessionZero's extensible content model. Each pack can define **datasets**, **templates**, and optionally contain instance data (though instances are usually stored separately as save files). The structure emphasizes modularity, portability, and reliable dependency management between packs.
### 5.1 Directory Structure
```
```text
pack-name/
├── szpack.json # Pack metadata and manifest
├── media/
@ -81,373 +58,58 @@ pack-name/
└── session-templates/ # Templates defining session/campaign structures
```
### 5.2 Pack Metadata (szpack.json)
Examples of szpack.json, datasets, character templates, and session templates are provided in docs/design-doc.md (sections 5.2–5.7). The shared C# models in src/SessionZero.Shared mirror these structures.
Each datapack contains a root metadata file that defines its identity, authorship, dependencies, and compatibility information.
```json
{
"id": "c9a3f9c8-8b8a-4f1f-9f3b-2d8c7f2c6c62",
"name": "Example Pack",
"version": "1.0.0",
"author": "UserName",
"license": "CC-BY-SA-4.0",
"description": "A fantasy setting datapack containing items and NPCs.",
"created": "2025-10-15T00:00:00Z",
"sessionzeroVersion": "1.0.0",
"dependencies": [
{
"id": "c2e6d0a4-2a8f-4a51-b36e-9f8f2c7b1d11",
"version": ">=0.9 <2.0"
}
]
}
## Getting started
### Prerequisites
- .NET SDK 9.0 or later
- A desktop OS supported by Avalonia (Windows, Linux). Mac may work but is not yet a target.
### Build the solution
From the repository root:
```bash
dotnet build SessionZero.sln
```
**Field notes:**
* **id:** Required. Stable UUID (v4) identifying this pack.
* **version:** Required. Semantic version (MAJOR.MINOR.PATCH). Backwards-incompatible changes increment MAJOR.
* **sessionzeroVersion:** Required. Minimum SessionZero datapack spec supported (semver).
* **dependencies:** Optional. List of pack requirements by id with semver ranges. This supports cases where templates depend on datasets and datasets depend on other datasets. Import/activate must validate that all transitive dependencies are satisfied before enabling content.
### 5.3 Common Object Metadata
Objects within the datapack (datasets, templates) share a common set of identifying metadata.
```json
{
"id": "core-items",
"name": "Core Items",
"type": "dataset",
"description": "A collection of basic weapons and armor.",
"icon": "../media/images/core-items.png",
"version": "1.0.0",
"schemaVersion": "1.0.0"
}
### Run the desktop client
```bash
dotnet run --project src/SessionZero.Client
```
This launches the Avalonia app.
### 5.4 Dataset Objects
Datasets are user-defined structured collections of data (e.g., a list of monsters, items, or spells).
```json
{
"id": "core-items",
"type": "dataset",
"datasetType": "items",
"name": "Core Items",
"description": "Weapons, armor, and consumables for the base ruleset.",
"entries": {
"sword": {
"id": "sword",
"name": "Sword",
"description": "A basic weapon.",
"icon": "../media/images/sword.png",
"fields": {
"damage": { "type": "number", "value": 10 },
"weight": { "type": "number", "value": 3 },
"rarity": { "type": "text", "value": "Common" }
}
},
"potion": {
"id": "potion",
"name": "Healing Potion",
"description": "Restores a small amount of HP.",
"fields": {
"healAmount": { "type": "number", "value": 20 },
"consumable": { "type": "bool", "value": true }
}
}
}
}
### Run the server (optional for local/offline; required for shared play)
```bash
dotnet run --project src/SessionZero.Server
```
The server uses ASP.NET Core default settings and appsettings files under src/SessionZero.Server. Future iterations will add persistence and WebSocket real‑time updates.
### 5.5 Character Templates
Character templates define the structure, fields, and default values for creating player or NPC characters.
## Using datapacks
- Place or import datapacks (.szp) through the client (UI flows under active development).
- For development and testing, keep source folders that match the structure above, then pack/export to .szp.
- Sample content: see samples/ (placeholder today). The design document shows complete JSON examples you can adapt.
```json
{
"id": "default-character",
"type": "character-template",
"name": "Generic Character",
"description": "A base character layout usable across multiple systems.",
"icon": "../media/images/character.png",
"sections": [
{
"id": "core",
"name": "Core Stats",
"groups": [
{
"id": "attributes",
"name": "Attributes",
"fields": [
{ "id": "strength", "name": "Strength", "type": "number", "default": 10 },
{ "id": "dexterity", "name": "Dexterity", "type": "number", "default": 10 },
{ "id": "intelligence", "name": "Intelligence", "type": "number", "default": 10 }
]
},
{
"id": "inventory",
"name": "Inventory",
"fields": [
{
"id": "equipment",
"name": "Equipment",
"type": "list",
"datasetLink": { "datasetType": "items" }
}
]
}
]
}
]
}
```
### 5.6 Session Templates
## Roadmap (high level)
- Phase 1: Core Platform (client UI, server scaffolding, datapack format)
- Phase 2: Federation (cross‑server discovery and sharing)
- Phase 3: Mobile and Plugins (broader platform support and extensibility)
Session templates are blueprints for setting up a campaign, including initial NPCs, rules toggles, and required datasets.
Details for each phase are in docs/design-doc.md, Section 9.
```json
{
"id": "basic-session",
"type": "session-template",
"name": "Basic Fantasy Campaign",
"description": "A classic campaign setup with standard fantasy rules.",
"icon": "../media/images/session.png",
"characterTemplate": "default-character",
"requiredDatasets": ["core-items"],
"sections": [
{
"id": "session-info",
"name": "Session Info",
"groups": [
{
"id": "details",
"name": "Details",
"fields": [
{ "id": "setting", "name": "Setting", "type": "text", "default": "Thalindra" },
{ "id": "gmNotes", "name": "GM Notes", "type": "multi-line-text" }
]
}
]
}
]
}
```
### 5.7 Instances (Stored Separately)
## Contributing
Contributions are welcome! Suggested ways to help:
- Try building/running the client and server; report issues and UX rough edges.
- Create example datapacks that exercise datasets and templates.
- Discuss schemas and validation approaches (see docs/design-doc.md, Section 5.8).
Instances, such as a specific character or a running campaign's state, are typically stored outside of the core, reusable datapacks but follow a similar structure, referencing a template.
Before submitting a PR, please ensure the solution builds with .NET 9.0. Tests and CI will be added as the project matures.
```json
{
"type": "character-instance",
"templateId": "default-character",
"name": "Aelric Stormhand",
"fields": {
"strength": 14,
"dexterity": 11,
"inventory": ["sword", "potion"]
}
}
```
### 5.8 Validation and Schema Versioning
## License
Source code is licensed under the GNU Affero General Public License v3.0 (AGPL‑3.0). See license.txt.
Formal, versioned JSON Schemas define the structure of `szpack.json` and core object types.
* Each object declares a **schemaVersion** (global versioning per SessionZero release).
* Validation tools confirm compliance before import/export.
* Internal references (`datasetLink`, `templateId`, etc.) are resolved within the pack automatically.
* External references are verified via dependencies in `szpack.json`.
**Session Datapack vs Templates:**
* **Session Template:** A reusable blueprint for campaign/session setup. Lives under `objects/session-templates/`.
* **Session Datapack:** The persisted, evolving state of an ongoing campaign. It is stored as a special pack and does not appear alongside normal content packs in the UI. Snapshots are versioned with timestamps. Export/import uses the same `.szp` format with a distinct type flag in `szpack.json`.
## 6. Architecture
### 6.1 High-Level Overview
SessionZero is split into three cooperating layers:
* **Client (Avalonia / .NET 9):** The primary desktop application used by players and GMs. It is responsible for local data storage, datapack management, UI rendering, and establishing/maintaining real-time session connections. The client is offline-first and can run entirely without a backend.
* **Backend (ASP.NET Core Web API):** An optional, self-hostable server that provides account management, persistent session storage, the SessionZeroDB (index of community datapacks), and signaling for P2P connections (WebRTC). Servers may be run privately or publicly and can optionally federate with other servers.
* **Federation Layer / SessionZeroDB:** A network of self-hosted servers that optionally synchronize metadata (datapack manifests, public session listings, user profiles) between instances. Federation is opt-in per server and respects server-configured visibility and access controls.
### 6.2 Client Architecture (Avalonia)
**Key responsibilities:**
* Local datastore and caching (SQLite for structured local data, filesystem for datapacks and media).
* Datapack Manager: discovery, validation, import/export (.szp), and in-memory registry of loaded objects.
* UI layer (MVVM pattern) using Avalonia controls and styles.
* Networking components:
* SignalR client for communicating with an ASP.NET backend.
* WebRTC peer connection subsystem for direct P2P session data transfer (signaling via backend when needed).
* Tools integration: a CLI helper (`szpack`) for building/extracting packs and optional pack signing/verification.
**Runtime layout:**
* **ViewModels:** Represent datapacks, objects, sessions, and user state.
* **Services:** DataPackService, StorageService (SQLite/File), NetworkingService (SignalR/WebRTC), AuthService, LoggingService.
### 6.3 Backend Architecture (ASP.NET Core)
**Key responsibilities:**
* User account management (email/password auth, JWT tokens).
* Session hosting and persistence (store session metadata and optional session snapshots in PostgreSQL).
* SessionZeroDB: index and serve community datapacks and metadata; host uploaded `.szp` files on disk or object storage.
* Signaling service for WebRTC: setup offers/answers and ICE candidate exchange to enable P2P connections between clients.
* Federation endpoints for inter-server communication (signed JSON over HTTPS).
**Components:**
* **REST API controllers:** Accounts, Sessions, Datapacks, Federation, Admin
* **SignalR Hubs:** Real-time session coordination and lightweight session synchronization for clients that prefer server-mediated sync.
* **Storage:** PostgreSQL for server metadata and user accounts; filesystem/object storage for datapack blobs; optional S3-compatible storage for large deployments.
* **Auth & Security:** Password hashing (Argon2), JWT issuance and refresh, TLS for all endpoints, RBAC for admin operations.
### 6.4 Networking Model
* **Offline Mode:** Client runs entirely locally; datapacks and session files live on the local filesystem / SQLite; no networking required.
* **LAN / P2P Mode:** Clients can host sessions on a LAN. Discovery via mDNS/Zeroconf or optional UDP broadcast. For internet play, the backend's signaling service facilitates NAT traversal and WebRTC handshake. Actual session traffic (character updates, chat) is sent peer-to-peer where possible to minimize server load.
* **Server-Hosted Mode:** For users who run or subscribe to an ASP.NET instance, sessions may be persisted on the server and clients can reconnect to continue campaigns. The server can optionally mediate real-time traffic for clients that cannot form direct P2P connections.
* **Federation:** Servers exchange signed metadata (pack manifests, publicly shared pack indexes, optionally session discovery) on a scheduled or event-driven basis. Federation rules and visibility are configured by each server operator.
### 6.5 Data Flow Examples
**Importing a Datapack (Client-only):**
1. User selects `Import pack.szp`.
2. Client extracts the archive into the local datapacks directory.
3. DataPackService validates `szpack.json` and object schemas and registers objects into the in-memory registry.
4. The UI updates to show new templates and datasets.
**Joining a Hosted Session (Server + P2P):**
1. Client authenticates to ASP.NET server via email/password, obtains JWT.
2. Client requests to join a session; server verifies permissions and returns session metadata and peer list.
3. Server provides WebRTC signaling data (or the client uses STUN/TURN if needed).
4. Clients establish P2P channels and synchronize session state. Server stores session snapshots as needed.
### 6.6 Extensibility & Plugins
* Design client services around interfaces to permit replacement or extension (e.g., IDataPackStore, INetworkingTransport).
* Plugin API (Phase 3) will allow third-party modules to register new object types, UI panels, and data transformations while running within a sandboxed environment.
### 6.7 Deployment & Operations
* **Client:** Distributed via platform-native packaging (AppImage/Flatpak for Linux, MSI for Windows). Continuous builds via GitHub Actions.
* **Server:** Dockerized ASP.NET image with environment-driven configuration. Use PostgreSQL as the recommended production datastore and SQLite for small personal deployments.
* **SessionZeroDB:** Each server can host its own repository; the official public index is recommended to be a well-maintained instance but is optional.
### 6.8 Session Model (Roles, Persistence, Snapshots)
* **Roles & Permissions:** GM has write access to all session state; players can write to their own characters and any GM-granted scopes. Read access is constrained by GM settings (e.g., fog-of-war). Enforcement occurs client-side and, when connected, server-side or by the GM-authoritative peer in P2P mode.
* **Offline/Single-User Sessions:** Operate with an implicit GM role. All features available without authentication.
* **Persistence:** Ongoing campaigns are stored as Session Datapacks (see section 5.8). The backend can keep periodic snapshots (e.g., every N minutes or on significant events) to support recovery and reconnection.
### 6.9 Real-Time Sync Protocol (App-Level)
* **Transport:** WebRTC DataChannel preferred; SignalR/WebSockets as fallback/mediated mode.
* **Envelope:** `{ type, version, correlationId?, timestamp, payload }` with monotonically increasing client logical clocks per entity.
* **Message Types:** `character.update`, `sheet.patch` (JSON Patch/merge), `chat.post`, `gm.command`, `session.snapshot`, `presence.update`.
* **Ordering & Causality:** Per-entity version vectors or lamport clocks to resolve last-write-wins where appropriate; GM-authoritative resolution for contested fields. Idempotent operations required.
* **Offline Reconciliation:** Queue operations locally; on reconnect, diff against latest snapshot and apply conflict rules (prefer GM-authoritative state; surface conflicts to GM UI when ambiguous).
* **Versioning:** Bump minor for additive messages; major for breaking changes. Clients include supported ranges in handshake.
### 6.10 Security & Privacy
* **Account lifecycle:** Email verification, password reset via signed time-limited tokens, optional 2FA in future.
* **Rate limiting:** Per-IP and per-account limits on auth, uploads, federation pulls.
* **Audit logging:** Admin-scope access to server logs of sensitive actions (logins, uploads, deletions).
* **Secret management:** Environment variables or vault-backed configuration; never commit secrets.
* **Data protection:** TLS everywhere, Argon2 password hashing, JWT with refresh tokens and short-lived access tokens.
### 6.11 Federation Protocol (Minimal Spec)
* **Trust Model:** Each server has a long-lived signing key (ed25519) and publishes its public key and metadata at `/.well-known/sessionzero`.
* **Request Signing:** All federation HTTP requests include a detached signature header over method, path, timestamp, and body hash. Replay protection via timestamp and nonce cache.
* **Endpoints:**
* `GET /federation/packs?page=...` for manifest pagination
* `GET /federation/packs/{id}` for pack manifest
* `GET /federation/nodes` for discovery
* **Backoff & Pagination:** Link-based pagination; clients respect `Retry-After` and exponential backoff on 429/5xx.
* **Visibility:** Servers may export only public/indexable packs; private items never federate.
## 7. UI/UX Design
### 7.1 Philosophy
* Desktop-first layout with responsive adjustments.
* Blend of creative and functional design to support immersive TTRPG use.
### 7.2 Core Views
* Dashboard
* Datapack Manager
* Data Editor (characters, templates, datasets)
* Session View (GM & Player modes)
* Chat/Log interface
### 7.3 Navigation & Key Workflows (MVP)
**Navigation Map:** Dashboard → (Datapack Manager | Data Editor | Sessions)
**Key Flows:**
* **Build Datapack:** New Pack → Add Datasets/Templates → Validate (schema) → Export .szp
* **Start Offline Session:** Create from Session Template → Play (implicit GM) → Auto-snapshot locally
* **Join Hosted Session:** Auth → Select Session → Handshake (SignalR/WebRTC) → Sync state
* **Import Pack:** File → Import .szp → Validate (schemas + dependencies) → Activate
## 8. Licensing
### 8.1 Software License
* **GNU Affero General Public License (AGPL-3.0):** Ensures open-source continuity and attribution, prevents uncredited commercial rebranding.
### 8.2 User Content License
* **Creative Commons BY-SA 4.0:** Allows sharing and adaptation with attribution.
## 9. Development Phases
### Phase 1: Core Platform (MVP)
* Client (UI, datapack editing, session management)
* Backend (accounts, SessionZeroDB, P2P prep)
* JSON datapack format implementation
### Phase 2: Federation
* Cross-server communication
* Access controls and search indexing
### Phase 3: Mobile and Plugins
* Cross-platform mobile apps
* Plugin and API extensibility
## 10. Testing & Quality
* **Unit Tests:** Core services (DataPackService, StorageService, NetworkingService) with fixtures for characters/datasets/templates.
* **Schema Validation:** CI job validates sample packs against JSON Schemas (see section 5.8) and rejects PRs with invalid packs.
* **Integration Tests:** Import/export round-trips, dependency resolution, and session snapshot/recovery.
* **Compatibility Matrix:** Validate on Windows and Linux for net9.0; browser target smoke tests where applicable.
## 11. Accessibility & Internationalization
* **Accessibility:** Keyboard navigation across all primary views, sufficient color contrast, focus indicators, and screen-reader-friendly labels.
* **Internationalization:** Resource-based localization for UI strings; UTF-8 throughout; prepare for RTL support; date/number formatting via invariant + locale-aware overlays.
User‑generated content is intended to be shareable under Creative Commons BY‑SA 4.0; see docs/design-doc.md, Section 8.2, for the rationale.

6
src/SessionZero.Shared/Models/CharacterTemplate.cs Normal file
View File

@ -0,0 +1,6 @@
namespace SessionZero.Shared.Models;
public class CharacterTemplate : TemplateBase
{
}

6
src/SessionZero.Shared/Models/CharaterTemplate.cs
View File

@ -1,6 +0,0 @@
namespace SessionZero.Shared.Models;
public class CharaterTemplate
{
}

10
src/SessionZero.Shared/Models/Datapack.cs
View File

@ -1,5 +1,8 @@
namespace SessionZero.Shared.Models;
/// <summary>
/// The model for a datapack (used for the szpack.json file).
/// </summary>
public class Datapack
{
public required Guid Id { get; set; }
@ -11,10 +14,13 @@ public class Datapack
public required DateTime CreatedAt { get; set; }
public required string SessionZeroVersion { get; set; }
public List<Dependency> Dependencies { get; set; } = new();
public List<DatapackDependency> Dependencies { get; set; } = new();
}
public class Dependency
/// <summary>
/// Represents a dependency of a datapack.
/// </summary>
public class DatapackDependency
{
public required Guid Id { get; set; }
public required string Name { get; set; }

81
src/SessionZero.Shared/Models/Dataset.cs
View File

@ -1,17 +1,80 @@
using SessionZero.Shared.Schema;
namespace SessionZero.Shared.Models;
public class Dataset : SzObject
{
/// <summary>
/// Arbitrary string used to identify the dataset type (e.g. "items", "quests", "npcs", etc.).
/// </summary>
public required string DatasetType { get; set; }
/// <summary>
/// The entries in the dataset.
/// </summary>
public required Dictionary<string, DatasetEntry> Entries { get; set; } = new();
/// <summary>
/// Retrieves a FieldValue from the dataset using a dot-separated path.
/// Format: [EntryName].[FieldName] or [EntryName].[GroupName].[FieldName]
/// </summary>
/// <param name="fieldName">The dot-separated path to the field.</param>
/// <returns>The FieldValue if found, otherwise null.</returns>
public FieldValue? GetField(string fieldName)
{
var split = fieldName.Split('.');
// Path must contain at least EntryName.FieldName (length 2)
if (split.Length < 2 || split.Length > 3)
{
return null;
}
var entryName = split[0];
if (!Entries.TryGetValue(entryName, out var entry))
{
return null;
}
if (split.Length == 2)
{
// Format: EntryName.FieldName (Top-level field)
var fName = split[1];
if (entry.TopLevelFields is null) return null;
return entry.TopLevelFields.TryGetValue(fName, out var value) ? value : null;
}
else
{
// Format: EntryName.GroupName.FieldName
var groupName = split[1];
var fName = split[2];
if (entry.Groups is null) return null;
var dataGroup = entry.Groups.FirstOrDefault(g => g.Name == groupName);
if (dataGroup is null || dataGroup.Fields is null)
{
return null;
}
return dataGroup.Fields.TryGetValue(fName, out var value) ? value : null;
}
}
/// <summary>
/// Sets a FieldValue in the dataset using a dot-separated path.
/// Format: [EntryName].[FieldName] or [EntryName].[GroupName].[FieldName]
/// </summary>
/// <param name="fieldName">The dot-separated path to the field.</param>
/// <param name="value">The value to set.</param>
/// <returns>True if the value was set, false otherwise</returns>
public static bool SetField(string fieldName, FieldValue value)
{
// TODO: Implementation for SetField
return false;
}
}
public class DatasetEntry
{
public required string Id { get; set; }
public required string Name { get; set; }
public string Description { get; set; } = string.Empty;
public string Icon { get; set; } = string.Empty;
}

13
src/SessionZero.Shared/Models/SessionTemplate.cs
View File

@ -1,6 +1,17 @@
using SessionZero.Shared.Schema;
namespace SessionZero.Shared.Models;
public class SessionTemplate
public class SessionTemplate : TemplateBase
{
/// <summary>
/// Reference to the required Character Template for character creation in this session.
/// </summary>
public required CharacterTemplateLink CharacterTemplateLink { get; set; }
/// <summary>
/// List of required Datasets that this session template depends on
/// (datapack ids must be present in the DatapackDependency list in the datapack object)
/// </summary>
public required List<DatasetLink> RequiredDatasets { get; set; } = new();
}

48
src/SessionZero.Shared/Models/SzObject.cs
View File

@ -9,52 +9,4 @@ public class SzObject
public string Icon { get; set; } = string.Empty;
public required string Version { get; set; }
public required string SchemaVersion { get; set; }
}
public class Section
{
public required string Id { get; set; }
public required string Name { get; set; }
public required List<Group> Groups { get; set; } = new();
}
public class Group
{
public required string Id { get; set; }
public required string Name { get; set; }
public required List<FieldDefinition> Fields { get; set; } = new();
}
public class FieldDefinition
{
public required string Id { get; set; }
public required string Name { get; set; }
public required FieldType Type { get; set; }
public object? DefaultValue { get; set; }
public DatasetLink? DatasetLink { get; set; }
}
public class FieldValue
{
public required FieldType Type { get; set; }
public required object Value { get; set; }
}
public class DatasetLink
{
/* TODO:
* This needs to be able to either link a list of specific dataset ids OR
* a list of allowed dataset types that could be any dataset that the pack has listed as a dependency
* (This is used on fields that are of type 'List')
*/
}
public enum FieldType
{
Text,
MultiText,
Number,
Boolean,
Formula,
List
}

11
src/SessionZero.Shared/Models/TemplateBase.cs Normal file
View File

@ -0,0 +1,11 @@
using SessionZero.Shared.Schema;
namespace SessionZero.Shared.Models;
/// <summary>
/// Base class for templates.
/// </summary>
public class TemplateBase : SzObject
{
public required List<TemplateSection> Sections { get; set; } = new();
}

120
src/SessionZero.Shared/Schema/Schema.cs Normal file
View File

@ -0,0 +1,120 @@
namespace SessionZero.Shared.Schema;
/// <summary>
/// Valid types for fields.
/// </summary>
public enum FieldType
{
Text,
MultiText,
Number,
Boolean,
Formula,
List
}
/// <summary>
/// Represents a list of allowed values for a field with type List.
/// </summary>
public class SzListType
{
// NOTE: Only one of these lists should be allowed
public List<string>? AllowedDatasetTypes { get; set; }
public List<DatasetLink>? AllowedDatasetIds { get; set; }
public string? CustomValues { get; set; }
}
/// <summary>
/// Represents a formula field.
/// </summary>
public class SzFormulaType
{
// TODO: Implement a way to parse formulas
public string? Formula { get; set; }
}
/// <summary>
/// Used to link a dataset in other data or template objects.
/// </summary>
public class DatasetLink
{
public required Guid DatapackId { get; set; }
public required string DatasetId { get; set; }
public required string Version { get; set; }
}
/// <summary>
/// Used to link a character template in other template objects.
/// </summary>
public class CharacterTemplateLink
{
public required Guid DatapackId { get; set; }
public required string TemplateId { get; set; }
public required string Version { get; set; }
}
/// <summary>
/// Represents a field value.
/// </summary>
public class FieldValue
{
public required FieldType Type { get; set; }
public required object Value { get; set; }
}
/// <summary>
/// Represents a group of fields in a dataset.
/// </summary>
public class DataGroup
{
public required string Id { get; set; }
public required string Name { get; set; }
public required Dictionary<string, FieldValue> Fields { get; set; } = new();
}
/// <summary>
/// Represents a dataset entry used in datasets.
/// </summary>
public class DatasetEntry
{
public required string Id { get; set; }
public required string Name { get; set; }
public string Description { get; set; } = string.Empty;
public string Icon { get; set; } = string.Empty;
public Dictionary<string, FieldValue>? TopLevelFields { get; set; } = new();
public List<DataGroup>? Groups { get; set; } = new();
}
/// <summary>
/// Represents a section in a template that houses multiple groups.
/// </summary>
public class TemplateSection
{
public required string Id { get; set; }
public required string Name { get; set; }
public required List<TemplateGroup> Groups { get; set; } = new();
}
/// <summary>
/// Represents a group of fields in a template.
/// </summary>
public class TemplateGroup
{
public required string Id { get; set; }
public required string Name { get; set; }
public required List<TemplateFieldDefinition>? Fields { get; set; } = new();
}
/// <summary>
/// Represents a field definition in a template
/// (Does not hold actual field values as templates are meant to be filled in upon instance creation).
/// </summary>
public class TemplateFieldDefinition
{
public required string Id { get; set; }
public required string Name { get; set; }
public required FieldType Type { get; set; }
public object? DefaultValue { get; set; }
public DatasetLink? DatasetLink { get; set; }
}