BSData / BSData/phalanx

Data and editor behavior specification

Open
#7 6 comments 0 reactions 3 assignees Claimed by @AlexMorman View on GitHub
Dominant language
C#
Stars
152
Forks
24
PR merge metrics
No merged PRs in 30d

Description

The general objective is to create a dataset (gamesystem + catalogues + rosters) that has a very strictly defined desired behavior (mostly in terms of roster editor behavior). Those expectations (desired behaviors) should be described as well.

I'd imagine it working like that:
A "scenario package" consists of a game system, a catalogue, a roster and a scenario (free-form/markdown). The scenario describes steps taken in a roster editor and expected changes/behavior (e.g. warnings, options being hidden) to be observed. The package could also include reference rosters that a user should get following the scenario steps.

The dataset (game system and catalogues) could be shared across all scenarios and include all necessary permutations of data to be checked in scenarios.

It's essentially a spec for BattleScribe as is, and we will be able to further enhance it in future as we make changes, making sure to keep a back-compat should we desire to do so.

It's a giant project overall (the spec, in full), but I think starting with a basic "sample dataset" should be quite straightforward.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.