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
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,11 +181,12 @@ content: keep it for your own use and do not redistribute it.

## Community add-ons

The [Core Rules Community Add-ons Collection](addons/README.md) gathers 686
The [Core Rules Community Add-ons Collection](addons/README.md) gathers 672
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
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), published on GitHub Packages as
[`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,
Expand Down
Binary file added addons/Comunidade-extras.xz
Binary file not shown.
Binary file modified addons/Comunidade.xpx.xz
Binary file not shown.
13 changes: 8 additions & 5 deletions addons/GUIA.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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.
Este pacote junta 672 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.525 itens. As 668 imagens que vieram com eles também são instaladas. Os goodies mensais da Evermore Entertainment ficaram de fora. 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.

Expand Down Expand Up @@ -56,28 +56,31 @@ Além de `latest`, cada versão do app tem a sua tag, como `0.7.2`.
| 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` |

O botão **Detalhes dos addons…** mostra, quando você quiser, cada pasta de addons com o que ela trouxe para a coleção e os textos que os autores escreveram.

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.
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. Tipos de monstro, monstros, raças e personagens mostram a imagem que veio com o addon. 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.
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 e os textos dos autores estão em inglê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.
5. Copia as imagens para onde os registros as procuram (`Bitmaps/Monsters`, `Bitmaps/Portrait` e `UserBMP`, e no Wine também as pastas do drive C: que os registros citam). Um arquivo que já existe não é substituído.

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:
Troque `UserDbas/` e `Chars/` pela cópia de segurança, pondo no lugar de `DATA` a data da cópia que quer usar. As imagens gravadas estão listadas no registro da instalação e podem ficar, já que nada as usa sem os addons:

```sh
cd ~/.local/share/corerules
Expand All @@ -89,4 +92,4 @@ 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.
O instalador é o crate `crates/cr-addons`, em Rust com GTK 4 e libadwaita. Ele embute `addons/Comunidade.xpx.xz` e `addons/Comunidade-extras.xz` (imagens e textos) 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.
67 changes: 49 additions & 18 deletions addons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@

The add-ons that the AD&D Core Rules community made for **AD&D Core Rules 2.0** and its **Expansion**, gathered into one
package and installed with one click into [Core Rules](../README.md), the
Linux replica of the original program. 686 add-on packages became 36,716
Linux replica of the original program. 672 add-on packages became 36,525
items: new races and classes, kits, thousands of spells and monsters,
equipment, encounters, the characters of the published modules and the
AD&D Core Rules User Database.
AD&D Core Rules User Database. The 668 pictures that came with them are
installed too, and the texts their authors wrote can be read in the
installer.

> This collection contains no TSR or Wizards of the Coast content. It holds
> only what the community wrote and shared as add-ons; the rules data still
> comes from a Core Rules installation you already own.
> The collection holds what the community wrote and shared as add-ons. It
> leaves out the monthly goodies that Evermore Entertainment, the company
> that made Core Rules 2.0, published in 1998–2000, and the copies of them
> in the User Database. The rules data still comes from a Core Rules
> installation you already own.

![The installer finds three copies of Core Rules and the two data folders they read](screenshots/installer.png)

Expand All @@ -26,29 +30,36 @@ the original program alike.
| --- | ---: |
| Wizard spells | 7,479 |
| Priest spells | 3,514 |
| Monsters | 5,315 |
| Monster types | 1,874 |
| Magical items | 2,376 |
| Weapons | 2,117 |
| Equipment | 1,587 |
| Monsters | 5,307 |
| Monster types | 1,871 |
| Magical items | 2,367 |
| Weapons | 2,112 |
| Equipment | 1,578 |
| Armor | 752 |
| Races | 515 |
| Races | 512 |
| Classes | 558 |
| Kits | 477 |
| Racial and class abilities | 5,456 |
| Racial and class abilities | 5,449 |
| Nonweapon proficiencies | 1,804 |
| Languages | 672 |
| Encounters and encounter templates | 674 |
| Encounters and encounter templates | 584 |
| Traps | 173 |
| Psionic powers | 160 |
| Traits and disadvantages | 253 |
| Spheres and schools of magic | 362 |
| Treasure bundles, gems, art and currencies | 336 |
| Characters from the modules | 105 |
| Characters from the modules | 48 |
| Other parts | 157 |

Once installed, the add-ons sit in the user databases next to your own
records, and the module characters join the character list.
records, and the module characters join the character list. Monster types,
races and characters show the picture their author drew or scanned, in the
app and in the original program.

<p>
<img src="screenshots/picture.png" width="49%" alt="The Achaierai, a monster type with its picture">
<img src="screenshots/portrait.png" width="49%" alt="Gerard Renier, a character with his portrait">
</p>

<p>
<img src="screenshots/class.png" width="49%" alt="The Anti-Paladin, one of the add-on classes">
Expand Down Expand Up @@ -94,7 +105,14 @@ with the data folder that copy reads:
Without that folder, a copy falls back to the original program in the Wine
prefix, as the app does. **Install** copies `UserDbas` and `Chars` to a
backup beside each folder, then imports the add-ons, in under a minute per
folder. **Other Folder…** is there for an installation it does not find.
folder. It also copies the pictures to where the records look for them
(`Bitmaps/Monsters`, `Bitmaps/Portrait` and `UserBMP` in the data folder,
and the folders on drive C: that the records name, inside Wine), never over
a file that is already there. **Other Folder…** is there for an
installation it does not find, and **Add-on Details…** lists every add-on
folder with what it brought into the collection and its authors' texts.

<img src="screenshots/details.png" width="49%" alt="Add-on Details, the add-on folders with their items and texts">

![The add-ons installed in both folders](screenshots/installed.png)

Expand All @@ -108,7 +126,8 @@ Core Rules' Preferences, or the system's.

**Testing every add-on.** The community's archive held 686 packages: 492
Expansion `.xpx` files and 194 Core Rules 2.0 `.xpt` files, including the
AD&D Core Rules User Database. Each one was read and written back byte for
AD&D Core Rules User Database. 14 of them were Evermore's monthly goodies,
which the collection leaves out. Each one was read and written back byte for
byte by this project's reader, and the doubtful ones were imported into the
original Expansion program under Wine.

Expand Down Expand Up @@ -136,7 +155,17 @@ failed.
the installer, `crates/cr-addons`, a Rust program with GTK 4 and
libadwaita that imports it through the same code as the app (`cr-store`),
in two passes so race and class combinations that name two new classes
come in. `packaging/appimage/build-in-sdk.sh VERSION addons` builds the
come in.

**Pictures and texts.** The 668 pictures (8-bit BMP files) and 309 texts
that came with the add-ons, again without Evermore's, are built into the
installer as `Comunidade-extras.xz`. Each picture goes to the place the
records name: a record stores the Windows path the picture had on its
author's computer (`C:\Program Files\AD&D Core Rules 2.0\Bitmaps\Monsters\
Achaierai.BMP`, `C:\AD&D Pics\troll.bmp`), and the app maps that path into
the data folder the same way (`cr-store`'s `pictures` module). The texts,
readme files in plain text, HTML, RTF, Word and PDF, were converted to plain
text. `packaging/appimage/build-in-sdk.sh VERSION addons` builds the
AppImage in the GNOME 51 SDK, and the `Addons package` workflow
(`.github/workflows/addons.yml`) publishes it on GitHub Packages on every
change to `main`.
Expand All @@ -146,6 +175,8 @@ change to `main`.
| File | Contents |
| --- | --- |
| `Comunidade.xpx.xz` | The consolidated add-ons, as built into the installer |
| `Comunidade-extras.xz` | The add-ons' pictures and texts, and where each picture goes |
| `tools/` | The scripts that chose each picture's place and built `Comunidade-extras.xz` |
| [`relatorio.md`](relatorio.md) | The report, in Portuguese: what was converted, repaired or left out |
| [`compatibilidade.csv`](compatibilidade.csv) | One line per add-on package, with its status and item count |
| [`conflitos.csv`](conflitos.csv) | The names found in more than one package, and which version stayed |
Expand Down
Loading
Loading