Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,9 @@ preserved by the Internet Archive:
2. **1.0 (now).** The release candidate was confirmed stable on Fedora 45
beta, Ubuntu 26.10, Bazzite, Arch Linux and CachyOS, and became 1.0.0:
a faithful replacement for the original program.
3. **Flathub.** With 1.0 stable, the app is published on Flathub.
4. **Windows and macOS.** Then come Windows and macOS builds, on the same
3. **Windows and macOS.** Then come Windows and macOS builds, on the same
backend.
5. **New features.** From then on the app improves on the original and
4. **New features.** From then on the app improves on the original and
moves away from it, step by step, until it no longer needs the original
program's files to work.

Expand Down Expand Up @@ -345,7 +344,7 @@ when and why each was decided.
### Platform and setup

- **Linux only, no Wine.** The app is a native GTK 4 program. Windows and
macOS versions come after 1.0 and the Flathub publication; the backend
macOS versions come after 1.0; the backend
crates have no GTK dependency so they can be built then.
- **No installation of the original needed.** Extract Data from CD… copies
what the app uses from the CD, its ISO image (read directly, with no
Expand Down
5 changes: 3 additions & 2 deletions docs/decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,9 @@ Reported during testing and kept, because the original does the same:
| P7 | 2026-10-24 | Ubuntu 24.04 is no longer supported: the `.deb` requires Ubuntu 26.04's `libc6` and refuses to install on 24.04; the Flatpak runs there. Test round item B35. | PR #81 |
| P8 | 2026-10-24 | A pacman package (and its `PKGBUILD`) for Arch Linux, CachyOS and Omarchy, tested on clean Arch and CachyOS containers, added to 1.0.0-rc1. | PR #83 |
| P9 | 2026-10-24 | The release before 1.0 is 1.0.0-rc1, a pre-release. Version suffixes are written `1.0.0~rc1` in the `.deb` and `.rpm` and `1.0.0rc1` in the pacman package, so 1.0.0 sorts after them. | PR #82 |
| P10 | 2026-10-24 | Flathub publication waits until 1.0 is confirmed stable. | [Roadmap](roadmap.md) |
| P11 | 2026-10-24 | Windows and macOS builds come after the Flathub publication; until then the backend stays free of GTK. | [Roadmap](roadmap.md) |
| P10 | 2026-10-24 | Flathub publication waits until 1.0 is confirmed stable. Replaced by P15. | [Roadmap](roadmap.md) |
| P11 | 2026-10-24 | Windows and macOS builds come after the Flathub publication; until then the backend stays free of GTK. Replaced by P15. | [Roadmap](roadmap.md) |
| P12 | 2026-10-24 | Fixes found by real users ship as further release candidates (1.0.0-rc2 onward) rather than by republishing 1.0.0-rc1. | Decided by Wagner Brahm, 1.0.0-rc2 |
| P13 | 2026-10-24 | 1.0.0 is released as the final version, the repository's latest release: the code of 1.0.0-rc2 with the new About window. The release candidate was confirmed stable by its users on Fedora 45 beta, Ubuntu 26.10, Bazzite, Arch Linux and CachyOS; the release workflow adds Ubuntu 26.10 and Fedora 45 to its test systems. | Decided by Wagner Brahm, 1.0.0 |
| P14 | 2026-10-24 | The add-ons AppImage is also published as the file itself on GitHub Packages, in its Maven registry (`io.github.brahm:corerules-community-addons`), since GitHub Packages has no registry for plain files; the OCI artifact on ghcr.io and the addons release stay, the release being the direct download link. | Decided by Wagner Brahm, 1.0.0 |
| P15 | 2026-10-24 | Publishing on Flathub is dropped from the plan, after a review of Flathub's current requirements. The Flatpak is still built, tested and attached to every release. Windows and macOS come right after 1.0, and the backend stays free of GTK until then. | Decided by Wagner Brahm, [Roadmap](roadmap.md) |
59 changes: 10 additions & 49 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ CachyOS, Omarchy), a Flatpak and an AppImage (both on GNOME 51), and the
Community Add-ons Collection as its own AppImage, version 1.0.0. The
[website](https://brahm.github.io/corerules/) links every file.

The next step is the Flathub publication. No issue is open on GitHub.
The next step is Windows and macOS (step 2). Publishing on Flathub was
dropped from the plan (decision P15). No issue is open on GitHub.

## The original plan (2026-10-09)

Expand All @@ -34,8 +35,8 @@ taken out of scope.
| 2. Writing and rules engine | Write user data and packages, character creation, Player's Option | Done, byte for byte with the original |
| 3. Minimal GTK app | Library, sheet, creation wizard, rules browser, printing and PDF | Done. The dice roller was dropped (S6) |
| 4. Generators | Encounters, treasure, NPCs, monsters, custom tables | Done |
| 5. Maps and Expansion | Map Maker II and Campaign Mapper, Expansion classes, Flathub, pt-BR | Expansion classes and translations (six languages) done; maps dropped (S6); Flathub moved after 1.0 |
| 6. macOS and Windows | Other platforms over the same backend | Moved after Flathub (P11) |
| 5. Maps and Expansion | Map Maker II and Campaign Mapper, Expansion classes, Flathub, pt-BR | Expansion classes and translations (six languages) done; maps dropped (S6); Flathub dropped (P15) |
| 6. macOS and Windows | Other platforms over the same backend | Moved after 1.0 (P15) |

## The revised plan (2026-10-17 to 2026-10-24)

Expand All @@ -49,7 +50,7 @@ taken out of scope.
| Release candidate | 1.0.0-rc1, README rewritten in English with every difference from the original, pacman package | Done (PRs #82 and #83) |
| Real-user fixes | 1.0.0-rc2: saving with the mounted CD opened | Done (PR #85) |
| 1.0 | Release candidate confirmed stable by its users, 1.0.0 released with the new About window and the website | Done |
| Flathub | Publication on Flathub | Moved after 1.0 |
| Flathub | Publication on Flathub | Dropped (P15) |

### Releases

Expand Down Expand Up @@ -96,44 +97,7 @@ Done on 2026-10-24: Wagner Brahm's friends ran 1.0.0-rc2 on Fedora 45
beta, Ubuntu 26.10, Bazzite, Arch Linux and CachyOS, found nothing wrong,
and Wagner Brahm gave the go-ahead (decision P13).

### Step 2: publish on Flathub

Delivers `flatpak install flathub io.github.brahm.CoreRules`.

1. **Offline build.** Flathub builds without network access. The manifest
now lets Cargo download crates during the build
(`packaging/flatpak/io.github.brahm.CoreRules.yml`, `--share=network`);
it has to list them as sources instead, generated from `Cargo.lock`
with `flatpak-cargo-generator`, and point at a release tag instead of
the local folder.
2. **Permissions.** The app asks for the whole home folder (where Wine
keeps Core Rules) and for `/media` and `/run/media` (mounted CDs). The
Flathub reviewers ask for the narrowest set that works, so this needs a
look: the data package in the app's own data folder and the file chooser
portal for ISO images may make `--filesystem=home` unnecessary for most
users, and the reason must be written in the submission when it stays.
3. **Metainfo.** Pass `flatpak-builder-lint`: screenshots (already in
`docs/screenshots`), content rating, release notes, developer name and
the release type of 1.0.
4. **App id.** `io.github.brahm.CoreRules` is verified through the GitHub
account `brahm`.
5. **Submission.** A pull request to `flathub/flathub`; after it is
accepted, Flathub creates `flathub/io.github.brahm.CoreRules`, where
each new release becomes a manifest update.
6. **Release workflow.** Keep building the Flatpak bundle for the GitHub
release, and add the manifest update for Flathub to the release steps.

Risks:

- The app only works with data from discs the user owns. The metainfo and
the submission must say plainly that it contains no rules content.
- GNOME 51 leaves support in about a year; the runtime is raised with each
GNOME release, as was done in 0.6.0.

Needs Wagner Brahm: the go-ahead for the submission, which is public and in
Wagner Brahm's name, and following the Flathub reviewers' questions.

### Step 3: Windows and macOS
### Step 2: Windows and macOS

The original plan kept `cr-formats` and `cr-store` free of GTK for this, and
they still are.
Expand Down Expand Up @@ -162,7 +126,7 @@ they still are.

Needs Wagner Brahm: the choice of interface, and whether to pay for signing.

### Step 4: new features, and independence from the original
### Step 3: new features, and independence from the original

From 1.0 on, the app improves on the original and moves away from it step
by step, until it no longer needs the original's files to work
Expand All @@ -186,14 +150,11 @@ starts, from Wagner Brahm's ideas and the users' requests; this is the direction
as users ask for it.

Needs Wagner Brahm: the list of features for each release, and how far
independence goes (step 4.3).
independence goes (step 3.3).

## Decisions pending

- The length of the testing period, and the confirmation that 1.0 is
stable (step 1).
- The go-ahead for the Flathub submission (step 2).
- GTK 4 or native interfaces on Windows and macOS, and code signing
(step 3).
(step 2).
- The first features after 1.0, and the source of rules content without
the discs (step 4).
the discs (step 3).
Loading