SpellSmut

SpellForce Documentation

This folder contains all documentation for the SpellForce Platinum Edition modding project.

Folder Structure

📁 Extraction

Asset and data extraction guides, tools, and results.

• CFF Extraction: GameData.cff parsing and modding guides
• Asset Extraction: Audio, UI, and other asset extraction plans
• Quest Extraction: Quest data, dialogues, and reward extraction
• Icon Extraction: UI icon mapping and extraction tools

📁 Guides

Comprehensive guides for SpellForce game systems and modding.

• Spell System: Magic schools, spells, and effects
• Quest System: Campaign and quest creation
• Race Creation: Custom races and units
• Multiplayer: Free game and multiplayer modding
• Sound System: Audio and music integration

📁 Project

Project-wide documentation and status reports.

• Implementation Summary: Technical overviews and completion reports
• Status Reports: Feature completion and milestone tracking
• ID Mappings: Database ID references and mappings
• Quest Editor: Quest editor specific documentation
• Performance Fixes: Optimization and bug fix documentation

📁 Development

Technical implementation and development documentation.

• Lua Integration: Script parsing and integration guides
• Dialogue System: Dialogue parsing and relationship mapping
• Performance: Localization and performance optimization
• Testing: Integration testing and validation procedures
• Logging: System logging and debugging guides

📁 Technical

Deep technical documentation for specific systems.

• Map Viewer: 3D map rendering and implementation
• Texture Rendering: Graphics and texture system documentation

📁 Site

Jekyll website source files for project documentation site.

• Layouts: HTML templates
• Assets: CSS, images, and resources
• Config: Jekyll configuration

📁 Tools

Development tools and editor configurations.

• AI Tools: Claude integration and workflows
• Editor Settings: Zed and other editor configs

📁 archive

Deprecated and superseded documentation.

• Old Quest Viewer Docs: Previous versions of quest viewer documentation
• Amra & Lea: Duplicate quest documentation files
• Phase Reports: Old implementation phase reports

Quick Access

• CFF Editor Planning: GUI/TUI editor development
• Weapon Data Extraction: Complete weapon dataset
• Category References: Data relationship mapping

Contributing

When adding new documentation:

1. Place in appropriate subfolder
2. Use clear, descriptive filenames
3. Include links in this README if it’s a key document
4. Update related planning documents