Relic statistics

Tracks and displays how much value each relic provides in a single game of your game. Statistical descriptions are attached to the relic's hover tooltip, showing information such as total damage, number of cards drawn, gold earned, healing amount, and more—by relic, per game.

Slay the Spire 2 Relic Statistics

✨ Module Introduction

This module can **track and display** how much value each relic has created for you during your single game journey! Just hover your mouse over any relic to see detailed statistics in real time, such as:

• **Total Damage Output** 💥
• **Number of cards drawn** 🃏
• **Gold Coins Obtained** 💰
• **Block Value Obtained** 🛡️
• **Amount of healing received** ❤️‍🩹

Currently, it supports tracking 183 out of 290 relics, and provides detailed data breakdown for each turn and each battle.

---

🚀 Main functions

• **📊 Automatic Stat Tracking**: All tracked relics will automatically accumulate statistics as you play, without any manual configuration.
• **🔍 Seamless prompt integration**: Statistics are displayed directly in the hover prompt box of the relic, clearly showing the total value, average value per round and average value per battle.
• **💾 Save Persistence**: Statistics are saved along with your game progress and perfectly restored when you continue playing.
• **🛠️ Extensive relic coverage**: Covers various statistical types such as block, damage, energy, card draw, gold coins, and treatment. Even complex relics like the **Philosopher's Stone**, **Eye of Chaos**, and **Fountain Pen Nib** can track multiple values.
• **🎮 ZERO GAMEPLAY IMPACT**: A purely informational overlay that **does not affect** any gameplay, card rewards, or random number generation.
• **📜 Running History**: View the performance of your relics in past games (this module must be installed when playing).

---

📥 Installation Guide

• **Download file**: Download the **Archive** file from the "File" tab (for test version games, please download the beta version, and for stable version games, please download the stable version).
• **Extract File**: Extract the ZIP file into your Slay the Spire 2 mods folder. If the folder does not exist, you may need to create it manually.
• **Example path**: `C:/Program Files (x86)/Steam/steamapps/common/Slay the Spire 2/mods`
• **Start Game**: Start the game. When you start a new game, stat tracking will start automatically!

---

⚙️ Prerequisites

• **BaseLib**: This is the required mod loader for Slay the Spire 2 mods.

---

🔧 Module Development API

If you are a modder and want to add stat support to the relics in your mod:

• **See the Github README**: Learn how to add stats to relics from other mods.
• **Nuget Packages**: Packages available to developers.

---

🐛 Bug Report

If you encounter a problem, please include a copy of your log file when reporting it.

• **Windows system**: The log is located at `%APPDATA%/SlayTheSpire2/logs`
• **Mac system**: The log is located at `$HOME/Library/Application Support/SlayTheSpire2/logs`

---

🙏 Special thanks

• **ForgottenArbiter**: Created the Relic Stats module for the original Slay the Spire, which inspired this project.
• **Alchyr**: Developed BaseLib and built STS2's mod ecosystem.