Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
563a9de
macOS prototype: SwiftUI app and its .dmg (step 3, phase 3)
claude Oct 29, 2026
8b9d492
macOS app: split the views so Swift type-checks them
claude Oct 29, 2026
857a0c2
Merge the merged phase 3 branch, keeping main's content
claude Oct 29, 2026
f985c5d
macOS app: a sword for the weapons, and xattr in Read Me First
claude Oct 29, 2026
052de0f
macOS: the library and the sheet (step 3, phase 4, stage 1)
claude Oct 29, 2026
07900af
Merge the merged branch, keeping main's content
claude Oct 29, 2026
6f733ba
cr-mac-ffi: help, about and entry help for the Mac
claude Oct 29, 2026
8445734
macOS: Help and About
claude Oct 29, 2026
bd36fcc
Merge the merged branch, keeping main's content
claude Oct 29, 2026
c068fde
cr-mac-ffi: rustfmt
claude Oct 29, 2026
d74f022
macOS: the books
claude Oct 29, 2026
01a69df
cr-mac-ffi: rustfmt
claude Oct 29, 2026
9227d73
Merge the merged branch, keeping main's content
claude Oct 29, 2026
364072a
Roadmap: Help and About done on the Mac
claude Oct 29, 2026
1529c24
Merge the merged branch, keeping main's content
claude Oct 29, 2026
6585c2d
macOS: New Character and Enter Character
claude Oct 29, 2026
8d7f329
Merge the merged branch, keeping main's content
claude Oct 29, 2026
84ead8c
macOS: Edit Character with every page of the editor
claude Oct 29, 2026
bcdbaf0
Merge the merged branch, keeping main's content
claude Oct 29, 2026
6cdb709
macOS: New NPC, New NPC Group and Roll on a Table
claude Oct 29, 2026
18ba9b6
macOS: Roll Treasure and the saved treasure
claude Oct 29, 2026
4ed75b6
Merge the merged branch, keeping main's content
claude Oct 29, 2026
a760f8d
Merge the merged branch, keeping main's content
claude Oct 29, 2026
aa329ec
macOS: New Encounter, the encounters and the encounter tables
claude Oct 29, 2026
37ae17e
Merge the merged branch, keeping main's content
claude Oct 29, 2026
5d9b734
macOS: Manage Parties and Group Encounter
claude Oct 29, 2026
20a171a
Merge the merged branch, keeping main's content
claude Oct 29, 2026
a82bcb4
macOS: the record editor of the user databases
claude Oct 29, 2026
57cded9
Merge the merged branch, keeping main's content
claude Oct 29, 2026
98f38ce
macOS: Allowed Classes, Restore and the treasure table editor
claude Oct 29, 2026
1cf1e51
Merge the merged branch, keeping main's content
claude Oct 29, 2026
7408c86
macOS: the encounter template editor
claude Oct 29, 2026
cd635dc
Merge the merged branch, keeping main's content
claude Oct 29, 2026
c2df72a
macOS: Export, Import Core Rules 2.0, New Package and Edit Package
claude Oct 29, 2026
f16c070
Merge the merged branch, keeping main's content
claude Oct 29, 2026
2a46ffa
macOS: Extract Data from CD, from an ISO image or a copied folder
claude Oct 29, 2026
36feaba
Merge the merged branch, keeping main's content
claude Oct 29, 2026
163327c
Release the Mac app: build, test and attach the .dmg
claude Oct 29, 2026
d4931fc
Merge the merged branch, keeping main's content
claude Oct 29, 2026
0f5a99f
macOS: the filters in the bar under the toolbar
claude Oct 29, 2026
07ce681
Merge the merged branch, keeping main's content
claude Oct 29, 2026
e4aa39d
Release 1.1.0 on Linux, Windows 11 and macOS
claude Oct 29, 2026
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
18 changes: 9 additions & 9 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 @@ -8,7 +8,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.1"
version = "1.1.0"
edition = "2024"
license = "MIT"
repository = "https://github.com/brahm/corerules"
Expand Down
88 changes: 54 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +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.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),
> **Version 1.1.0, ready on Linux, Windows 11 and macOS.** 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 and
> macOS versions each went through a beta, where they worked as they
> should. [Download it](#installing) for your distribution or your Mac, 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 All @@ -56,6 +56,15 @@ WinHelp reader.
<img src="docs/screenshots/windows/help.png" width="49%" alt="The Tome of Help on Windows 11">
</p>

### On macOS

The macOS version has every screen of the other two, over the same
backend and the same data files. It is a native Mac app in SwiftUI: the
sections, the entries and the details in three columns, every action in
the menu bar, Settings, and the sheets, the help, the books and the
generators in their own windows. It runs on Apple Silicon Macs with
macOS 14 or newer ([installing](#macos)).

## You need the original discs

This project contains no TSR or Wizards of the Coast content. The rules,
Expand Down Expand Up @@ -91,7 +100,11 @@ preserved by the Internet Archive:
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
4. **macOS (done).** A native SwiftUI version for Apple Silicon Macs, in
this repository over the same backend, distributed as a `.dmg`. After a
beta it was released as 1.1.0 on the three systems, and from now on
every feature ships on all three together.
5. **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 @@ -483,27 +496,30 @@ same:
## Installing

Every [release](https://github.com/brahm/corerules/releases) has
packages for x86-64 Linux. These are the files of
[Core Rules 1.0.1](https://github.com/brahm/corerules/releases/tag/v1.0.1),
the latest release, for Linux and Windows 11:
packages for x86-64 Linux and a `.dmg` for Apple Silicon Macs. These are
the files of
[Core Rules 1.1.0](https://github.com/brahm/corerules/releases/tag/v1.1.0),
the latest release; Windows 11 comes from the
[Microsoft Store](#windows-11):

| System | Download | Install |
| --- | --- | --- |
| 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` |
| macOS 14 or newer, Apple Silicon | [`CoreRules-1.1.0-arm64.dmg`](https://github.com/brahm/corerules/releases/download/v1.1.0/CoreRules-1.1.0-arm64.dmg) | Open it, drag Core Rules to Applications, then [allow it to open](#macos) |
| Fedora 44 or newer | [`corerules-1.1.0-1.fc44.x86_64.rpm`](https://github.com/brahm/corerules/releases/download/v1.1.0/corerules-1.1.0-1.fc44.x86_64.rpm) | `sudo dnf install ./corerules-1.1.0-1.fc44.x86_64.rpm` |
| Ubuntu 26.04 or newer | [`corerules_1.1.0_amd64.deb`](https://github.com/brahm/corerules/releases/download/v1.1.0/corerules_1.1.0_amd64.deb) | `sudo apt install ./corerules_1.1.0_amd64.deb` |
| Arch Linux, CachyOS, Omarchy | [`corerules-1.1.0-1-x86_64.pkg.tar.zst`](https://github.com/brahm/corerules/releases/download/v1.1.0/corerules-1.1.0-1-x86_64.pkg.tar.zst) | `sudo pacman -U ./corerules-1.1.0-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.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 |
| Any distribution (glibc 2.43+) | [`CoreRules-1.1.0-x86_64.AppImage`](https://github.com/brahm/corerules/releases/download/v1.1.0/CoreRules-1.1.0-x86_64.AppImage) | `chmod +x CoreRules-1.1.0-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.1.flatpak`](https://github.com/brahm/corerules/releases/download/v1.0.1/CoreRules-1.0.1.flatpak)
[`CoreRules-1.1.0.flatpak`](https://github.com/brahm/corerules/releases/download/v1.1.0/CoreRules-1.1.0.flatpak)
file, the
[`PKGBUILD`](https://github.com/brahm/corerules/releases/download/v1.0.1/PKGBUILD)
[`PKGBUILD`](https://github.com/brahm/corerules/releases/download/v1.1.0/PKGBUILD)
of the pacman package and
[`SHA256SUMS`](https://github.com/brahm/corerules/releases/download/v1.0.1/SHA256SUMS),
[`SHA256SUMS`](https://github.com/brahm/corerules/releases/download/v1.1.0/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.1
candidates (`-rc`), marked as pre-releases on the releases page; the 1.1.0
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`),
Expand Down Expand Up @@ -544,32 +560,36 @@ The app keeps its data in `Documents\Core Rules\data`, copies the rules
data from the CD or its ISO image with Extract Data from CD…, and also
opens an installation of the original program on the same computer.

### macOS (beta)
### macOS

The Mac version is in beta, for Apple Silicon Macs (M1 or newer) with
macOS 14 or newer: the
[1.1.0 beta](https://github.com/brahm/corerules/releases/tag/v1.1.0-beta1)
has `CoreRules-1.1.0-beta1-arm64.dmg`. Open it and drag Core Rules to
Applications.
The Mac version is for Apple Silicon Macs (M1 or newer) with macOS 14 or
newer. Download
[`CoreRules-1.1.0-arm64.dmg`](https://github.com/brahm/corerules/releases/download/v1.1.0/CoreRules-1.1.0-arm64.dmg),
open it and drag Core Rules to Applications.

The app is signed without a certificate from Apple and is not notarized,
since the project has no Apple developer account, so macOS refuses it the
first time, saying it could not check it. Run this once in Terminal, and
from then on it opens as any app:
because the project has no Apple developer account. So the first time
you open it, macOS refuses it and says it could not check it. Run this
once in Terminal. From then on it opens like any other app:

```sh
xattr -dr com.apple.quarantine "/Applications/Core Rules.app"
```

Without Terminal: open Core Rules once and press Done, then in System
Settings › Privacy & Security, under Security, press **Open Anyway** next
to "Core Rules" and confirm with your password. Some Macs do not offer
Open Anyway, and a Mac managed by a company or school may not allow the
app at all. Either way is needed again after each update.
Without Terminal (the **Open Anyway** steps):

1. Open Core Rules once, and press Done when macOS refuses it.
2. Open System Settings › Privacy & Security.
3. Under Security, press **Open Anyway** next to "Core Rules", and
confirm with your password.

Some Macs do not offer Open Anyway, and a Mac managed by a company or
school may not allow the app at all. You need to do this again after
each update.

The app keeps its data in `~/Library/Application Support/Core Rules/data`.
Macs have no CD drive, so Extract Data from CD… copies the rules data from
the CD's ISO image or from a folder the CD's files were copied into; Open
the CD's ISO image or from a folder the CD's files were copied into. Open
Folder… also opens an installation of the original.

### The Flatpak repository
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.1.0" date="2026-10-29" type="stable">
<description>
<p>Core Rules is now on macOS too, for Apple Silicon Macs with macOS 14 or newer, with every screen of the Linux and Windows 11 versions over the same backend. On Linux nothing changes in what the app does: more of its workings are now shared by the three versions.</p>
</description>
</release>
<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>
Expand Down
7 changes: 4 additions & 3 deletions docs/decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ log is complete.
| S11 | 2026-10-20 | Parity rule: only what was explicitly taken out of scope stays out; everything else the original does must be replicated, or given an equivalent. | Decided by Wagner Brahm while the kit rules were being done. | Phase 1 (PRs #32 to #74) |
| S12 | 2026-10-24 | After 1.0 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. | Decided by Wagner Brahm with the release candidate. | [Roadmap](roadmap.md) |
| S13 | 2026-10-25 | One repository for every version: the Windows version lives in `brahm/corerules` next to the Linux one, and from then on a feature ships only when it works in every maintained version, Windows 11 included. Rules and data stay in the backend; logic shared by the interfaces moves into a crate of its own, and CI checks that both interfaces have the same actions. | Decided by Wagner Brahm when the Windows port was planned. | [Roadmap](roadmap.md#step-2-windows-11-in-progress) |
| S14 | 2026-10-28 | Decision S13 extends to macOS: the macOS version lives in `brahm/corerules` with the Linux and Windows ones, and once it is released a feature ships only when it works on GNOME, Windows 11 and macOS. CI builds and tests the three systems on every pull request, and one `v*` tag publishes the three. | Decided by Wagner Brahm when the macOS port was planned, [Roadmap](roadmap.md#step-3-macos-in-progress) |
| S14 | 2026-10-28 | Decision S13 extends to macOS: the macOS version lives in `brahm/corerules` with the Linux and Windows ones, and once it is released a feature ships only when it works on GNOME, Windows 11 and macOS. CI builds and tests the three systems on every pull request, and one `v*` tag publishes the three. | Decided by Wagner Brahm when the macOS port was planned, [Roadmap](roadmap.md#step-3-macos-done) |

## Left out on purpose

Expand Down Expand Up @@ -122,6 +122,7 @@ Reported during testing and kept, because the original does the same:
| 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 |
| P27 | 2026-10-28 | The macOS version has a native SwiftUI interface (AppKit where SwiftUI falls short) following Apple's Human Interface Guidelines, written in Swift over the Rust backend and `cr-app` through UniFFI, in a new crate `cr-mac-ffi` and the folder `macos/`. Swift only draws; every rule stays in Rust. Unlike Windows (P17), the interface is not in Rust: SwiftUI can only be used from Swift, and the Rust bindings to Apple's frameworks reach AppKit alone. It keeps the organization of the GNOME and Windows apps. | Decided by Wagner Brahm, [Roadmap](roadmap.md#step-3-macos-in-progress) |
| P27 | 2026-10-28 | The macOS version has a native SwiftUI interface (AppKit where SwiftUI falls short) following Apple's Human Interface Guidelines, written in Swift over the Rust backend and `cr-app` through UniFFI, in a new crate `cr-mac-ffi` and the folder `macos/`. Swift only draws; every rule stays in Rust. Unlike Windows (P17), the interface is not in Rust: SwiftUI can only be used from Swift, and the Rust bindings to Apple's frameworks reach AppKit alone. It keeps the organization of the GNOME and Windows apps. | Decided by Wagner Brahm, [Roadmap](roadmap.md#step-3-macos-done) |
| P28 | 2026-10-28 | The macOS version runs on Apple Silicon only, not as a universal binary: macOS 26 is the last version for Intel Macs. | Decided by Wagner Brahm |
| P29 | 2026-10-28 | The macOS version is distributed as a `.dmg` on the GitHub release, without an Apple developer account: it is signed without a certificate from Apple and not notarized. macOS blocks its first launch, and again after each update, until the user chooses Open Anyway in System Settings › Privacy & Security; a managed Mac may not allow it, and Homebrew's own casks are not an option. On macOS the data package lives in `~/Library/Application Support/Core Rules/data`, which asks no permission. | Decided by Wagner Brahm, [Roadmap](roadmap.md#step-3-macos-in-progress) |
| P29 | 2026-10-28 | The macOS version is distributed as a `.dmg` on the GitHub release, without an Apple developer account: it is signed without a certificate from Apple and not notarized. macOS blocks its first launch, and again after each update, until the user chooses Open Anyway in System Settings › Privacy & Security; a managed Mac may not allow it, and Homebrew's own casks are not an option. On macOS the data package lives in `~/Library/Application Support/Core Rules/data`, which asks no permission. | Decided by Wagner Brahm, [Roadmap](roadmap.md#step-3-macos-done) |
| P30 | 2026-10-29 | The macOS version leaves its beta as a final release: Wagner Brahm found it working on an Apple Silicon Mac. Linux, Windows 11 and macOS are released together as 1.1.0, with the same tag, and the website links the `.dmg` with the Open Anyway steps. | Decided by Wagner Brahm, 1.1.0 |
Loading
Loading