Skillbooks: Stats

<p style="text-align: center;"><img src="https://raw.githubusercontent.com/soundbyter/skillbooks-stats/main/docs/images/logo.png" alt="Skillbooks: Stats" width="280" /></p> <h1>Skillbooks: Stats</h1> <p>Skillbooks: Stats does for stat-modifying traits what <a href="https://mods.vintagestory.at/show/mod/64127" target="_blank" rel="noopener">Skillbooks Core</a> does for crafting traits: every trait that grants a stat bonus - walkspeed, damage, drop rates, and so on - gets its own lore-styled book, generated automatically when the server starts. Reading one permanently grants the trait it teaches.</p> <p><strong>Works entirely on its own.</strong> Skillbooks core is not required. If it's also installed, Stats detects it automatically and shares its trait registry and flavour text instead of duplicating anything, but neither mod ever forces the other to exist.</p> <h2>Known Compatibility Issues</h2> <ul> <li><span style="text-decoration: line-through;"><strong><a href="https://mods.vintagestory.at/show/mod/247" target="_blank" rel="noopener">XSkills</a></strong> (1.21) - All books register as aged books and give no boosts. This is likely due to the game version: Skillbooks is developed and tested for 1.22, so adding compatibility for 1.21 would mean developing backwards. If this is something you want, let me know in the comments. In the meantime, the <a href="https://mods.vintagestory.at/show/mod/44074" target="_blank" rel="noopener">XSkills fork</a> should work.</span>&nbsp;<strong>As of v0.6.0, xskills skillbooks should no longer have issues.</strong></li> </ul> <p>Found another conflict? Please <a href="https://github.com/soundbyter/skillbooks-stats/issues" target="_blank" rel="noopener">open an issue on GitHub</a> with which mod and what you're seeing.</p> <h2>How it works</h2> <p>At server start, Skillbooks: Stats scans every trait your mods define for a non-empty stat-modifier block and generates a book for each one it finds, including traits added by other class mods. Install a new class mod, restart the server, and its stat traits already have books waiting to be found.</p> <p style="text-align: center;"><img src="https://raw.githubusercontent.com/soundbyter/skillbooks-stats/main/docs/images/tooltip-preview.png" alt="A Skillbooks: Stats book's in-game tooltip, showing the trait it grants and its exact effects" /></p> <h2>Features</h2> <ul> <li><strong>Dynamic discovery.</strong> No per-trait setup. New stat traits from other mods pick up books automatically.</li> <li><strong>Curated flavour text</strong>&nbsp;for every supported trait, whether or not core is installed.</li> <li><strong>Tooltips show exactly what you're getting.</strong> Which trait, and its precise stat effects.</li> <li><strong>Negative traits excluded by default</strong>&nbsp;(configurable). Reading a book is framed as a reward, so a pure downside showing up in that pool would be a mismatch most players won't expect. Mixed traits (tradeoffs, not pure downsides) stay included either way.</li> <li><strong>Vessel loot and trader offers</strong>, each independently configurable.</li> </ul> <h2>Traits with curated flavour</h2> <p>Every vanilla stat trait, plus every stat trait from these class mods, has hand-written flavour text rather than the procedural fallback:</p> <ul> <li><strong>Vanilla</strong> (11 traits)</li> <li><strong>Aldi's Classes</strong>&nbsp;(59 traits)</li> <li><strong>Rustbound Magic</strong> (4 traits)</li> </ul> <p>A trait from any other installed mod still gets a book automatically (see "How it works" above), just with a plainer procedural description until flavour's written for it either here or by the mod's own author (see "Making a class mod?" below).</p> <h2>Configuration</h2> <p>A config file is generated on first run with control over:</p> <ul> <li>Loot spawn chance and which block codes can drop a book</li> <li>Trader spawn chance, which trader types offer books, and their price</li> <li>An allowlist or blacklist to include or exclude specific traits</li> <li>Whether negative-typed traits are included</li> </ul> <h2>Making a class mod?</h2> <p>Stats discovers your stat traits automatically, but if you'd rather write your own flavour text for your own trait's book instead of using the procedural fallback, just ship a file at <code>assets/&lt;yourmoddomain&gt;/config/skillbooksstats/&lt;traitcode&gt;.json</code> in your own mod:</p> <pre><code>{ "title": "Your Book's Title", "blurb": "The in-world description shown when the book is read or inspected." }</code></pre> <p>That one file takes priority over the curated list and works the same whether or not Skillbooks core happens to be installed on a given server; no need to coordinate with this repo, and no need to duplicate the file anywhere else.</p> <h2>Part of a family</h2> <p>Stats is the standalone addon to <a href="https://mods.vintagestory.at/show/mod/64127" target="_blank" rel="noopener">Skillbooks Core</a>, which does the same thing for crafting traits. Install either on its own, or both together for the full set.</p> <h2>Open source</h2> <p>Skillbooks: Stats is developed in the open under the GPL-3.0 license. Source, issue tracker, and releases are all on <a href="https://github.com/soundbyter/skillbooks-stats" target="_blank" rel="noopener">GitHub</a>. Bug reports, feature requests, and pull requests are welcome, see <a href="https://github.com/soundbyter/skillbooks-stats/blob/main/CONTRIBUTING.md" target="_blank" rel="noopener">CONTRIBUTING.md</a> to get started.</p> <h2>AI Disclaimer</h2> <p>AI assistance has been used in the creation of flavour text for some of the books, documentation within the GitHub repository, comment writing within the codebase and repetitive tasks during development. The generated output was personally checked, modified and thoroughly tested by me for quality and accuracy and is subject to change at any time.</p>