Create README.md for Ascend mod

Added detailed README for Ascend mod including features, attributes, knowledge system, controls, and configuration.
2025-11-12 14:03:27 +01:00
parent 1e78873768
commit 83d7eff83a
1 changed files with 55 additions and 0 deletions
@@ -0,0 +1,55 @@
+# Ascend
+
+**Ascend** is a soulslike RPG progression mod inspired by *Deepwoken*. 
+
+**The Mod is meant to be used alongside Iron's Spellbooks but can be used without it.**
+
+---
+
+## Features
+
+### Core Progression
+- **Ascend Levels** — Gain Ascend XP through combat, crafting, mining, and exploration.  
+- **Skill Points** — Every Ascend Level grants 15 points to invest in attributes.  
+- **Knowledge** — A rare currency earned from leveling up or slaying strong creatures; used for mystical interactions.
+
+### Attributes
+Each player has 10 upgradeable stats (max 100 points each):
+
+| Attribute | Effect |
+|------------|---------|
+| **Strength** | Increases melee damage, knockback, and armor penetration. |
+| **Agility** | Improves movement speed, evasion chance, and stealth. |
+| **Fortitude** | Increases maximum health and reduces knockback taken. |
+| **Intelligence** | Boosts mana, spell power, mana regen, and cooldown reduction (with *Iron’s Spells & Spellbooks*). |
+| **Willpower** | Reduces sanity drain and increases stamina/tempo. Reduces spell cast time with Iron's Spells Spells & Spellbooks -> Does   |
+| **Charisma** | Improves villager trades and grants small mana bonuses. |
+| **Light Scaling** | Increases damage with light weapons. |
+| **Medium Scaling** | Increases damage with medium weapons. |
+| **Heavy Scaling** | Increases damage with heavy weapons. |
+| **Magic Scaling** | Enhances spell power and mana efficiency for scaling spells. |
+
+### Knowledge System
+- Gain **1 Knowledge** for each Ascend Level.
+- Gain **2 Knowledge** when slaying elite or boss-tier mobs.
+- Spend Knowledge at ancient shrines or with special items to alter your progression.
+
+### Shrine of Remembrance
+- Indestructible world-generated structure appearing rarely. You can interact with it to reset your skillpoints in exchange for Knowledge.
+
+### Iron’s Spells ‘n Spellbooks Compatibility
+If installed:
+- **Intelligence** increases max mana, spell power, mana regen, and cooldown reduction.
+- **Charisma** adds smaller mana bonuses.
+- **Magic Scaling** improves damage and regen for scaling spells.
+
+## Controls
+
+| Action | Default Key | Description |
+|---------|--------------|-------------|
+| **Open Ascend Stats Menu** | `V` | Opens the attribute screen (can be rebound in Controls → Keybinds → Inventory). |
+
+---
+
+## Configuration
+All gameplay values (XP gain, level caps, points per level, etc.) are adjustable in config/ascend-common.toml