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

# 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.
# Builds Core Rules Community Add-ons Collection, one self-installing
# 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.
on:
push:
branches: [main]
Expand Down Expand Up @@ -43,9 +44,9 @@ jobs:
- name: Check the AppImage
run: |
cd target/AppDir
test -x usr/bin/corerules-addons
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-Addons-*.AppImage
ls -l "$GITHUB_WORKSPACE"/dist/CoreRules-Community-Addons-*.AppImage
- if: github.event_name != 'pull_request'
uses: oras-project/setup-oras@v1
- if: github.event_name != 'pull_request'
Expand All @@ -55,9 +56,9 @@ jobs:
owner=$(echo "$GITHUB_REPOSITORY_OWNER" | tr '[:upper:]' '[:lower:]')
echo "${{ secrets.GITHUB_TOKEN }}" | oras login ghcr.io -u "${{ github.actor }}" --password-stdin
cd dist
oras push "ghcr.io/$owner/corerules-addons:$version,latest" \
oras push "ghcr.io/$owner/corerules-community-addons:$version,latest" \
--artifact-type application/vnd.corerules.addons \
--annotation "org.opencontainers.image.source=https://github.com/${GITHUB_REPOSITORY}" \
--annotation "org.opencontainers.image.description=Instalador dos addons da comunidade para o Core Rules Expansion" \
--annotation "org.opencontainers.image.description=Core Rules Community Add-ons Collection: 686 community add-ons for AD&D Core Rules 2.0 Expansion, in one self-installing AppImage" \
--annotation "org.opencontainers.image.version=$version" \
"CoreRules-Addons-$version-x86_64.AppImage:application/vnd.appimage"
"CoreRules-Community-Addons-$version-x86_64.AppImage:application/vnd.appimage"
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,19 +181,17 @@ content: keep it for your own use and do not redistribute it.

## Community add-ons

[`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. They ship as a
self-installing app, a single AppImage with the add-ons inside
The [Core Rules Community Add-ons Collection](addons/README.md) gathers 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
36,716 items. It ships as its own self-installing AppImage
(`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 installer finds the app on its own,
whether it came as the Flatpak, the .deb or .rpm package or an AppImage, and
installs into the data folder that copy reads; it speaks the app's six
languages and follows the one chosen in its Preferences. The [guide](addons/README.md), which says
how to download and use it, and the [report](addons/relatorio.md) are in
Portuguese.
[`corerules-community-addons`](https://github.com/brahm/corerules/pkgs/container/corerules-community-addons),
and needs the app 0.7.2 or newer. The installer finds the app on its own,
whether it came as the Flatpak, the .deb or .rpm 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.

## Testing against your own installation

Expand All @@ -214,7 +212,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 |
| `cr-addons` | Core Rules Community Add-ons Collection, the add-ons and their installer |

The backend crates have no GTK dependency so macOS and Windows front ends
can reuse them later.
Expand Down
92 changes: 92 additions & 0 deletions addons/GUIA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Core Rules Community Add-ons Collection: guia de instalação

Este pacote junta 686 addons feitos pela comunidade para o AD&D Core Rules 2.0 e a Expansion: raças, classes, kits, magias, monstros, equipamentos, encontros, módulos com personagens e a AD&D Core Rules User Database. Todos foram testados, convertidos para o formato da Expansion e consolidados num único arquivo, `Comunidade.xpx`, com 36.716 itens. O [README](README.md) apresenta a coleção, em inglês, e o [relatorio.md](relatorio.md) conta o que foi convertido, reparado ou deixado de fora.

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-Community-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 instalador é 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. Baixe com o [ORAS](https://oras.land):

```sh
oras pull ghcr.io/brahm/corerules-community-addons:latest
```

Ou só com `curl`:

```sh
repo=brahm/corerules-community-addons
token=$(curl -s "https://ghcr.io/token?scope=repository:$repo:pull" | sed 's/.*"token":"\([^"]*\)".*/\1/')
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 CoreRules-Community-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`.

## Instalação

1. Torne o arquivo executável e abra-o:

```sh
chmod +x CoreRules-Community-Addons-*-x86_64.AppImage
./CoreRules-Community-Addons-*-x86_64.AppImage
```

Sem FUSE, rode com `APPIMAGE_EXTRACT_AND_RUN=1`.

2. A janela procura o Core Rules sozinha e mostra cada cópia que achou, com a pasta de dados que ela lê:

| Como o app foi instalado | Pasta de dados |
| --- | --- |
| Flatpak | `~/.var/app/io.github.brahm.CoreRules/data/corerules/data` |
| Pacote .deb ou .rpm | `~/.local/share/corerules/data` |
| AppImage (em Downloads, Aplicativos, Área de Trabalho, `~/.local/bin`, `/opt` ou a pasta pessoal) | `~/.local/share/corerules/data` |

Sem essa pasta, cada cópia usa a instalação do programa original no Wine, em `~/.wine/drive_c/Program Files/AD&D Core Rules 2.0`, como o próprio app faz. Se a cópia ainda não tem os dados do jogo, o botão **Abrir o Core Rules** a abre para você usar **Extrair dados do CD…**; depois clique em ↻ para procurar de novo. Para instalar numa pasta que o instalador não achou, use **Outra pasta…** e indique a pasta que tem `Database`.

3. Clique em **Instalar**. A importação leva menos de um minuto.

4. Abra o Core Rules, pelo botão **Abrir o Core Rules** ou como de costume. 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.

A janela fala os mesmos idiomas do app (português, inglês, espanhol, italiano, francês e alemão) e segue o que foi escolhido nas Preferências do Core Rules; sem escolha, segue o idioma do sistema. Os addons em si continuam em português.

## O que o instalador faz

1. Confere se cada pasta é uma instalação da Expansion. Quando duas cópias do app leem a mesma pasta, ela recebe os addons uma vez só.
2. Copia `UserDbas/` e `Chars/` para uma pasta ao lado, por exemplo `data-before-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.

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.

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

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
cp -r data-before-addons-DATA/UserDbas data-before-addons-DATA/Chars data/
```

No Flatpak, a pasta é `~/.var/app/io.github.brahm.CoreRules/data/corerules`.

## Como o instalador é gerado

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.
Loading
Loading