ravenous_roll20/README.md

95 lines
3.7 KiB
Markdown

# Ravenous — feuille Roll20
![Version actuelle](https://assets.dandaedre.com/coverage/Ravenous/ravenous_roll20/main/version.svg)
![Tests CI](https://assets.dandaedre.com/coverage/Ravenous/ravenous_roll20/main/test.svg)
![Couverture Python](https://assets.dandaedre.com/coverage/Ravenous/ravenous_roll20/main/coverage.svg)
Feuille de personnage française pour jouer à Ravenous dans Roll20. Le dépôt
génère la feuille depuis les données épinglées du livre
[`ravenous_typst`](ravenous_typst), ainsi que deux outils web statiques pour
l'artisanat et les effets. La génération et les tests locaux sont automatisés ;
les comportements qui nécessitent encore une validation dans Roll20 sont suivis
dans [`TASKS.md`](TASKS.md).
## Prérequis
- Git, Python 3.11 ou plus récent et [`uv`](https://docs.astral.sh/uv/) ;
- une partie Roll20 acceptant une feuille personnalisée ;
- Node.js uniquement pour les simulations locales des workers et scripts Mod ;
- un abonnement Roll20 donnant accès aux scripts Mod pour les imports et
exports facultatifs.
## Installation rapide
Depuis la racine du dépôt :
```sh
git submodule update --init --recursive
./scripts/build.sh
```
Dans l'éditeur de feuille personnalisée Roll20, choisissez le mode CSE actuel,
laissez **Legacy Sanitization désactivé**, puis copiez :
- `build/ravenous.html` dans le panneau HTML ;
- `build/ravenous.css` dans le panneau CSS ;
- `build/translation.json` dans le panneau Traductions.
Ouvrez une fiche dans le Custom Sheet Sandbox. Le résultat attendu est une
feuille Ravenous à huit onglets avec caractéristiques calculées, compétences,
combat, santé, consommables, écoles, pouvoirs et suivi des effets.
## Utilisation
La fiche conserve ses valeurs dans les attributs Roll20. Les jets utilisent la
carte de chat Ravenous ; les actions **Défendre** et **Subir** demandent le token
du défenseur. Les dépenses, PV, intégrité d'armure et effets mécaniques restent
manuels.
- [Installer et utiliser la feuille dans Roll20](docs/roll20-usage.md)
- [Sauvegarder, importer et partager avec les scripts Mod](docs/mod-scripts.md)
- [Copier les macros Roll20 prêtes à l'emploi](docs/macros.md)
- [Utiliser le format JSON d'artisanat](docs/craft-json-v1.md)
Les compagnons statiques publiés sont :
- l'[atelier d'artisanat](https://assets.dandaedre.com/ravenous_roll20/ravenous_craft/) ;
- la [bibliothèque d'effets](https://assets.dandaedre.com/ravenous_roll20/ravenous_effects/).
## Documentation
- [`FEATURES.md`](FEATURES.md) : comportement attendu et critères
d'acceptation ;
- [`ARCHITECTURE.md`](ARCHITECTURE.md) : attributs persistants, formats, flux et
frontières entre composants ;
- [`docs/development.md`](docs/development.md) : thèmes, tests, couverture, mise
à jour du livre et publication ;
- [`TASKS.md`](TASKS.md) : validations Roll20 effectuées et travail restant ;
- [`AGENTS.md`](AGENTS.md) : règles de contribution et matrice complète de
vérification.
## Développement
Les commandes courantes sont :
```sh
./scripts/build.sh
uv run python -m unittest discover -s tests -v
node tests/test_worker.mjs
./scripts/run-python-coverage.sh
./scripts/build.sh --check
```
La couverture des générateurs Python doit rester au-dessus du seuil de 85 %
défini dans `.coveragerc`. Consultez le
[guide de développement](docs/development.md) pour les suites des sites
compagnons, les autres tests Node et les contrôles déterministes.
## Licence et état du projet
Le code de ce dépôt est distribué sous [licence MIT](LICENSE). La feuille reste
une version de travail : les tests structuraux et les simulations locales ne
remplacent pas une validation dans une vraie partie Roll20. Les limites connues
et la procédure de signalement par reproduction sont consignées dans
[`TASKS.md`](TASKS.md).