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
59 changes: 30 additions & 29 deletions .github/workflows/addons.yml
Original file line number Diff line number Diff line change
@@ -1,62 +1,63 @@
name: Addons package

# Builds the community add-ons package (packaging/addons/build.sh) and, on
# main or by hand, publishes it on GitHub Packages as the OCI artifact
# ghcr.io/<owner>/corerules-addons, tagged with the app version and latest.
# Builds the add-ons installer, one 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-addons, tagged with
# the app version and latest.
on:
push:
branches: [main]
paths:
- 'addons/**'
- 'packaging/addons/**'
- 'packaging/extract-data.sh'
- 'crates/cr-addons/**'
- 'data/addons/**'
- 'packaging/appimage/**'
- '.github/workflows/addons.yml'
pull_request:
paths:
- 'addons/**'
- 'packaging/addons/**'
- 'packaging/extract-data.sh'
- 'crates/cr-addons/**'
- 'data/addons/**'
- 'packaging/appimage/**'
- '.github/workflows/addons.yml'
workflow_dispatch:

permissions:
contents: read
packages: write

env:
CARGO_TERM_COLOR: always

jobs:
package:
runs-on: ubuntu-24.04
container:
image: ghcr.io/flathub-infra/flatpak-github-actions:gnome-51
options: --privileged
steps:
- uses: actions/checkout@v4
- run: sudo apt-get update && sudo apt-get install -y musl-tools
- uses: dtolnay/rust-toolchain@stable
with:
targets: x86_64-unknown-linux-musl
- uses: Swatinem/rust-cache@v2
- run: packaging/addons/build.sh
- name: Check the package
# The checkout belongs to the runner's user; root inside the SDK
# sandbox has no capabilities to write there.
- run: chown -R "$(id -u):$(id -g)" "$GITHUB_WORKSPACE"
- id: v
run: echo "version=$(sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml | head -1)" >> "$GITHUB_OUTPUT"
- run: packaging/appimage/build-in-sdk.sh ${{ steps.v.outputs.version }} addons
- name: Check the AppImage
run: |
tmp=$(mktemp -d)
tar -xzf target/addons/addons-comunidade-expansion.tar.gz -C "$tmp"
cd "$tmp/addons-comunidade-expansion"
sha256sum -c SHA256SUMS
! ls ./*.AppImage 2>/dev/null
./instalar-addons.sh --help
cd target/AppDir
test -x usr/bin/corerules-addons
test -f usr/share/icons/hicolor/256x256/apps/io.github.brahm.CoreRules.Addons.png
ls -l "$GITHUB_WORKSPACE"/dist/CoreRules-Addons-*.AppImage
- if: github.event_name != 'pull_request'
uses: oras-project/setup-oras@v1
- if: github.event_name != 'pull_request'
name: Publish on GitHub Packages
run: |
version=$(sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml | head -1)
image=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/corerules-addons
version=${{ steps.v.outputs.version }}
owner=$(echo "$GITHUB_REPOSITORY_OWNER" | tr '[:upper:]' '[:lower:]')
echo "${{ secrets.GITHUB_TOKEN }}" | oras login ghcr.io -u "${{ github.actor }}" --password-stdin
cd target/addons
oras push "$image:$version,latest" \
cd dist
oras push "ghcr.io/$owner/corerules-addons:$version,latest" \
--artifact-type application/vnd.corerules.addons \
--annotation "org.opencontainers.image.source=https://github.com/${GITHUB_REPOSITORY}" \
--annotation "org.opencontainers.image.description=Addons da comunidade para o Core Rules Expansion, com o instalador" \
--annotation "org.opencontainers.image.description=Instalador dos addons da comunidade para o Core Rules Expansion" \
--annotation "org.opencontainers.image.version=$version" \
addons-comunidade-expansion.tar.gz:application/gzip
"CoreRules-Addons-$version-x86_64.AppImage:application/vnd.appimage"
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ jobs:
with:
components: clippy, rustfmt
- run: cargo fmt --check
- run: cargo clippy --all-targets -- -D warnings
- run: cargo test
- run: cargo clippy --workspace --all-targets -- -D warnings
- run: cargo test --workspace
42 changes: 42 additions & 0 deletions Cargo.lock

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

5 changes: 4 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[workspace]
resolver = "3"
members = ["crates/cr-i18n", "crates/cr-formats", "crates/cr-store", "crates/cr-cli", "crates/cr-gtk"]
members = ["crates/cr-i18n", "crates/cr-formats", "crates/cr-store", "crates/cr-cli", "crates/cr-gtk", "crates/cr-addons"]
# The add-ons installer carries 9 MB of add-ons; only its own AppImage
# builds it (cargo build -p cr-addons).
default-members = ["crates/cr-i18n", "crates/cr-formats", "crates/cr-store", "crates/cr-cli", "crates/cr-gtk"]

[workspace.package]
version = "0.7.2"
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,12 +174,13 @@ your own use and do not redistribute it.
[`addons/`](addons/README.md) holds 686 add-ons the community made for
Core Rules 2.0 and the Expansion (races, classes, kits, spells, monsters,
modules and the AD&D Core Rules User Database), converted to the
Expansion's format and consolidated into one file. The package, with that
file, an installer and the `cr` tool, is published on GitHub Packages as
Expansion's format and consolidated into one file. They ship as a
self-installing app, a single AppImage with the add-ons inside
(`crates/cr-addons`, GTK 4 and libadwaita), published on GitHub Packages as
[`corerules-addons`](https://github.com/brahm/corerules/pkgs/container/corerules-addons);
it needs the app 0.7.2 or newer. The [guide](addons/README.md), which says
how to download and install it, and the [report](addons/relatorio.md) are
in Portuguese.
how to download and use it, and the [report](addons/relatorio.md) are in
Portuguese.

## Testing against your own installation

Expand All @@ -200,6 +201,7 @@ CORERULES_DIR="$HOME/.wine/drive_c/Program Files/AD&D Core Rules 2.0" cargo test
| `cr-cli` | `cr` command for inspecting data |
| `cr-i18n` | Translations of the interface (`po/*.po`, built into the program) |
| `cr-gtk` | The GNOME app |
| `cr-addons` | The community add-ons installer, with the add-ons built in |

The backend crates have no GTK dependency so macOS and Windows front ends
can reuse them later.
Expand Down
72 changes: 26 additions & 46 deletions addons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,19 @@ Este pacote junta 686 addons feitos pela comunidade para o AD&D Core Rules 2.0 e

Mapas do Map Maker II e desenhos do Campaign Mapper não fazem parte do pacote, porque o app não trata desses programas.

## O instalador

Os addons são distribuídos num único arquivo, `CoreRules-Addons-VERSÃO-x86_64.AppImage`. Ele é um programa com janela que leva os addons dentro dele e os instala no Core Rules, sem script nem outros arquivos.

O que é preciso:

* Linux x86-64 com glibc 2.43 ou mais nova (Fedora 44, Ubuntu 26.04 ou mais novos).
* O app Core Rules 0.7.2 ou mais novo, da [página de releases](https://github.com/brahm/corerules/releases). Até a versão 0.7.1 o app não lia parte destes addons: classes com habilidades por nível (`CClassFreeSpellsOb`) e o que a Expansion com patch grava.
* Os dados da sua Expansion no app. Se ainda não tiver, abra o Core Rules e use **Extrair dados do CD…** no menu.

## Onde baixar

O pacote é publicado no GitHub Packages do projeto, como [`corerules-addons`](https://github.com/brahm/corerules/pkgs/container/corerules-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. Baixe com o [ORAS](https://oras.land):
O instalador é publicado no GitHub Packages do projeto, como [`corerules-addons`](https://github.com/brahm/corerules/pkgs/container/corerules-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. Baixe com o [ORAS](https://oras.land):

```sh
oras pull ghcr.io/brahm/corerules-addons:latest
Expand All @@ -21,80 +31,50 @@ layer=$(curl -s -H "Authorization: Bearer $token" \
-H "Accept: application/vnd.oci.image.manifest.v1+json" \
"https://ghcr.io/v2/$repo/manifests/latest" |
grep -o '"digest":"sha256:[0-9a-f]*"' | tail -n 1 | cut -d'"' -f4)
curl -L -H "Authorization: Bearer $token" -o addons-comunidade-expansion.tar.gz \
curl -L -H "Authorization: Bearer $token" -o CoreRules-Addons-x86_64.AppImage \
"https://ghcr.io/v2/$repo/blobs/$layer"
```

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

## O que vem no pacote

`addons-comunidade-expansion.tar.gz` traz:

| arquivo | para que serve |
|---|---|
| `Comunidade.xpx` | os addons consolidados, no formato da Expansion |
| `instalar-addons.sh` | importa os addons no pacote de dados do app |
| `bin/cr` | a ferramenta de linha de comando que o instalador usa (binário estático, roda em qualquer Linux x86-64) |
| `extract-data.sh` | cria o pacote de dados a partir da sua instalação do Core Rules |
| `README.md`, `relatorio.md`, `compatibilidade.csv`, `conflitos.csv` | este guia e o relatório por addon |
| `SHA256SUMS` | as somas de verificação |

O aplicativo não vem no pacote. Instale o Core Rules 0.7.2 ou mais novo pela [página de releases](https://github.com/brahm/corerules/releases) (.deb, .rpm, Flatpak ou AppImage). Até a versão 0.7.1 o app não lia parte destes addons: classes com habilidades por nível (`CClassFreeSpellsOb`) e o que a Expansion com patch grava.

## O que é preciso

* Linux x86-64.
* O app Core Rules 0.7.2 ou mais novo.
* Uma instalação sua do AD&D Core Rules 2.0 Expansion, no Wine ou copiada do CD. Os addons não trazem as regras.

## Instalação

1. Abra o pacote:

```sh
tar -xzf addons-comunidade-expansion.tar.gz
cd addons-comunidade-expansion
```

2. Crie o pacote de dados do app a partir da sua instalação, se ainda não tiver um. Ele fica em `~/.local/share/corerules/data`.
1. Torne o arquivo executável e abra-o:

```sh
./extract-data.sh --install "$HOME/.wine" # Core Rules instalado no Wine
./extract-data.sh --install /caminho/do/Program # ou a pasta que tem Database/
chmod +x CoreRules-Addons-*-x86_64.AppImage
./CoreRules-Addons-*-x86_64.AppImage
```

3. Instale os addons:
Sem FUSE, rode com `APPIMAGE_EXTRACT_AND_RUN=1`.

```sh
./instalar-addons.sh
```
2. A janela mostra a pasta de dados que o Core Rules usa, normalmente `~/.local/share/corerules/data`. Para outra instalação da Expansion, como a do programa original no Wine, clique em **Escolher…** e indique a pasta que tem `Database`.

Para outra instalação da Expansion, informe a pasta: `./instalar-addons.sh /caminho/da/instalacao`.
3. Clique em **Instalar**. A importação leva menos de um minuto.

4. Abra o app. Os addons aparecem nos bancos de dados do usuário (Raças, Classes, Magias, Monstros e o resto) e os personagens dos módulos na lista de personagens.
4. Abra o Core Rules. Os addons aparecem nos bancos de dados do usuário (Raças, Classes, Magias, Monstros e o resto) e os personagens dos módulos na lista de personagens. Se o app já estava aberto, feche e abra de novo.

## O que o instalador faz

1. Confere se a pasta é uma instalação da Expansion.
2. Guarda `UserDbas/` e `Chars/` num `.tar.gz` ao lado da pasta, por exemplo `data-antes-dos-addons-20261017-230000.tar.gz`.
2. Copia `UserDbas/` e `Chars/` para uma pasta ao lado, por exemplo `data-antes-dos-addons-20261019-010700/`.
3. Importa o `Comunidade.xpx`. Um registro do usuário com o mesmo nome de um addon é substituído pelo do addon, como no Import do programa original.
4. Importa de novo só as classes. Uma combinação raça/classe que cita duas classes novas só entra quando as duas já existem.

Um registro do log fica ao lado da pasta. Os avisos "No race/class combinations could be added" da primeira passagem são esperados, porque a segunda passagem resolve todos eles.
O registro da importação fica ao lado da pasta, como `data-addons-20261019-010700.log`, e o botão **Abrir o registro** o mostra no fim.

Rodar o instalador de novo não duplica os personagens. Se a pasta estiver dentro de um prefixo do Wine, ele pede confirmação antes de mexer; o programa original do CD também lê o `Comunidade.xpx`, mas a leitura no original leva cerca de 35 minutos.
Instalar de novo não duplica os personagens. Se a pasta estiver dentro de um prefixo do Wine, o instalador pede confirmação antes de mexer. O programa original do CD também lê os addons, mas o Import dele leva cerca de 35 minutos.

## Como desfazer

Apague `UserDbas/` e `Chars/` da pasta de dados e extraia a cópia de segurança no lugar:
Troque `UserDbas/` e `Chars/` pela cópia de segurança, pondo no lugar de `DATA` a data da cópia que quer usar:

```sh
cd ~/.local/share/corerules
rm -rf data/UserDbas data/Chars
tar -xzf data-antes-dos-addons-*.tar.gz -C data
cp -r data-antes-dos-addons-DATA/UserDbas data-antes-dos-addons-DATA/Chars data/
```

## Como o pacote é gerado
## Como o instalador é gerado

`packaging/addons/build.sh` monta o pacote a partir de `addons/Comunidade.xpx.xz` e do `cr` compilado deste repositório. O workflow `Addons package` (`.github/workflows/addons.yml`) roda esse script e publica o resultado no GitHub Packages a cada mudança na main. O instalador fica em `packaging/addons/instalar-addons.sh`.
O instalador é o crate `crates/cr-addons`, em Rust com GTK 4 e libadwaita. Ele embute `addons/Comunidade.xpx.xz` e importa pelo mesmo código do app (`cr-store`). `packaging/appimage/build-in-sdk.sh VERSÃO addons` gera a AppImage no SDK do GNOME 51, e o workflow `Addons package` (`.github/workflows/addons.yml`) a publica no GitHub Packages a cada mudança na main.
9 changes: 5 additions & 4 deletions addons/relatorio.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

O `addons.zip` (50.842.950 bytes) traz 686 pacotes: 492 `.xpx` da Expansion e 194 `.xpt` do Core Rules 2.0, contando a User Database e os dois arquivos que precisaram de conserto. Todos foram consolidados num único pacote, `Comunidade.xpx`, no formato que o `TSRP3.EXE` do CD da Expansion lê.

O pacote `addons-comunidade-expansion.tar.gz` e como instalá-lo estão no [README.md](README.md). Junto deste relatório:
O instalador, que leva o `Comunidade.xpx` dentro dele, e como usá-lo estão no [README.md](README.md). Junto deste relatório:

| arquivo | conteúdo |
|---|---|
Expand Down Expand Up @@ -58,10 +58,11 @@ Algumas regras do Import do original se aplicam aqui:
* **Leitura e regravação:** os 686 pacotes, o consolidado incluído, são lidos e regravados byte a byte pelo leitor do projeto.
* **Original da Expansion no Wine:** o diálogo Import do original abriu o `Comunidade.xpx` e listou os itens. A leitura levou cerca de 35 minutos. O Import All não foi executado no original.
* **Edição no app Linux:** depois da instalação, cada registro dos addons foi aberto, editado e salvo pelos mesmos editores que o app usa, e relido depois. Foram 10.993 magias, 173 armadilhas, 160 poderes psiônicos, 1.874 tipos de monstro, 5.315 monstros, 515 raças, 558 classes, 16.290 partes, 59 tesouros, 299 encontros e os 105 personagens importados. Nenhum falhou. Regravar os bancos sem mudanças mantém os arquivos idênticos byte a byte. Salvar um registro pelo editor faz os mesmos ajustes do original, como tirar espaços do fim do nome. Dez registros têm o nome de um registro padrão: seis classes ("Fighter", "Cleric", "Mage", "Illusionist", "Ranger" e "Thief"), três magias e uma raça. O app recusava salvá-los e agora aceita, desde que o nome continue o mesmo.
* **Script de instalação:** testado numa cópia limpa do pacote de dados.
* Importou 36.716 itens e 105 personagens em cerca de 40 segundos.
* **Instalador:** a AppImage foi testada numa cópia limpa do pacote de dados.
* Importou 36.716 itens, 105 deles personagens, em menos de um minuto.
* A segunda passagem terminou sem nenhum aviso.
* Rodar o script de novo não duplica personagens nem altera os registros, a não ser por 4 combinações de raças cujo nome se repete no pacote.
* Os bancos do usuário ficaram idênticos byte a byte aos que o antigo script de instalação gravava.
* Instalar de novo não duplica personagens nem altera os registros, a não ser por 4 combinações de raças cujo nome se repete no pacote.

## Imagens e documentação

Expand Down
19 changes: 19 additions & 0 deletions crates/cr-addons/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[package]
name = "cr-addons"
description = "Installer of the community add-ons for Core Rules"
version.workspace = true
edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true

[[bin]]
name = "corerules-addons"
path = "src/main.rs"

[dependencies]
cr-formats.workspace = true
cr-store.workspace = true
gtk = { package = "gtk4", version = "0.9", features = ["v4_14"] }
adw = { package = "libadwaita", version = "0.7", features = ["v1_5"] }
lzma-rs = "0.3"
Loading
Loading