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
75 changes: 73 additions & 2 deletions .github/workflows/addons.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ name: Addons package
# AppImage with the add-ons inside (crates/cr-addons), and, on main or by
# hand, publishes it on GitHub Packages as the OCI artifact
# ghcr.io/<owner>/corerules-community-addons, tagged with the app version
# and latest, and on the release "addons", whose tag follows main: there
# and latest, and as the file itself in the Maven registry of GitHub
# Packages, and on the release "addons", whose tag follows main: there
# CoreRules-Community-Addons-x86_64.AppImage is always the newest, for a
# download link that does not change.
on:
Expand Down Expand Up @@ -49,6 +50,11 @@ jobs:
test -x usr/bin/corerules-community-addons
test -f usr/share/icons/hicolor/256x256/apps/io.github.brahm.CoreRules.Addons.png
ls -l "$GITHUB_WORKSPACE"/dist/CoreRules-Community-Addons-*.AppImage
- if: github.event_name != 'pull_request'
uses: actions/upload-artifact@v4
with:
name: addons-appimage
path: dist/CoreRules-Community-Addons-${{ steps.v.outputs.version }}-x86_64.AppImage
- if: github.event_name != 'pull_request'
uses: oras-project/setup-oras@v1
- if: github.event_name != 'pull_request'
Expand Down Expand Up @@ -97,7 +103,72 @@ jobs:

Direct link: https://github.com/${{ github.repository }}/releases/download/addons/CoreRules-Community-Addons-x86_64.AppImage

The same file is on GitHub Packages: `oras pull ghcr.io/${{ github.repository_owner }}/corerules-community-addons:latest`. The app itself is on the [Core Rules releases](https://github.com/${{ github.repository }}/releases).
The same file is on GitHub Packages twice: as a file, `corerules-community-addons-${{ steps.v.outputs.version }}-x86_64.AppImage`, in the Maven package `io.github.brahm.corerules-community-addons` ([the project's packages](https://github.com/${{ github.repository_owner }}?tab=packages&repo_name=${{ github.event.repository.name }})), and in the OCI package [`corerules-community-addons`](https://github.com/${{ github.repository }}/pkgs/container/corerules-community-addons): `oras pull ghcr.io/${{ github.repository_owner }}/corerules-community-addons:latest`. The app itself is on the [Core Rules releases](https://github.com/${{ github.repository }}/releases).
files: |
dist/CoreRules-Community-Addons-x86_64.AppImage
dist/CoreRules-Community-Addons-${{ steps.v.outputs.version }}-x86_64.AppImage

# GitHub Packages has no registry for plain files, and its container
# registry shows the AppImage as an OCI artifact. Its Maven registry keeps
# any file as it is, with its name and extension, and the package page
# lists it under Assets for download, so the AppImage goes there too, as
# io.github.brahm:corerules-community-addons:VERSION:x86_64@AppImage. A
# version is published once, since Maven versions cannot be replaced; a
# later build of the same version only replaces the other two copies.
maven:
needs: package
if: github.event_name != 'pull_request'
runs-on: ubuntu-24.04
permissions:
contents: read
packages: write
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
REGISTRY: https://maven.pkg.github.com/${{ github.repository }}
ARTIFACT: io/github/brahm/corerules-community-addons
steps:
- uses: actions/checkout@v4
- id: v
run: echo "version=$(sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml | head -1)" >> "$GITHUB_OUTPUT"
- uses: actions/download-artifact@v4
with:
name: addons-appimage
path: dist
# Writes ~/.m2/settings.xml with the server "github", which logs in
# as GITHUB_ACTOR with GITHUB_TOKEN.
- uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '21'
server-id: github
- id: exists
name: Look for this version on GitHub Packages
run: |
version=${{ steps.v.outputs.version }}
code=$(curl -s -o /dev/null -w '%{http_code}' -u "$GITHUB_ACTOR:$GITHUB_TOKEN" \
"$REGISTRY/$ARTIFACT/$version/corerules-community-addons-$version.pom")
echo "HTTP $code"
if [ "$code" = 200 ]; then
echo "::notice::corerules-community-addons $version is already in the Maven registry; it keeps its first build"
echo "found=true" >> "$GITHUB_OUTPUT"
fi
- if: steps.exists.outputs.found != 'true'
name: Publish the AppImage on GitHub Packages (Maven)
run: |
version=${{ steps.v.outputs.version }}
mvn -B --no-transfer-progress deploy:deploy-file \
-Durl="$REGISTRY" -DrepositoryId=github \
-Dfile="dist/CoreRules-Community-Addons-$version-x86_64.AppImage" \
-DgroupId=io.github.brahm -DartifactId=corerules-community-addons \
-Dversion="$version" -Dclassifier=x86_64 -Dpackaging=AppImage \
-DgeneratePom=true \
-DgeneratePom.description="Core Rules Community Add-ons Collection: 672 community add-ons for AD&D Core Rules 2.0 Expansion, in one self-installing AppImage"
- name: Check the published AppImage
run: |
version=${{ steps.v.outputs.version }}
curl -sSfL -u "$GITHUB_ACTOR:$GITHUB_TOKEN" -o published.AppImage \
"$REGISTRY/$ARTIFACT/$version/corerules-community-addons-$version-x86_64.AppImage"
sha256sum published.AppImage "dist/CoreRules-Community-Addons-$version-x86_64.AppImage"
if [ "${{ steps.exists.outputs.found }}" != true ]; then
cmp published.AppImage "dist/CoreRules-Community-Addons-$version-x86_64.AppImage"
fi
11 changes: 8 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,14 @@ jobs:
# supported release, and the app has to start and keep running in each
# interface language, with its texts in that language. Minimal
# containers lack the Mesa drivers every desktop has, so the tests add them.
# Ubuntu 26.10 and Fedora 45 are where users tested 1.0 before it was
# released (ubuntu:latest is the LTS, fedora:latest lags a release).
test-deb:
needs: deb
strategy:
fail-fast: false
matrix:
image: ['ubuntu:26.04', 'ubuntu:latest']
image: ['ubuntu:26.04', 'ubuntu:26.10', 'ubuntu:latest']
runs-on: ubuntu-24.04
container: ${{ matrix.image }}
env:
Expand Down Expand Up @@ -179,7 +181,7 @@ jobs:
strategy:
fail-fast: false
matrix:
image: ['fedora:44', 'fedora:latest']
image: ['fedora:44', 'fedora:45', 'fedora:latest']
runs-on: ubuntu-24.04
container: ${{ matrix.image }}
steps:
Expand Down Expand Up @@ -222,7 +224,7 @@ jobs:
strategy:
fail-fast: false
matrix:
image: ['fedora:44', 'ubuntu:26.04', 'fedora:latest', 'ubuntu:latest']
image: ['fedora:44', 'ubuntu:26.04', 'fedora:45', 'ubuntu:26.10', 'fedora:latest', 'ubuntu:latest']
runs-on: ubuntu-24.04
container: ${{ matrix.image }}
env:
Expand Down Expand Up @@ -275,4 +277,7 @@ jobs:
name: Core Rules ${{ needs.version.outputs.version }}${{ contains(needs.version.outputs.version, '-rc') && ' release candidate' || startsWith(needs.version.outputs.version, '0.') && ' beta' || '' }}
body_path: packaging/release-notes.md
prerelease: ${{ startsWith(needs.version.outputs.version, '0.') || contains(needs.version.outputs.version, '-') }}
# A final release becomes the repository's latest release, which
# the addons release never is.
make_latest: ${{ !startsWith(needs.version.outputs.version, '0.') && !contains(needs.version.outputs.version, '-') }}
files: dist/*
12 changes: 6 additions & 6 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-cli", "crates/cr-gtk"]

[workspace.package]
version = "1.0.0-rc2"
version = "1.0.0"
edition = "2024"
license = "MIT"
repository = "https://github.com/brahm/corerules"
Expand Down
79 changes: 52 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ 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.

> **Release candidate.** Version 1.0.0-rc2 is the release candidate for
> 1.0. Every feature was checked against the original programs and went
> through a full round of manual tests. It now needs real use: keep a copy
> of your `Chars` and `UserDbas` folders, and
> [report](https://github.com/brahm/corerules/issues) anything that is
> wrong or that works differently from the original.
> **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,
> 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 @@ -54,11 +54,11 @@ preserved by the Internet Archive:

## Status and roadmap

1. **Release candidate (now).** 1.0.0-rc2 goes to real users. Problems
found are fixed in further release candidates.
2. **1.0.** Once the release candidate is confirmed stable after the
testing period, the last one becomes the final 1.0: a faithful
replacement for the original program.
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
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
backend.
Expand Down Expand Up @@ -454,16 +454,32 @@ same:
## Installing

Every [release](https://github.com/brahm/corerules/releases) has
packages for x86-64 Linux. Release candidates are marked as pre-releases
on that page.
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:

| System | Package | Install |
| System | Download | Install |
| --- | --- | --- |
| Fedora 44 or newer | `.rpm` | `sudo dnf install ./corerules-*.rpm` |
| Ubuntu 26.04 or newer | `.deb` | `sudo apt install ./corerules_*_amd64.deb` |
| Arch Linux, CachyOS, Omarchy | `.pkg.tar.zst` | `sudo pacman -U ./corerules-*.pkg.tar.zst` |
| Any distribution | `.flatpak` | `flatpak install --user CoreRules-*.flatpak` |
| Any distribution (glibc 2.43+) | `.AppImage` | `chmod +x CoreRules-*.AppImage`, then run it |
| 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` |
| Any distribution with Flatpak, such as Bazzite | [`CoreRules-1.0.0.flatpak`](https://github.com/brahm/corerules/releases/download/v1.0.0/CoreRules-1.0.0.flatpak) | `flatpak install --user CoreRules-1.0.0.flatpak` |
| 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 |
| 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
[`PKGBUILD`](https://github.com/brahm/corerules/releases/download/v1.0.0/PKGBUILD)
of the pacman package and
[`SHA256SUMS`](https://github.com/brahm/corerules/releases/download/v1.0.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.0
packages replace 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),
Arch Linux and CachyOS (the pacman package). The release workflow also
installs and starts every package on clean Ubuntu 26.04 and 26.10,
Fedora 44 and 45, Arch Linux and CachyOS systems.

Ubuntu 24.04 and older releases are not supported: the `.deb` refuses to
install there, and the Flatpak is the way to run the app on them.
Expand Down Expand Up @@ -524,19 +540,28 @@ classes, kits, spells, monsters, modules and the AD&D Core Rules User
Database), converted to the Expansion's format and consolidated into
36,525 items, with the 668 pictures that came with them. Monster types,
monsters, races and characters show those pictures in the app. It ships as its own self-installing AppImage
(`crates/cr-addons`, GTK 4 and libadwaita):
[download it here](https://github.com/brahm/corerules/releases/download/addons/CoreRules-Community-Addons-x86_64.AppImage).
It is also on GitHub Packages as
(`crates/cr-addons`, GTK 4 and libadwaita), version 1.0.0 with the app:

**[Download CoreRules-Community-Addons-x86_64.AppImage](https://github.com/brahm/corerules/releases/download/addons/CoreRules-Community-Addons-x86_64.AppImage)**

This link always gives the newest build; the
[addons release](https://github.com/brahm/corerules/releases/tag/addons)
also keeps each version, such as
[`CoreRules-Community-Addons-1.0.0-x86_64.AppImage`](https://github.com/brahm/corerules/releases/download/addons/CoreRules-Community-Addons-1.0.0-x86_64.AppImage).
The same AppImage is on [GitHub Packages](https://github.com/brahm?tab=packages&repo_name=corerules)
twice: as the file itself in the Maven package
`io.github.brahm.corerules-community-addons`, whose page lists
`corerules-community-addons-1.0.0-x86_64.AppImage` for download, and as the
OCI artifact
[`corerules-community-addons`](https://github.com/brahm/corerules/pkgs/container/corerules-community-addons)
(`oras pull ghcr.io/brahm/corerules-community-addons:latest`), and needs the app 0.7.2 or newer. The installer finds the app on its own,
(`oras pull ghcr.io/brahm/corerules-community-addons:latest`). It needs the app 0.7.2 or newer. The installer finds the app on its own,
whether it came as the Flatpak, the .deb, .rpm or pacman package or an AppImage,
and speaks the app's six languages. Its [README](addons/README.md) says
what is inside, how it was built and how to install it.

## Reporting problems

This is a release candidate, and real use is what it needs now. Please
[open an issue](https://github.com/brahm/corerules/issues) for anything
Please [open an issue](https://github.com/brahm/corerules/issues) for anything
that crashes, saves something the original cannot open, or works
differently from the original in a way the list above does not mention.
Say which package you installed, which disc your data came from, and
Expand Down Expand Up @@ -638,8 +663,8 @@ flatpak-builder --user --install-deps-from=flathub --install build \
```

The Packages workflow in GitHub Actions builds all five, installs each one
on clean Ubuntu 26.04, Ubuntu latest, Fedora 44, Fedora latest, Arch Linux
and CachyOS containers and starts the app there once in each of its six languages,
on clean Ubuntu 26.04, 26.10 and latest, Fedora 44, 45 and latest, Arch
Linux and CachyOS containers and starts the app there once in each of its six languages,
checking that every text on screen is in that language
(`packaging/smoke-test.sh`). Pushing a `v*` tag, or running the workflow
with a tag, publishes them as a release; `packaging/release-notes.md` is its
Expand Down
7 changes: 5 additions & 2 deletions addons/GUIA.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ O que é preciso:

**[Baixe o instalador aqui](https://github.com/brahm/corerules/releases/download/addons/CoreRules-Community-Addons-x86_64.AppImage).** O link sempre traz a versão mais nova. A [release addons](https://github.com/brahm/corerules/releases/tag/addons) também guarda cada versão.

O mesmo arquivo é publicado no GitHub Packages do projeto, como [`corerules-community-addons`](https://github.com/brahm/corerules/pkgs/container/corerules-community-addons). É um artefato OCI, e não uma imagem de contêiner: o `docker pull` que a página do GitHub mostra não serve. Para baixar de lá, use o [ORAS](https://oras.land):
O mesmo arquivo é publicado no [GitHub Packages](https://github.com/brahm?tab=packages&repo_name=corerules) do projeto, de duas formas, porque o GitHub Packages não tem um registro para arquivos soltos:

* **Como o arquivo AppImage**, no pacote Maven `io.github.brahm.corerules-community-addons`. A página dele lista `corerules-community-addons-VERSÃO-x86_64.AppImage` em Assets, para baixar pelo navegador. Baixar desse registro pela linha de comando pede um token do GitHub, mesmo com o pacote público.
* **Como artefato OCI**, [`corerules-community-addons`](https://github.com/brahm/corerules/pkgs/container/corerules-community-addons), que baixa sem conta nenhuma. Ele guarda a AppImage como seu único arquivo, e não uma imagem de contêiner: o `docker pull` que a página do GitHub mostra não serve. Para baixar de lá, use o [ORAS](https://oras.land):

```sh
oras pull ghcr.io/brahm/corerules-community-addons:latest
Expand All @@ -37,7 +40,7 @@ curl -L -H "Authorization: Bearer $token" -o CoreRules-Community-Addons-x86_64.A
"https://ghcr.io/v2/$repo/blobs/$layer"
```

Além de `latest`, cada versão do app tem a sua tag, como `1.0.0-rc1`.
Além de `latest`, cada versão do app tem a sua tag, como `1.0.0`.

## Instalação

Expand Down
Loading
Loading