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
70 changes: 55 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

# Core Rules

**Core Rules** is a complete Linux 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 with GTK 4 and libadwaita and runs natively, with no Wine
and no Windows. 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; see [Installing](#installing).
**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, where it is in a closed beta. See
[Installing](#installing).

Every screen of the original program is here: the Character Generator with
Create, Enter and Update Character, kits and Player's Option, the character
Expand All @@ -29,6 +31,28 @@ in the other.

![The character list with a character made in the original program](docs/screenshots/character.png)

### On Windows 11

The Windows 11 version has every screen of the Linux one, over the same
backend and the same data files, with the look of a Windows 11 app: the
navigation pane, command bars, settings cards, the system's light, dark
and high-contrast themes and the Mica backdrop. The help files of the
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">
</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">
</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">
</p>

## You need the original discs

This project contains no TSR or Wizards of the Coast content. The rules,
Expand Down Expand Up @@ -59,9 +83,11 @@ 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. **Windows 11 (in progress).** A Windows 11 version in this repository,
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. From then on every feature
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.
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
Expand Down Expand Up @@ -345,9 +371,9 @@ when and why each was decided.

### Platform and setup

- **Linux only, no Wine.** The app is a native GTK 4 program. A Windows 11
version is being made over the same backend, which is already built
and tested on Windows.
- **Linux and Windows 11, no Wine.** The app is a native GTK 4 program on
Linux and a native WinUI 3 program on Windows 11, over the same backend.
Windows 10 and older versions are not supported.
- **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
mounting) or an existing installation into a local data folder. The
Expand Down Expand Up @@ -500,6 +526,20 @@ and EndeavourOS; update the system (`sudo pacman -Syu`) before
installing it. Each release also has its `PKGBUILD`, which builds the
package from the release's source with `makepkg -si`.

### Windows 11

The Windows 11 version comes from the Microsoft Store, which signs the
package, so Windows and Smart App Control install it without warnings. It
is in a closed beta now; the link to its Store page will be here once it is
published. 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.

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.

### The Flatpak repository

The project has its own Flatpak repository, at
Expand Down Expand Up @@ -622,7 +662,7 @@ CORERULES_DIR="$HOME/.wine/drive_c/Program Files/AD&D Core Rules 2.0" cargo test
| `cr-app` | What both apps share above the backend, with no GTK and no Windows: the names of their actions, the library's search, filters and commands, the pictures, the help and About, the book reader's zoom, Find and reading positions, the sheet's options and exports, the sheet laid out on printed pages and the sheet as a PDF |
| `cr-gtk` | The GNOME app |
| `cr-addons` | Core Rules Community Add-ons Collection, the add-ons and their installer |
| `cr-win` | The Windows 11 app (WinUI 3 with windows-reactor), being ported screen by screen |
| `cr-win` | The Windows 11 app (WinUI 3 with windows-reactor), with every screen of the GNOME app |

The backend crates and `cr-app` have no GTK dependency, and CI builds and
tests them on Windows too, with `cr-win` and its MSIX package.
Expand Down Expand Up @@ -749,8 +789,8 @@ cargo run -p cr-gtk # the data package or the Win
cargo run -p cr-gtk -- "/media/cdrom" # or any folder with Database/
```

On Windows 11, with the Windows App Runtime 2.4 installed, the Windows app,
still being ported, runs with `cargo run -p cr-win`; it opens the data
On Windows 11, with the Windows App Runtime 2.4 installed, the Windows app
runs with `cargo run -p cr-win`; it opens the data
package in `Documents\Core Rules\data` or the original's installation.

## License
Expand Down
Binary file added 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 added docs/screenshots/windows/editor.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/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 added docs/screenshots/windows/help.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/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 added 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 added docs/screenshots/windows/npc.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/windows/package.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/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 added docs/screenshots/windows/treasure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 23 additions & 5 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@ <h1><img class="wordmark" src="logo/core-rules-1600.webp" srcset="logo/core-rule
<p class="tagline">The character manager and Dungeon Master's toolkit of 1998,<br>dusted off and brought back to the table.</p>
<div class="actions">
<a class="btn primary" href="#download">Download for Linux</a>
<a class="btn" href="#windows">Windows 11</a>
<a class="btn" href="#addons">Community Add-ons</a>
</div>
<p class="version">Version 1.0.0 · the first stable release</p>
<p class="version">Version 1.0.0 · the first stable release · Windows 11 in beta</p>
<p class="small">Free and open source · Requires your original AD&amp;D Core Rules discs</p>
</div>
<p class="art-caption"><cite>Knight at the Crossroads</cite>, Viktor Vasnetsov, 1882</p>
Expand Down Expand Up @@ -93,8 +94,8 @@ <h2 class="center">The original application</h2>
<div class="wrap">
<p class="eyebrow">The adventure, today</p>
<h2>Every screen of the original</h2>
<p class="lead">Written in Rust with GTK 4 and libadwaita, Core Rules runs natively on Linux, with no
Wine and no Windows. It has the Character Generator with Create, Enter and Update Character,
<p class="lead">Written in Rust, Core Rules runs natively on Linux with GTK 4 and libadwaita, with no
Wine, and on Windows 11 with WinUI 3. It has the Character Generator with Create, Enter and Update Character,
kits and Player's Option, the character sheet, parties, the NPC, treasure and encounter
generators, Table Rolls, editors for every user database, DM Toolkit packages, the rule books and
the help.</p>
Expand All @@ -109,6 +110,21 @@ <h2>Every screen of the original</h2>
<figure><a href="screenshots/treasure.png"><img src="screenshots/treasure.png" alt="Rolling treasure" loading="lazy"></a><figcaption>Treasure types A to Z</figcaption></figure>
<figure><a href="screenshots/package.png"><img src="screenshots/package.png" alt="A DM Toolkit package" loading="lazy"></a><figcaption>DM Toolkit packages, import and export</figcaption></figure>
</div>

<h3 id="windows">And on Windows 11</h3>
<p class="lead">The Windows 11 version has every screen of the Linux one, over the same backend and the
same files, with the look of a Windows 11 app: the navigation pane, command bars, settings cards, the
light, dark and high-contrast themes and the Mica backdrop. The help files of the discs open in the
app's own Help page, since Windows 11 no longer reads them. It comes from the Microsoft Store, where it
is in a closed beta.</p>
<div class="gallery">
<figure><a href="screenshots/windows/character.png"><img src="screenshots/windows/character.png" alt="The character list on Windows 11" loading="lazy"></a><figcaption>The character list on Windows 11</figcaption></figure>
<figure><a href="screenshots/windows/new-character.png"><img src="screenshots/windows/new-character.png" alt="Rolling ability scores in New Character on Windows 11" loading="lazy"></a><figcaption>New Character</figcaption></figure>
<figure><a href="screenshots/windows/sheet.png"><img src="screenshots/windows/sheet.png" alt="A character sheet on Windows 11" loading="lazy"></a><figcaption>The character sheet</figcaption></figure>
<figure><a href="screenshots/windows/monster.png"><img src="screenshots/windows/monster.png" alt="A red dragon in the library on Windows 11" loading="lazy"></a><figcaption>Monsters with their pictures</figcaption></figure>
<figure><a href="screenshots/windows/encounter.png"><img src="screenshots/windows/encounter.png" alt="An orc lair encounter on Windows 11" loading="lazy"></a><figcaption>Encounters from templates</figcaption></figure>
<figure><a href="screenshots/windows/help.png"><img src="screenshots/windows/help.png" alt="The Tome of Help on Windows 11" loading="lazy"></a><figcaption>The help and the Tome of Help</figcaption></figure>
</div>
</div>
</section>

Expand Down Expand Up @@ -154,7 +170,7 @@ <h2>Everything the original did</h2>
<article><h3>The library</h3><p>Races, classes, kits, items, spells, psionic powers and monsters, with their pictures and icons, and the Core Rules books in a reader with search.</p></article>
<article><h3>Faithful files</h3><p>Characters, monsters, encounters and packages made in either program open in the other. Results were compared with files the original wrote.</p></article>
<article><h3>Six languages</h3><p>English, Português (Brasil), Español, Italiano, Français and Deutsch.</p></article>
<article><h3>Any Linux</h3><p>.deb for Ubuntu, .rpm for Fedora, pacman for Arch, CachyOS and Omarchy, a Flatpak and an AppImage for Bazzite and every other distribution. A Windows 11 version comes next.</p></article>
<article><h3>Linux and Windows 11</h3><p>.deb for Ubuntu, .rpm for Fedora, pacman for Arch, CachyOS and Omarchy, a Flatpak and an AppImage for Bazzite and every other distribution, and the Microsoft Store for Windows 11.</p></article>
</div>
</div>
</section>
Expand All @@ -166,7 +182,7 @@ <h2>Everything the original did</h2>
<h2>Download Core Rules</h2>
<p class="callout">Version 1.0.0, the first stable release</p>
<p>Pick the file for your system; each link downloads it directly. Every file is for
x86-64 Linux.</p>
x86-64 Linux; Windows 11 comes from the Microsoft Store.</p>
<ul class="downloads">
<li><span class="system">Ubuntu 26.04 or newer</span><span class="kind">.deb</span>
<a class="file" href="https://github.com/brahm/corerules/releases/download/v1.0.0/corerules_1.0.0_amd64.deb">corerules_1.0.0_amd64.deb</a>
Expand All @@ -186,6 +202,8 @@ <h2>Download Core Rules</h2>
<li><span class="system">Community Add-ons, for any of the above</span><span class="kind">Installer</span>
<a class="file" href="https://github.com/brahm/corerules/releases/download/addons/CoreRules-Community-Addons-x86_64.AppImage">CoreRules-Community-Addons-x86_64.AppImage</a>
<code>chmod +x CoreRules-Community-Addons-x86_64.AppImage</code></li>
<li><span class="system">Windows 11</span><span class="kind">Microsoft Store</span>
<span class="file-soon">In a closed beta; the link to the Store page comes here once it is published.</span></li>
</ul>
<p class="tested"><span>Tested by players on</span> Fedora 45 beta · Ubuntu 26.10 · Bazzite · Arch Linux · CachyOS</p>
<p class="small">The Flatpak comes from this site's own Flatpak repository, signed by the project,
Expand Down
1 change: 1 addition & 0 deletions site/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ cite { font-style: italic; }
.downloads .kind { font-family: var(--display); font-size: 1rem; letter-spacing: .08em; color: var(--crimson); }
.downloads .file { grid-column: 1 / -1; font-weight: 600; overflow-wrap: anywhere; }
.downloads .file::before { content: "\2193\00a0"; }
.downloads .file-soon { grid-column: 1 / -1; font-style: italic; color: var(--ink-soft); }
.downloads code { grid-column: 1 / -1; justify-self: start; font-size: .8rem; color: var(--ink-soft); overflow-wrap: anywhere; }
.tested {
font-family: var(--display); font-size: 1.25rem; line-height: 1.35; color: var(--ink);
Expand Down
Loading