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
16 changes: 8 additions & 8 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ members = ["crates/cr-i18n", "crates/cr-formats", "crates/cr-store", "crates/cr-
default-members = ["crates/cr-i18n", "crates/cr-formats", "crates/cr-store", "crates/cr-app", "crates/cr-cli", "crates/cr-gtk"]

[workspace.package]
version = "1.0.0"
version = "1.0.1"
edition = "2024"
license = "MIT"
repository = "https://github.com/brahm/corerules"
Expand Down
55 changes: 28 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ Edition. It is written in Rust and runs natively: with GTK 4 and libadwaita
on Linux, with no Wine, and with WinUI 3 on Windows 11. On Linux it comes as
a `.deb` for Ubuntu, an `.rpm` for Fedora, a pacman package for Arch Linux
(and CachyOS and Omarchy), a Flatpak and an AppImage; on Windows 11 it comes
from the [Microsoft Store](https://apps.microsoft.com/detail/9nr2cgp649jm), where it is in a closed beta. See
from the [Microsoft Store](https://apps.microsoft.com/detail/9nr2cgp649jm). Both versions are
final releases. See
[Installing](#installing).

Every screen of the original program is here: the Character Generator with
Expand All @@ -22,11 +23,13 @@ the help. The app reads and writes the original's own data files, so
characters, monsters, encounters and packages made in either program open
in the other.

> **Version 1.0.0, the first stable release.** Every feature was checked
> against the original programs and went through a full round of manual
> tests, and players and Dungeon Masters ran the release candidate on
> Fedora 45 beta, Ubuntu 26.10, Bazzite, Arch Linux and CachyOS, where it
> worked as it should. [Download it](#installing) for your distribution,
> **Version 1.0.1, ready on Linux and Windows 11.** Every feature was
> checked against the original programs and went through a full round of
> manual tests. Players and Dungeon Masters ran 1.0 on Fedora 45 beta,
> Ubuntu 26.10, Bazzite, Arch Linux and CachyOS, and the Windows 11
> version went through a beta on the Microsoft Store, where both worked as
> they should. [Download it](#installing) for your distribution, get it
> from the [Microsoft Store](https://apps.microsoft.com/detail/9nr2cgp649jm),
> or visit the [website](https://brahm.github.io/corerules/).

![The character list with a character made in the original program](docs/screenshots/character.png)
Expand Down Expand Up @@ -80,15 +83,14 @@ preserved by the Internet Archive:

1. **Release candidates (done).** 1.0.0-rc1 and 1.0.0-rc2 went to real
users, and the problems they found were fixed.
2. **1.0 (now).** The release candidate was confirmed stable on Fedora 45
2. **1.0 (done).** 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. **Windows 11 (in beta).** A Windows 11 version in this repository,
with a native WinUI 3 interface written in Rust over the same backend,
distributed through the Microsoft Store. Every screen is ported, and a
closed beta goes through the Store; once its users confirm it, it is
released with the same version as Linux. From then on every feature
ships on Linux and Windows together.
3. **Windows 11 (done).** A Windows 11 version in this repository, with a
native WinUI 3 interface written in Rust over the same backend,
distributed through the Microsoft Store. Every screen is ported; after
a beta on the Store it was released as 1.0.1, the same version as
Linux. From now on every feature ships on Linux and Windows together.
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 @@ -482,27 +484,27 @@ same:

Every [release](https://github.com/brahm/corerules/releases) has
packages for x86-64 Linux. These are the files of
[Core Rules 1.0.0](https://github.com/brahm/corerules/releases/tag/v1.0.0),
the latest release:
[Core Rules 1.0.1](https://github.com/brahm/corerules/releases/tag/v1.0.1),
the latest release, for Linux and Windows 11:

| System | Download | Install |
| --- | --- | --- |
| Fedora 44 or newer | [`corerules-1.0.0-1.fc44.x86_64.rpm`](https://github.com/brahm/corerules/releases/download/v1.0.0/corerules-1.0.0-1.fc44.x86_64.rpm) | `sudo dnf install ./corerules-1.0.0-1.fc44.x86_64.rpm` |
| Ubuntu 26.04 or newer | [`corerules_1.0.0_amd64.deb`](https://github.com/brahm/corerules/releases/download/v1.0.0/corerules_1.0.0_amd64.deb) | `sudo apt install ./corerules_1.0.0_amd64.deb` |
| Arch Linux, CachyOS, Omarchy | [`corerules-1.0.0-1-x86_64.pkg.tar.zst`](https://github.com/brahm/corerules/releases/download/v1.0.0/corerules-1.0.0-1-x86_64.pkg.tar.zst) | `sudo pacman -U ./corerules-1.0.0-1-x86_64.pkg.tar.zst` |
| Fedora 44 or newer | [`corerules-1.0.1-1.fc44.x86_64.rpm`](https://github.com/brahm/corerules/releases/download/v1.0.1/corerules-1.0.1-1.fc44.x86_64.rpm) | `sudo dnf install ./corerules-1.0.1-1.fc44.x86_64.rpm` |
| Ubuntu 26.04 or newer | [`corerules_1.0.1_amd64.deb`](https://github.com/brahm/corerules/releases/download/v1.0.1/corerules_1.0.1_amd64.deb) | `sudo apt install ./corerules_1.0.1_amd64.deb` |
| Arch Linux, CachyOS, Omarchy | [`corerules-1.0.1-1-x86_64.pkg.tar.zst`](https://github.com/brahm/corerules/releases/download/v1.0.1/corerules-1.0.1-1-x86_64.pkg.tar.zst) | `sudo pacman -U ./corerules-1.0.1-1-x86_64.pkg.tar.zst` |
| Any distribution with Flatpak, such as Bazzite | [`io.github.brahm.CoreRules.flatpakref`](https://brahm.github.io/corerules/io.github.brahm.CoreRules.flatpakref), from the [Flatpak repository](#the-flatpak-repository) | `flatpak install --user https://brahm.github.io/corerules/io.github.brahm.CoreRules.flatpakref` |
| Any distribution (glibc 2.43+) | [`CoreRules-1.0.0-x86_64.AppImage`](https://github.com/brahm/corerules/releases/download/v1.0.0/CoreRules-1.0.0-x86_64.AppImage) | `chmod +x CoreRules-1.0.0-x86_64.AppImage`, then run it |
| Any distribution (glibc 2.43+) | [`CoreRules-1.0.1-x86_64.AppImage`](https://github.com/brahm/corerules/releases/download/v1.0.1/CoreRules-1.0.1-x86_64.AppImage) | `chmod +x CoreRules-1.0.1-x86_64.AppImage`, then run it |
| Community add-ons (installer) | [`CoreRules-Community-Addons-x86_64.AppImage`](https://github.com/brahm/corerules/releases/download/addons/CoreRules-Community-Addons-x86_64.AppImage) | `chmod +x CoreRules-Community-Addons-x86_64.AppImage`, then run it |

The release also has the
[`CoreRules-1.0.0.flatpak`](https://github.com/brahm/corerules/releases/download/v1.0.0/CoreRules-1.0.0.flatpak)
[`CoreRules-1.0.1.flatpak`](https://github.com/brahm/corerules/releases/download/v1.0.1/CoreRules-1.0.1.flatpak)
file, the
[`PKGBUILD`](https://github.com/brahm/corerules/releases/download/v1.0.0/PKGBUILD)
[`PKGBUILD`](https://github.com/brahm/corerules/releases/download/v1.0.1/PKGBUILD)
of the pacman package and
[`SHA256SUMS`](https://github.com/brahm/corerules/releases/download/v1.0.0/SHA256SUMS),
[`SHA256SUMS`](https://github.com/brahm/corerules/releases/download/v1.0.1/SHA256SUMS),
the checksums of every file. Before 1.0 there were betas (0.x) and release
candidates (`-rc`), marked as pre-releases on the releases page; the 1.0.0
packages replace a release candidate on update.
candidates (`-rc`), marked as pre-releases on the releases page; the 1.0.1
packages replace 1.0.0 or a release candidate on update.

Users ran 1.0 on Fedora 45 beta (the `.rpm`), Ubuntu 26.10 (the `.deb`),
Bazzite (the Flatpak and the AppImage, as on any Fedora Atomic desktop),
Expand Down Expand Up @@ -532,9 +534,8 @@ package from the release's source with `makepkg -si`.

The Windows 11 version comes from the
[Microsoft Store](https://apps.microsoft.com/detail/9nr2cgp649jm), which signs the package, so
Windows and Smart App Control install it without warnings. It is in a
closed beta now: the Store page opens for the testers of the beta, and for
everyone once the beta ends. There is no direct download: the MSIX that the
Windows and Smart App Control install it without warnings. There is no
direct download: the MSIX that the
release workflow builds is not signed (the Store signs it), and Windows does
not install an unsigned package. The Store also installs the Windows App
Runtime that the app needs and brings every update.
Expand Down
5 changes: 5 additions & 0 deletions data/io.github.brahm.CoreRules.metainfo.xml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@
<color type="primary" scheme_preference="dark">#77101b</color>
</branding>
<releases>
<release version="1.0.1" date="2026-10-27" type="stable">
<description>
<p>Core Rules is now ready on Linux and Windows 11, where it comes from the Microsoft Store with every screen of the Linux version. On Linux: a priest's quest spell is called a quest spell in the editors, Edit Character shows the social class in the language chosen, the editors' wording is clearer and Portuguese tells the Abilities and Skills tabs apart, Back keeps what a creation page had, the translations lost the original's double spaces, and the Flatpak comes from the project's own repository, which brings every update.</p>
</description>
</release>
<release version="1.0.0" date="2026-10-24" type="stable">
<description>
<p>The first stable release. Its users ran the release candidate on Fedora 45 beta, Ubuntu 26.10, Bazzite, Arch Linux and CachyOS, and it worked as it should. New since 1.0.0-rc2: the About window has the credits of the original program and of this one, the legal notice, the details a bug report needs and these release notes, and it links to the new website.</p>
Expand Down
1 change: 1 addition & 0 deletions docs/decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,4 @@ Reported during testing and kept, because the original does the same:
| P23 | 2026-10-25 | **(code)** Every action of the app is declared once in `cr-app` (`cr_app::action`), and both apps refer to it only from there. `NOT_YET_ON_WINDOWS` lists the actions the Windows app does not have yet, a test fails when the apps differ in any other way, and the release with Windows waits until the list is empty, following decision S13. | Phase 3 of the Windows port, PR #99, `crates/cr-app/tests/parity.rs` |
| P24 | 2026-10-25 | **(code)** The Windows app shows the WinHelp topics as web pages in a WebView2 (through the `webview2-com` crate), made from the topics by `cr-win` with their fonts, colours, tables and pictures, since windows-reactor's rich text has no fonts, pictures or links that stay in the app. The help is a page of the window, with Back to where it was opened, rather than a window of its own, and F1 is caught by a keyboard hook, since windows-reactor's accelerators have no function keys. | Phase 4 of the Windows port, [Roadmap](roadmap.md#step-2-windows-11-in-progress) |
| P25 | 2026-10-25 | **(code)** The Windows app shows a book as one web page in a WebView2, made by `cr-win` from the book's RTF with every character of its text in place, so that Find runs in `cr-app` over the book's folded text, as in the GNOME reader, and the page only highlights the matches it is given (the CSS Custom Highlight API). The page is a file in the temporary folder, since a book is larger than a page given as a string may be. The book is a page of the window, as the help is. Its keys are caught by the keyboard hook of P24, and the page posts the ones pressed in it, since the WebView2 runs in a process of its own. | Phase 4 of the Windows port, [Roadmap](roadmap.md#step-2-windows-11-in-progress) |
| P26 | 2026-10-27 | The Windows 11 version leaves the Store beta as a final release: Wagner Brahm found no problem in it. Linux and Windows 11 are released together as 1.0.1 (the Store needs a higher version than the 1.0.0 MSIX of the beta), with the same tag, and the Store listing becomes public. | Decided by Wagner Brahm, 1.0.1 |
38 changes: 20 additions & 18 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ what comes after 1.0. The decisions that shaped it are in the

## Where we are

**1.0.0, published on 2026-10-24, the first stable release.** Its users
**1.0.1, published on 2026-10-27, ready on Linux and Windows 11.** The
Windows 11 version went through a beta on the Microsoft Store, where
Wagner Brahm found no problem, and ships with Linux as 1.0.1 (decision
P26). 1.0.0, published on 2026-10-24, was the first stable release. Its users
ran 1.0.0-rc2 on Fedora 45 beta, Ubuntu 26.10, Bazzite, Arch Linux and
CachyOS, and Wagner Brahm confirmed it stable, so 1.0.0 is the code of
1.0.0-rc2 with the new About window (PR #89). It does everything
Expand All @@ -22,15 +25,12 @@ Community Add-ons Collection as its own AppImage, version 1.0.0. The
the project's own Flatpak repository, which gets each final release
(decision P16).

The Windows 11 version (step 2) is under way: the backend and `cr` are
built and tested on Windows (phase 1), Wagner Brahm approved the
prototype of the Windows app on 2026-10-25 (phase 2, decision P21), and
the groundwork that keeps both apps the same is in place (phase 3): the
shared crate `cr-app`, one PDF of the sheet for both systems and a test
that fails when an action is in one app and not in the other. The screens
are being ported (phase 4): the library, the character sheet, the help,
Settings and About, the books, character creation with Enter Character,
editing and the generators are done.
The Windows 11 version (step 2) is done: the backend and `cr` are built
and tested on Windows (phase 1), Wagner Brahm approved the prototype on
2026-10-25 (phase 2, decision P21), the groundwork that keeps both apps
the same is in place (phase 3), every screen is ported (phase 4), the
release workflow builds and tests the MSIX for the Microsoft Store
(phase 5), and 1.0.1 is the first release on both systems (phase 6).
Publishing on Flathub was dropped from the plan (decision P15).

## The original plan (2026-10-09)
Expand Down Expand Up @@ -79,6 +79,7 @@ taken out of scope.
| 1.0.0-rc1 | 2026-10-24 | Fixes from the test round, pacman package |
| 1.0.0-rc2 | 2026-10-24 | Saving with the mounted CD opened goes into a local copy |
| 1.0.0 | 2026-10-24 | First stable release, the About window, the website |
| 1.0.1 | 2026-10-27 | Windows 11 on the Microsoft Store, the Flatpak repository, small fixes |

## After 1.0

Expand Down Expand Up @@ -108,7 +109,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: Windows 11 (in progress)
### Step 2: Windows 11 (done)

Decided by Wagner Brahm on 2026-10-25 (decisions S13 and P17 to P20): the
Windows version lives in this repository, next to the Linux one, and from
Expand Down Expand Up @@ -402,18 +403,19 @@ The phases run in order:
library's list, the New Encounter templates list makes only the
rows it shows, and "not added" messages no longer repeat "Error."
in the translations.
5. **Package and Store.** The release workflow builds and tests the MSIX;
a beta goes to a closed group through the Microsoft Store.
- **The MSIX in the release workflow (in progress).** The workflow
5. **Package and Store (done).** The release workflow builds and tests
the MSIX; a beta went to a closed group through the Microsoft Store.
- **The MSIX in the release workflow (done, PRs #111 and #112).** The workflow
builds the MSIX with the version of the tag, installs it on a clean
Windows with the Windows App Runtime (signed there with a
certificate of its publisher that only that machine trusts), starts
the app from Start and runs the Windows App Certification Kit. The
MSIX stays among the run's artifacts for the Store, not in the
GitHub release, where Windows would not install it unsigned.
6. **Release with Windows**, once the beta's users confirm it, with the
same version and tag as Linux. The Community Add-ons Collection follows
as a package the Windows app imports.
6. **Release with Windows (done).** Wagner Brahm found no problem in the
beta and released 1.0.1 on 2026-10-27 on Linux and Windows 11, with the
same version and tag (decision P26). The Community Add-ons Collection
follows as a package the Windows app imports.

The interface follows Windows 11's patterns rather than GNOME's: settings
cards with combo boxes, number boxes and toggle switches for the forms,
Expand Down Expand Up @@ -450,7 +452,7 @@ trusted its certificate by hand. The product Core Rules was reserved on
2026-10-25; the Store drops a reservation not used within three months, so
it may need to be reserved again before submission.

Needs Wagner Brahm: confirming the beta (phase 5).
Done on 2026-10-27 with 1.0.1.

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

Expand Down
4 changes: 2 additions & 2 deletions packaging/arch/PKGBUILD
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
pkgname=corerules
# A pre-release (1.0.0-rc1) drops the hyphen, which pacman does not allow
# in a version: 1.0.0rc1 sorts before 1.0.0.
pkgver=1.0.0
_tag=v1.0.0
pkgver=1.0.1
_tag=v1.0.1
pkgrel=1
pkgdesc='Browse and edit AD&D Core Rules 2.0 characters and rules'
arch=('x86_64')
Expand Down
Loading
Loading