Cataclysm: BN data

Game data from Cataclysm: Bright Nights updated every 12 hours and deployed at data.cataclysmbn-guide.com. Built for ushkinaz/cbn-guide

Usage

Get available versions

curl -s https://data.cataclysmbn-guide.com/builds.json

Get game data

curl -s https://data.cataclysmbn-guide.com/data/2026-01-10/all.json

curl -s https://data.cataclysmbn-guide.com/data/2026-01-10/all_mods.json

Structure:

{
  "build_number": "2026-01-10",
  "release": {},
  "data": [],
  "mods": {}
}

Get translations

curl -s https://data.cataclysmbn-guide.com/data/2026-01-10/lang/fr.json

curl -s https://data.cataclysmbn-guide.com/data/2026-01-10/lang/zh_CN_pinyin.json

Format: Jed-compatible, produced with po2json.

Get tileset graphics

curl -s https://data.cataclysmbn-guide.com/data/2026-01-10/gfx/UltimateCataclysm/...

All graphics are WebP format. Original PNGs converted during build.

Performance

All JSON files are stored in the repository as precompressed Brotli streams, but retain the standard .json extension. Cloudflare Pages is configured to serve these files with Content-Encoding: br.

While Cloudflare can compress responses on the fly, it typically uses Brotli quality 4 for performance. Precompressing at quality 11 yields significantly smaller files.

All graphics are converted to WebP format during the build. We use cwebp -preset icon, capturing massive savings without quality loss.

JSON Compression Comparison:

Method	Size	Ratio	Notes
Uncompressed	18.9 MB	100%	Raw JSON size
Gzip	2.8 MB	15%	Standard compression
Brotli (Q4)	2.6 MB	14%	Cloudflare on-the-fly default
Brotli (Q11)	2.0 MB	10%	Stored in repository

GFX Compression Comparison:

Format	Size	Ratio	Notes
PNG	17.8 MB	100%	Original tileset size
WebP	5.8 MB	33%	Stored in repository

Total Network Savings

Comparing the baseline (Gzip JSON + PNG) against the current optimized stack (Brotli Q11 + WebP):

Stack	all.json	Tileset	Total
Baseline	2.8 MB	17.8 MB	20.6 MB
Optimized	2.0 MB	5.8 MB	7.8 MB

Total Reduction: ~62% smaller payloads.

• Note: Raw JSON and PNGs are not stored or served; clients must support Brotli and WebP.

Repository Structure

• action branch: CI workflows and scripts
• main branch: Published data (deployed)

Local Development

# Clone action branch only
git clone --single-branch https://github.com/ushkinaz/cbn-data

# Install dependencies
yarn install --frozen-lockfile --ignore-engines

# Run data pull (dry-run by default)
node pull-data-launcher.js

# Run with actual writes
GITHUB_TOKEN=xxx node pull-data-launcher.js

Data Pipeline

flowchart TD
    Schedule([Every 12 Hours]) --> Pull["**Pull Game Data**<br/>JSON + Trans + GFX"]
    Pull --> Convert["**Convert GFX to WebP**<br/>_cwebp -preset icon_"]
    Convert --> Compress["**Precompress JSON**<br/>_brotli --best_"]
    Compress --> Commit["**Commit**<br/>atomic"]
    Commit --> Push[**Push**<br/>Clean history]
    Push --> Deploy["**Deploy**<br/>CloudFlare Pages"]

Loading

Data Pruning

flowchart TD
    Start([Monthly]) --> Policy
    Policy[**Apply Retention Policy**<br/>stable + <30d + thinned] --> Delete
    Delete[**Delete Old Builds**<br/>>450d & excess] --> Update
    Update[**Update builds.json**<br/>Kept list] --> Backup
    Backup[**Backup**<br/>preserve in a branch] --> Squash
    Squash[**Squash**<br/>1 commit total] --> Push
    Push[**Push**<br/>Clean history]

Loading

Data Retention Rules

Monthly pruning keeps:

• All stable releases
• All builds from last 30 days
• Older builds on thinning schedule (every 2/4/8 days)
• Drops builds older than 450 days

Contributing

Built for The Hitchhiker's Guide to Cataclysm: Bright Nights.

Contributions welcome!