- Overview
- Quick Start
- Features
- Installation
- Web Download
- Game Controls
- File Structure
- Mod System
- Contributing
"Our Legacy" is a comprehensive text-based CLI fantasy RPG game focused on exploration, grinding, and adventure. Built with Python and driven by modular JSON data, the game offers a rich, extensible experience for players and modders alike. Now featuring a powerful JavaScript Scripting Engine powered by Node.js and a new Alchemy & Crafting system.
- Character Classes: Choose from Warrior, Mage, Rogue, Hunter, Bard, Paladin, Druid, or Priest classes.
- Exploration: 7 diverse areas including the Starting Village, Dark Forest, Ancient Ruins, and more.
- Alchemy & Crafting: Collect materials from monsters and the environment to brew potent potions or forge powerful equipment.
- Grinding System: Level up through combat, gaining stats and unlocking new equipment.
- Mission System: Complete main story and side quests for gold and experience rewards.
- Boss Battles: Face legendary bosses like the Ancient Fire Dragon with multi-phase mechanics and HP thresholds.
- Scripting Engine: Extend and automate your journey using JavaScript (Node.js).
- Companions: Hire unique companions at the Tavern with active abilities and passive party bonuses.
- Buff & Effect System: Manage temporary status effects, magical shields, and per-turn HP/MP regeneration.
- Offhand & Accessories: Deep equipment customization with dedicated offhand slots and up to 3 accessory slots.
- Real-time Cooldowns: Bosses feature an 8-hour real-time cooldown after defeat.
| Class | Description | Key Stats | Starting Gear |
|---|---|---|---|
| Warrior | Strong melee fighter | High HP & Defense | Iron Sword, Leather Armor |
| Mage | Powerful spellcaster | High MP & Magic | Wooden Wand, Cloth Tunic |
| Rogue | Agile assassin | High Speed & Crit | Steel Dagger, Leather Armor |
| Hunter | Experienced tracker | High Attack & Aim | Hunter's Bow, Hunting Knife |
| Bard | Master of melodies | High Speed & Support | Enchanting Lute, Colourful Robe |
| Paladin | Holy warrior | High Defense & Holy Power | Paladin's Sword, Holy Shield |
| Druid | Nature guardian | High MP & Shapeshift | Druidic Staff, Nature's Robe |
| Priest | Devoted healer | High MP & Healing | Priest's Staff, Devout's Robe |
The new Crafting system allows you to create items using materials gathered during your travels.
Materials are found by defeating enemies or exploring specific areas:
- Ores: Iron Ore, Coal, Steel Ingot, Gold Nugget.
- Herbs: Herbs, Mana Herbs, Spring Water.
- Crystals: Crystal Shards, Dark Crystals, Fire Gems.
- Monster Parts: Goblin Ears, Orc Teeth, Wolf Fangs, Venom Sacs.
- Magical: Phoenix Feathers, Dragon Scales, Ancient Relics.
- Potions: Brew Health and Mana potions (Basic to Greater), or specialized Frost Potions.
- Elixirs: Create powerful boosters like the Elixir of Giant Strength.
- Enchantments: Forge weapons and armor like Steel Daggers or Swamp Scale Armor.
- Utility: Craft Luck Charms or extract pure Elemental Essences into Gems.
- Python 3.11+
- Node.js (for scripting features)
# Clone or download the repository
git clone https://github.com/andy64lol/our-legacy.git
# Navigate to the project directory
cd our-legacy
# Run the game
python3 main.py
# Or use the launcher for all tools
python3 launcher.pyYou can also download Our Legacy directly from the web interface:
- Open
index.htmlin your browser - Click the "Download Our Legacy (ZIP)" button
- Extract the ZIP file
- Run
python3 main.pyto start playing
The web interface also includes:
- ๐ Full documentation display
- ๐ฎ Feature highlights
- ๐ฆ One-click ZIP download
- Explore: Engage in random encounters and collect crafting materials.
- Inventory: Manage items and access the Crafting menu.
- View Character: Check stats, equipment, and active buffs.
- Travel: Move between connected world areas.
- Missions: Track and accept quests.
- Tavern: Hire and manage your party members.
- Shop: Browse multiple specialized shops in each area, each with unique items and purchase limits.
- Save/Load: Persist your progress to JSON save files.
Our_Legacy/
โโโ launcher.py # Unified launcher for all tools
โโโ main.py # Core game engine (Python 3.11+)
โโโ README.md # Quick start guide and overview
โโโ package.json # Node.js project configuration
โโโ data/ # Base Game Content (JSON)
โ โโโ classes.json # Player character classes and progression
โ โโโ items.json # Weapons, armor, consumables, accessories
โ โโโ crafting.json # Alchemy recipes and material categories
โ โโโ areas.json # World locations, shops, connections
โ โโโ shops.json # Shop definitions with items and limits
โ โโโ enemies.json # Regular combat encounters
โ โโโ bosses.json # Boss mechanics with multi-phase support
โ โโโ missions.json # Quests with objectives and rewards
โ โโโ spells.json # Magic spells and abilities
โ โโโ effects.json # Status effects and buffs
โ โโโ companions.json # Hireable companion definitions
โ โโโ dialogues.json # NPC and boss dialogue text
โ โโโ dungeons.json # Procedural dungeons with challenges
โ โโโ weekly_challenges.json # Recurring challenges
โ โโโ saves/ # Player save files (.json)
โโโ api/ # API modules for marketplace
โ โโโ market.js
โ โโโ ping.js
โ โโโ data/
โโโ LICENSE # Project license
- Create a folder in
mods/with your mod name - Create
mod.jsonwith metadata:
{
"name": "Your Mod Name",
"version": "1.0.0",
"author": "Your Name",
"description": "What your mod adds",
"enabled": true
}- Add any data files you want to modify:
bosses.json- New or override bossesareas.json- New areas or area changesitems.json- New itemsdungeons.json- New dungeonsdialogues.json- Dialogue text- Any other data files from
data/
- Base game data loads first from
data/ - Enabled mods load sequentially, merging data
- Arrays (dungeons) are extended with new entries
- Objects (items, bosses) are updated/overridden
- Mod data takes precedence over base data for same IDs
| File | Purpose | Contains |
|---|---|---|
| classes.json | Character classes | Warrior, Mage, Rogue, Hunter, Bard |
| items.json | Equipment & consumables | Weapons, armor, potions, materials |
| enemies.json | Regular encounters | Goblin, Orc, Skeleton, etc. |
| bosses.json | Boss battles | Multi-phase encounters with abilities |
| areas.json | World locations | Starting Village, Dungeons, Towns |
| missions.json | Quests | Main story and side quests |
| spells.json | Magic abilities | Spells for different classes |
| effects.json | Status effects | Buffs, debuffs, conditions |
| companions.json | Party members | Hireable companions with abilities |
| crafting.json | Alchemy system | Recipes and material categories |
| dialogues.json | Text dialogue | Boss speeches and NPC dialogue |
| dungeons.json | Procedural dungeons | Dungeon definitions and challenges |
- All JSON parameters with type information
- Complete examples for each file type
- Mod creation guide with step-by-step instructions
- Best practices for mod development
Contributions are welcome! Whether it's:
- ๐ Bug fixes
- โจ New features
- ๐ง Mod creation
- ๐ Documentation improvements
- ๐ Translation support
Please ensure your code follows the existing style and includes appropriate documentation.
This project is open source under the MIT License. See the LICENSE file for details.
Forge your destiny and leave behind a legend that will never be forgotten!
Built with โค๏ธ using Python & Node.js