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
1 change: 1 addition & 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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,10 @@ 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
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.

Expand Down
22 changes: 17 additions & 5 deletions addons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,26 @@ Além de `latest`, cada versão do app tem a sua tag, como `0.7.2`.

Sem FUSE, rode com `APPIMAGE_EXTRACT_AND_RUN=1`.

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`.
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. 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. 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 a pasta é uma instalação da Expansion.
2. Copia `UserDbas/` e `Chars/` para uma pasta ao lado, por exemplo `data-antes-dos-addons-20261019-010700/`.
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.

Expand All @@ -72,9 +82,11 @@ Troque `UserDbas/` e `Chars/` pela cópia de segurança, pondo no lugar de `DATA
```sh
cd ~/.local/share/corerules
rm -rf data/UserDbas data/Chars
cp -r data-antes-dos-addons-DATA/UserDbas data-antes-dos-addons-DATA/Chars data/
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.
1 change: 1 addition & 0 deletions crates/cr-addons/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ path = "src/main.rs"

[dependencies]
cr-formats.workspace = true
cr-i18n.workspace = true
cr-store.workspace = true
gtk = { package = "gtk4", version = "0.9", features = ["v4_14"] }
adw = { package = "libadwaita", version = "0.7", features = ["v1_5"] }
Expand Down
16 changes: 9 additions & 7 deletions crates/cr-addons/src/install.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use std::io;
use std::path::{Path, PathBuf};

use cr_formats::export::ExportFile;
use cr_i18n::tr;
use cr_store::Installation;
use cr_store::export::{Category, ImportReport, contents};

Expand Down Expand Up @@ -53,19 +54,19 @@ pub fn check(dir: &Path) -> Folder {
pub fn package() -> Result<ExportFile, String> {
let mut data = Vec::new();
lzma_rs::xz_decompress(&mut io::Cursor::new(PACKAGE), &mut data)
.map_err(|e| format!("Os addons embutidos estão corrompidos: {e}"))?;
ExportFile::parse(&data).map_err(|e| format!("Não consegui ler os addons embutidos: {e}"))
.map_err(|e| tr!("The built-in add-ons are damaged: {e}", e))?;
ExportFile::parse(&data).map_err(|e| tr!("Could not read the built-in add-ons: {e}", e))
}

/// Copies `UserDbas/` and `Chars/` into a folder beside the data folder;
/// returns that folder.
pub fn backup(install: &Installation, stamp: &str) -> Result<PathBuf, String> {
let to = beside(install.root(), &format!("antes-dos-addons-{stamp}"));
let to = beside(install.root(), &format!("before-addons-{stamp}"));
for name in ["UserDbas", "Chars"] {
if let Some(from) = install.path(name) {
let target = to.join(from.file_name().unwrap_or(name.as_ref()));
copy_dir(&from, &target)
.map_err(|e| format!("Não consegui copiar {}: {e}", from.display()))?;
.map_err(|e| tr!("Could not copy {folder}: {e}", folder = from.display(), e))?;
}
}
Ok(to)
Expand All @@ -88,7 +89,7 @@ pub fn import(install: &Installation, file: &ExportFile, stamp: &str) -> Result<
.filter(|&n| items[n].category != Category::Character)
.collect()
});
let failed = |e: cr_store::Error| format!("A importação falhou: {e}");
let failed = |e: cr_store::Error| tr!("The import failed: {e}", e);
let report = install.import(file, first.as_deref()).map_err(failed)?;
let classes: Vec<usize> = (0..items.len())
.filter(|&n| items[n].category == Category::Class)
Expand All @@ -97,10 +98,11 @@ pub fn import(install: &Installation, file: &ExportFile, stamp: &str) -> Result<

let mut log = String::new();
write_report(&mut log, &report);
log.push_str("=== segunda passagem (classes)\n");
log.push_str("=== second pass (classes)\n");
write_report(&mut log, &second);
let path = beside(install.root(), &format!("addons-{stamp}.log"));
fs::write(&path, log).map_err(|e| format!("Não consegui gravar {}: {e}", path.display()))?;
fs::write(&path, log)
.map_err(|e| tr!("Could not write {file}: {e}", file = path.display(), e))?;
if let Some(userdbas) = install.path("UserDbas") {
let _ = fs::write(userdbas.join(MARKER), stamp);
}
Expand Down
Loading
Loading