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 @@ -6,7 +6,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.1.0"
version = "1.2.0"
edition = "2024"
license = "MIT"
repository = "https://github.com/brahm/corerules"
Expand Down
96 changes: 51 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@

# Core Rules

**Core Rules** is a complete Linux and Windows 11 version of **AD&D Core
Rules 2.0** and its **Expansion** (TSR/Evermore, 1998-1999), the character
manager and Dungeon Master's toolkit for Advanced Dungeons & Dragons 2nd
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). Both versions are
final releases. See
**Core Rules** is a complete Linux, Windows 11 and macOS version of **AD&D
Core Rules 2.0** and its **Expansion** (TSR/Evermore, 1998-1999), the
character manager and Dungeon Master's toolkit for Advanced Dungeons &
Dragons 2nd Edition. It is written in Rust and runs natively: with GTK 4 and
libadwaita on Linux, with no Wine, with WinUI 3 on Windows 11 and with
SwiftUI on the Mac. 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), and on
Apple Silicon Macs as a `.dmg`. All three are final releases. See
[Installing](#installing).

Every screen of the original program is here: the Character Generator with
Expand All @@ -23,7 +24,10 @@ 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.1.0, ready on Linux, Windows 11 and macOS.** Every feature
> **Version 1.2.0, on Linux, Windows 11 and macOS.** New in 1.2.0:
> **Import Add-ons…** brings in every add-on in a folder at once, and the
> [Community Add-ons Collection](#community-add-ons) comes as one `.zip`
> for it, on all three systems. 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
Expand All @@ -32,7 +36,7 @@ in the other.
> 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)
![A module character with his portrait, from the Community Add-ons](docs/screenshots/character.png)

### On Windows 11

Expand All @@ -44,16 +48,16 @@ discs open in the app's own Help page, since Windows 11 no longer has a
WinHelp reader.

<p align="center">
<img src="docs/screenshots/windows/character.png" width="49%" alt="The character list on Windows 11">
<img src="docs/screenshots/windows/monster.png" width="49%" alt="A red dragon's page in the library on Windows 11">
<img src="docs/screenshots/windows/character.png" width="49%" alt="A module character with his portrait on Windows 11">
<img src="docs/screenshots/windows/import-addons.png" width="49%" alt="Import Add-ons listing the Community Add-ons Collection on Windows 11">
</p>
<p align="center">
<img src="docs/screenshots/windows/encounter.png" width="49%" alt="An orc lair encounter on Windows 11">
<img src="docs/screenshots/windows/sheet.png" width="49%" alt="A character sheet on Windows 11">
<img src="docs/screenshots/windows/new-character.png" width="49%" alt="Rolling ability scores in New Character on Windows 11">
<img src="docs/screenshots/windows/sheet.png" width="49%" alt="Jarlaxle's character sheet on Windows 11">
</p>
<p align="center">
<img src="docs/screenshots/windows/new-character.png" width="49%" alt="Rolling ability scores in New Character on Windows 11">
<img src="docs/screenshots/windows/help.png" width="49%" alt="The Tome of Help on Windows 11">
<img src="docs/screenshots/windows/monster.png" width="49%" alt="The red dragon's picture in the library on Windows 11">
<img src="docs/screenshots/windows/encounter.png" width="49%" alt="An orc lair encounter on Windows 11">
</p>

### On macOS
Expand Down Expand Up @@ -104,9 +108,10 @@ preserved by the Internet Archive:
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.
5. **New features (in progress).** 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. 1.2.0 brings the first:
Import Add-ons… and the Community Add-ons Collection as a `.zip`.

The [roadmap](docs/roadmap.md) has the plan, what is done and what each
step needs; the [decision log](docs/decisions.md) records every decision
Expand Down Expand Up @@ -267,7 +272,7 @@ the original programs wrote.

<p>
<img src="docs/screenshots/new-character.png" width="49%" alt="The New Character wizard rolling ability scores">
<img src="docs/screenshots/sheet.png" width="49%" alt="The character sheet of a character">
<img src="docs/screenshots/sheet.png" width="49%" alt="Jarlaxle's character sheet">
</p>

### DM Toolkit
Expand Down Expand Up @@ -330,20 +335,19 @@ the original programs wrote.
Conflict asks for another name when a part has that one too; as in the
Expansion, opening the folder renames the kits, nonweapon proficiencies,
schools and magical items of yours that a standard one's name hides
- **Import Add-ons…** imports every add-on in a folder at once: the
folder, its subfolders and its ZIP archives (also ZIPs inside ZIPs) are
read, each `.xpx` and `.xpt` package is told apart by what it holds, and
the list shows what comes in, what was found twice and what cannot be
imported before anything is written. It backs up the user databases and
characters first, imports from the oldest file to the newest, leaves out
the characters already in the list, copies the add-ons' pictures where
their records look for them and writes a log (see
[Community add-ons](#community-add-ons))

<p>
<img src="docs/screenshots/npc.png" width="49%" alt="The New NPC dialog">
<img src="docs/screenshots/encounter.png" width="49%" alt="An orc lair encounter generated from its template">
</p>

<p>
<img src="docs/screenshots/treasure.png" width="49%" alt="Treasure rolled for treasure types A and H">
<img src="docs/screenshots/editor.png" width="49%" alt="The editor for a new wizard spell">
</p>

<p>
<img src="docs/screenshots/package.png" width="49%" alt="A new package with two characters and an encounter">
<img src="docs/screenshots/monster.png" width="49%" alt="A monster's page in the library">
<img src="docs/screenshots/encounter.png" width="49%" alt="An orc encounter generated from its template">
<img src="docs/screenshots/monster.png" width="49%" alt="The red dragon's picture in the library">
</p>

### Core Rules 2.0 and the Expansion
Expand Down Expand Up @@ -501,28 +505,28 @@ same:
Every [release](https://github.com/brahm/corerules/releases) has
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),
[Core Rules 1.2.0](https://github.com/brahm/corerules/releases/tag/v1.2.0),
the latest release; Windows 11 comes from the
[Microsoft Store](#windows-11):

| System | Download | Install |
| --- | --- | --- |
| 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` |
| macOS 14 or newer, Apple Silicon | [`CoreRules-1.2.0-arm64.dmg`](https://github.com/brahm/corerules/releases/download/v1.2.0/CoreRules-1.2.0-arm64.dmg) | Open it, drag Core Rules to Applications, then [allow it to open](#macos) |
| Fedora 44 or newer | [`corerules-1.2.0-1.fc44.x86_64.rpm`](https://github.com/brahm/corerules/releases/download/v1.2.0/corerules-1.2.0-1.fc44.x86_64.rpm) | `sudo dnf install ./corerules-1.2.0-1.fc44.x86_64.rpm` |
| Ubuntu 26.04 or newer | [`corerules_1.2.0_amd64.deb`](https://github.com/brahm/corerules/releases/download/v1.2.0/corerules_1.2.0_amd64.deb) | `sudo apt install ./corerules_1.2.0_amd64.deb` |
| Arch Linux, CachyOS, Omarchy | [`corerules-1.2.0-1-x86_64.pkg.tar.zst`](https://github.com/brahm/corerules/releases/download/v1.2.0/corerules-1.2.0-1-x86_64.pkg.tar.zst) | `sudo pacman -U ./corerules-1.2.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.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 |
| Any distribution (glibc 2.43+) | [`CoreRules-1.2.0-x86_64.AppImage`](https://github.com/brahm/corerules/releases/download/v1.2.0/CoreRules-1.2.0-x86_64.AppImage) | `chmod +x CoreRules-1.2.0-x86_64.AppImage`, then run it |
| Community add-ons, for every system above | [`CoreRules-Community-Addons.zip`](https://github.com/brahm/corerules/releases/download/addons/CoreRules-Community-Addons.zip) | In Core Rules, Import Add-ons…, then pick the folder that holds the zip ([how](#community-add-ons)) |

The release also has the
[`CoreRules-1.1.0.flatpak`](https://github.com/brahm/corerules/releases/download/v1.1.0/CoreRules-1.1.0.flatpak)
[`CoreRules-1.2.0.flatpak`](https://github.com/brahm/corerules/releases/download/v1.2.0/CoreRules-1.2.0.flatpak)
file, the
[`PKGBUILD`](https://github.com/brahm/corerules/releases/download/v1.1.0/PKGBUILD)
[`PKGBUILD`](https://github.com/brahm/corerules/releases/download/v1.2.0/PKGBUILD)
of the pacman package and
[`SHA256SUMS`](https://github.com/brahm/corerules/releases/download/v1.1.0/SHA256SUMS),
[`SHA256SUMS`](https://github.com/brahm/corerules/releases/download/v1.2.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.1.0
candidates (`-rc`), marked as pre-releases on the releases page; the 1.2.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 @@ -567,7 +571,7 @@ opens an installation of the original program on the same computer.

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),
[`CoreRules-1.2.0-arm64.dmg`](https://github.com/brahm/corerules/releases/download/v1.2.0/CoreRules-1.2.0-arm64.dmg),
open it and drag Core Rules to Applications.

The app is signed without a certificate from Apple and is not notarized,
Expand Down Expand Up @@ -673,7 +677,7 @@ one `.zip`, on every system the app runs on:

This link always gives the newest build; the
[addons release](https://github.com/brahm/corerules/releases/tag/addons)
also keeps each version. To import it:
also keeps each version. To import it (Core Rules 1.2.0 or newer):

1. Put the zip in a folder of its own. There is no need to extract it.
2. In Core Rules, choose **Import Add-ons…** (the main menu on Linux, the
Expand All @@ -685,6 +689,8 @@ The collection's [README](addons/README.md) says what is inside, how it was
built and how to undo an import. A Linux installer (an AppImage) carried the
add-ons until 1.1.0; Import Add-ons… replaces it.

![Import Add-ons… listing the Community Add-ons Collection before importing it](docs/screenshots/import-addons.png)

**Import Add-ons…**, in the main menu on Linux, the More menu on Windows
and the File menu on the Mac, brings in every add-on in a folder at once.
The folder is searched with its subfolders and the ZIP archives in it (as
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.2.0" date="2026-10-30" type="stable">
<description>
<p>Import Add-ons… imports every add-on in a folder at once, from its subfolders and ZIP archives too, after listing what comes in and what cannot. It backs up the user databases and characters first, copies the add-ons' pictures and writes a log. The Community Add-ons Collection now comes as one .zip for it, which replaces the add-ons installer.</p>
</description>
</release>
<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>
Expand Down
1 change: 1 addition & 0 deletions docs/decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,3 +126,4 @@ Reported during testing and kept, because the original does the same:
| 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-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 |
| P31 | 2026-10-30 | The Linux add-ons installer (the `cr-addons` AppImage, also on GitHub Packages) is abandoned. The Community Add-ons Collection ships only as `CoreRules-Community-Addons.zip` on the addons release, and Import Add-ons… in the app, on Linux, Windows 11 and macOS, is the way to bring it and any other add-ons in. | Decided by Wagner Brahm, 1.2.0 |
16 changes: 14 additions & 2 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ what comes after 1.0. The decisions that shaped it are in the

## Where we are

**1.1.0, published on 2026-10-29, ready on Linux, Windows 11 and macOS.**
**1.2.0, published on 2026-10-30, on Linux, Windows 11 and macOS**, is
the first release of step 4: Import Add-ons… imports every add-on in a
folder at once, and the Community Add-ons Collection comes as one `.zip`
for it, replacing the Linux add-ons installer (decision P31).
**1.1.0, published on 2026-10-29, was ready on Linux, Windows 11 and macOS.**
The macOS version went through a beta (1.1.0-beta1) on Wagner Brahm's
Mac, where it worked as it should, and ships with the other two as 1.1.0
(decision P30). 1.0.1, published on 2026-10-27, brought the Windows 11
Expand Down Expand Up @@ -90,6 +94,7 @@ taken out of scope.
| 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 |
| 1.1.0 | 2026-10-29 | macOS, as a `.dmg` for Apple Silicon |
| 1.2.0 | 2026-10-30 | Import Add-ons…, the Community Add-ons Collection as a `.zip` |

## After 1.0

Expand Down Expand Up @@ -643,7 +648,7 @@ The phases run in order:

Done on 2026-10-29 with 1.1.0.

### Step 4: new features, and independence from the original
### Step 4: new features, and independence from the original (in progress)

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 @@ -669,6 +674,13 @@ starts, from Wagner Brahm's ideas and the users' requests; this is the direction
Needs Wagner Brahm: the list of features for each release, and how far
independence goes (step 4.3).

Released so far:

- **1.2.0** (2026-10-30): Import Add-ons… imports a folder of add-ons, with
its subfolders and ZIP archives, in one go, with a backup, the pictures
and a log; the Community Add-ons Collection ships as a `.zip` for it, and
the Linux add-ons installer is gone (decision P31).

## Decisions pending

- Confirming the Windows beta (step 2).
Expand Down
Binary file modified docs/screenshots/character.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/screenshots/editor.png
Binary file not shown.
Binary file modified docs/screenshots/encounter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/import-addons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/monster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/new-character.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/screenshots/npc.png
Binary file not shown.
Binary file removed docs/screenshots/package.png
Binary file not shown.
Binary file modified docs/screenshots/sheet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/windows/character.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/screenshots/windows/editor.png
Binary file not shown.
Binary file modified docs/screenshots/windows/encounter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/screenshots/windows/help.png
Binary file not shown.
Binary file added docs/screenshots/windows/import-addons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/windows/monster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/windows/new-character.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/screenshots/windows/npc.png
Binary file not shown.
Binary file removed docs/screenshots/windows/package.png
Binary file not shown.
Binary file modified docs/screenshots/windows/sheet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/screenshots/windows/treasure.png
Binary file not shown.
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.1.0
_tag=v1.1.0
pkgver=1.2.0
_tag=v1.2.0
pkgrel=1
pkgdesc='Browse and edit AD&D Core Rules 2.0 characters and rules'
arch=('x86_64')
Expand Down
Loading
Loading