Skip to content

RoseOfficial/QuestFlow

Repository files navigation

QuestFlow

A comprehensive quest automation plugin for Final Fantasy XIV that automatically completes quests by navigating to waypoints, interacting with NPCs, and handling quest objectives.

✨ Features

  • Automated Quest Execution: Automatically walks to quest waypoints and completes objectives
  • Comprehensive Quest Database: 3,256+ quest definitions covering all FFXIV expansions (ARR through Dawntrail)
  • Smart Navigation: Uses navmesh for intelligent pathfinding and movement
  • Multi-Content Support:
    • Main Story Quests (MSQ)
    • Class/Job Quests
    • Alliance Raid Quests
    • Trial Quests
    • Allied Society Dailies
    • Side Quests and Unlocks
  • Gathering Automation: 179+ gathering location definitions with precise coordinate mapping
  • Visual Quest Editor: Built-in tools for creating and editing quest paths
  • Aetheryte Optimization: Automatic teleportation shortcuts for efficient routing
  • Class Job Switching: Auto-switches jobs when required by quest prerequisites

🚀 Installation

Required Dependencies

QuestFlow requires the following Dalamud plugins to function:

Optional Dependencies

Installing QuestFlow

  1. Add the QuestFlow repository to your Dalamud plugin sources
  2. Install QuestFlow from the plugin installer
  3. Ensure all required dependencies are installed and enabled

🎮 Usage

Basic Operations

  1. Open the QuestFlow window with /questflow or /qf
  2. Select quests from your journal or browse available quest categories
  3. Click "Start" to begin automated quest execution
  4. QuestFlow will handle movement, interactions, and quest objectives

Quest Categories

  • MSQ: Complete story progression automatically
  • Class Quests: Level your jobs with automated class questlines
  • Dailies: Efficient completion of Allied Society and other daily quests
  • Gathering: Automated resource collection with optimized routes

Safety Features

  • Interrupt System: Press ESC or move manually to pause automation
  • Configurable Boundaries: Set safe zones and blacklisted areas
  • Combat Integration: Seamless integration with combat plugins like BossModReborn

🏗️ Project Structure

Core Components

  • QuestFlow/: Main plugin executable with quest execution engine
  • QuestPaths/: Database of 3,256+ quest step definitions organized by expansion
  • GatheringPaths/: 179+ gathering location coordinates with precision mapping
  • QuestFlow.Model/: Shared data structures and JSON schemas
  • QuestPathGenerator/: Build-time code generation for optimal performance

Development Tools

  • GatheringPathRenderer/: Visual editor for creating gathering location data
  • QuestFlow.IpcTest/: IPC testing utilities for integration validation
  • QuestPaths.JsonValidator/: Data integrity validation and schema compliance
  • LLib/: Shared utility library for FFXIV plugin development

Build System

  • Roslyn Source Generators: Compile-time conversion of JSON data to optimized C# code
  • Schema Validation: Automatic validation of quest and gathering data during build
  • Multi-Project Solution: Organized, maintainable codebase with clear separation of concerns

🔧 Configuration

General Settings

  • Movement Speed: Configure mount, flying, and sprint behavior
  • Interaction Timing: Adjust delays for different connection speeds
  • Safety Options: Set stop conditions and emergency interrupts

Advanced Options

  • Navmesh Integration: Fine-tune pathfinding behavior
  • Plugin Integration: Configure external plugin interactions
  • Debug Features: Enable detailed logging and visual overlays

🤝 Contributing

Development Setup

  1. Clone the repository: git clone <repository-url>
  2. Install .NET 8.0 SDK
  3. Open QuestFlow.sln in Visual Studio or Rider
  4. Build the solution

Quest Data Contribution

  1. Use the GatheringPathRenderer to create new gathering locations
  2. Follow the quest JSON schema for new quest definitions
  3. Test thoroughly before submitting pull requests
  4. Run QuestPaths.JsonValidator to ensure data integrity

Code Guidelines

  • Follow existing code style and conventions
  • Add comprehensive documentation for new features
  • Include appropriate unit tests where applicable
  • Ensure all builds pass validation checks

📄 License

This project maintains the original license terms. Please refer to the license file for detailed information.

⚠️ Disclaimer

QuestFlow is a community-developed automation tool. Use responsibly and in accordance with Final Fantasy XIV's Terms of Service. The developers are not responsible for any consequences resulting from the use of this plugin.

🔗 Links

📊 Statistics

  • Quest Definitions: 3,256+ automated quest paths
  • Gathering Locations: 179+ precise coordinate mappings
  • Expansion Coverage: A Realm Reborn through Dawntrail (2.x - 7.x)
  • Content Types: MSQ, Class Quests, Trials, Raids, Allied Societies, Side Quests
  • Development: Multi-project solution with 8 specialized components

QuestFlow: Automate your FFXIV journey with precision and reliability.

About

A dalamud plugin that completes quests for you.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages