bsdata / gallery

Gallery to browse all BattleScribe data sources (repositories), track and index them automatically.

gallery

Gallery to browse all BattleScribe data sources (repositories), track and index them automatically.

The gallery can be visually browsed at gallery.bsdata.net.

Usage

BattleScribe

This distribution channel works on BattleScribe for PCs and Android, but not iOS.

To try out this new data distribution system with BattleScribe, you need to copy the following URL:

https://github.com/BSData/gallery/releases/latest/download/bsdata.catpkg-gallery.json

and paste it into an Add repository source field. Depending on your device:

• Desktop

  

• Android

  

Adding new repository

To add a new data repository to this distribution system:

• first, setup your repository as instructed in https://github.com/BSData/catalogue-development/wiki/Help:-Hosting-repositories
• add a new file within registry/entries path: https://github.com/BSData/gallery/tree/master/registry/entries
• open PR

e.g. for a repository like https://github.com/BSData/skw9k create a file skw9k.catpkg.yml with the following content:

location:
  github: BSData/skw9k

gallery's Issues

[Feature]: Add support for 'archived' flag on repository

Support added in BattleScribe v2.03.20

BSData webapp:
BSData/bsdata@8241502#diff-b46cb6b6ad45266685f8cccdba1e6224R957

Add a gzip compressed gallery-catpkg.json.gz alternative asset

File	Size	Ratio
bsdata.catpkg-gallery.json	17.1 KB	1.0
bsdata.catpkg-gallery.json.gz	2.52 KB	0.15

This is a major bandwidth saving (85% less). Of course, we'll always provide original JSON as well.

Add SHA digest to check whether an upload is necessary

Sometimes the generated artifact has the same contents, e.g. when master branch changes but doesn't result in different output.

Chatops - slash command to add repo to registry

e.g.

/add BSData/test

Due to YAML formatting, there's always a second push to index

The issue it in YAML conversion of DateTime(Offset) first being serialized with the Z timezone indication when taken directly from JSON, and then after reading from YAML and resaving it, serialized as timezone offset +0000.

The easiest solution right now would be round-tripping the yaml on save:

• save yaml
• read yaml again and re-save

[Feature]: Raise an issue when a repository with a catpkg release asset no longer has catkpg asset

When a repository had a release catpkg asset available and there's an error now, raise an issue or otherwise alert about the fact.

It's a problem that requires quick action. Something most probably went wrong with publish-catpkg.

Refactor to a powershell module

[Feature]: Add a static website for browsing the registry and index data

GitHub Pages hosted static website that pulls data from gallery-catpkg.json asset? (Can browser download release asset?)

[repo add] StarBreach

would like to add my personal repository for StarBreach in the new gallery so to allow other user to download the data file directly from the app
https://github.com/andreanespeca/StarBreach
would be also great to have some sort of visual interface in the app to make the adding process easier.
Thanks

monitoring org repos doesn't take forks into account

example: #165

we may want to switch to a more performant method as well, because we're often hitting rate limits

Benchmark parallelized requests

Check whether parallelizing request processing for Update Index workflow (asking for new releases) yields any considerable running time improvement.

Adding or updating to have latest version of Horus Heresy

Hi ya. I tried to read what was written here and it was like reading seachart in the middle of a random ocean and with no compass for me (I'm sure people understand it, but not me).
I worked out how to see the BSdata things in app. However it looks like the Horus Heresy data is a couple of months old.

The location is here
https://github.com/BSData/horus-heresy

Current release is
Praetor Tribune Terminator Bodyguard
v14.232

@capitaladot hopefully this works

Feature: scheduled action that checks BSData repos

An action that runs on schedule and checks all repositories of BSData that aren't yet in registry.

If they contain any catalogues, raise an issue/pull request with addition of that repository to the registry.

`archived` flags in `catpkg-gallery` are always false

Remove or archive systems where data is out of date

Someone asked about star wars legion, the data hasn't been updated in 3 years and the game has.
Might be worth taking it down and anything similar where the data is no longer useful.
I'm not talking about things like old editions, but just abandoned (by the data authors) games that are still active.
Mostly the star wars games:
https://github.com/BSData/star-wars-legion
https://github.com/BSData/swxwing
https://github.com/BSData/star-wars-armada -> this one got an update 6 months ago and might actually be up to date.

For legion, people use https://tabletopadmiral.com/
For armada, https://armada.ryankingston.com/
For x-wing, https://yasb.app/

JSON content parity with AppSpot

This is to track progress on being able to redirect traffic from AppSpot to Gallery:

Some repositories aren't included

The following are requirements for a repository to show up in Gallery listing:

• registration in registry folder of this repo
• latest release (not pre-release)
• latest release contains assets produced by BSData/publish-catpkg

BSData repos are automatically registered via "Update registry" workflow if they're tagged with battlescribe-data GitHub topic.

Latest release has to be published by someone.

Release assets on older repositories can be added "manually" via /publish-ext chatops command in BSData/publish-catpkg repo.

There are repositories that don't meet all requirements because either:

• they don't have latest release
• they don't have battlescribe-data tag

Timestamps don't show up in BattleScribe

The issue is here: BattleScribe/Release#148

We may want to workaround this because of BS slow update schedule.

Webpage to check repository "readiness" for inclusion in gallery

A form on gallery website to put repository url into and check "readiness":

1. Are there any game systems and catalogues
2. Are datafiles in non-zipped format (cat/gst)
3. Is there a catpkg workflow
4. Is there a release with a catpkg

Provide instructions how to add one's repository to the gallery.