fifty_achievement_engine 0.1.2

Achievement system for Flutter games with condition-based unlocks, progress tracking, and FDL-compliant UI.

Fifty Achievement Engine

Achievement system for Flutter games with condition-based unlocks, progress tracking, and FDL-compliant UI. Part of Fifty Flutter Kit.

Home	Basic Achievements	Achievement Unlocked	RPG Achievements

---

Features

• Flexible Condition System - 6 built-in condition types for any unlock criteria
• Progress Tracking - Real-time progress calculation (0.0 to 1.0)
• Event & Stat Tracking - Track game events and player statistics
• Prerequisite Support - Chain achievements with dependencies
• Rarity Tiers - Common, Uncommon, Rare, Epic, Legendary
• Hidden Achievements - Spoiler-free surprises until unlocked
• Serialization - JSON save/load for game persistence
• FDL-Compliant UI - Styled widgets using Fifty Design Language

---

Installation

dependencies:
  fifty_achievement_engine:
    path: ../fifty_achievement_engine
  # Required for FDL tokens
  fifty_tokens:
    path: ../fifty_tokens

---

Quick Start

import 'package:fifty_achievement_engine/fifty_achievement_engine.dart';

// Create controller with achievements
final controller = AchievementController<void>(
  achievements: [
    Achievement(
      id: 'first_kill',
      name: 'First Blood',
      description: 'Defeat your first enemy',
      condition: EventCondition('enemy_killed'),
      rarity: AchievementRarity.common,
      points: 10,
    ),
    Achievement(
      id: 'kill_100',
      name: 'Century',
      description: 'Defeat 100 enemies',
      condition: CountCondition('enemy_killed', target: 100),
      rarity: AchievementRarity.rare,
      points: 50,
      prerequisites: ['first_kill'],
    ),
  ],
  onUnlock: (achievement) {
    print('Unlocked: ${achievement.name}!');
  },
);

// Track events as they happen
controller.trackEvent('enemy_killed');

// Check progress
final progress = controller.getProgress('kill_100');
print('${(progress * 100).toStringAsFixed(0)}%'); // e.g., "45%"

---

Architecture

AchievementController<T>
    |
    +-- achievements: List<Achievement<T>>
    |       Condition-based unlock, rarity, prerequisites
    |
    +-- Event/Stat Tracking
    |       trackEvent(), updateStat(), incrementStat()
    |
    +-- Progress Engine
    |       Real-time progress (0.0-1.0), state machine
    |
    +-- Serialization
            exportProgress(), importProgress(), packs

Core Components

Component	Description
AchievementController	Main controller managing achievements, tracking events/stats, unlock logic
Achievement	Data model with conditions, prerequisites, rarity, points
AchievementCondition	Abstract base for condition types
AchievementSerializer	JSON serialization for save/load and packs

---

API Reference

AchievementController

Tracking Events & Stats

// Track single event
controller.trackEvent('enemy_killed');

// Track multiple occurrences at once
controller.trackEvent('coin_collected', count: 50);

// Update a stat
controller.updateStat('player_level', 25);

// Increment a stat
controller.incrementStat('total_damage', 150);

// Clear tracking data (keeps unlocks)
controller.resetTracking();

// Full reset (unlocks + tracking)
controller.reset();

Achievement States

enum AchievementState {
  locked,    // Prerequisites not met
  available, // Can be worked towards
  unlocked,  // Completed!
  claimed,   // Reward collected (optional)
}

// Check state
final state = controller.getState('kill_100');
if (state == AchievementState.available) {
  // Show progress
}

Progress Details

// Simple progress (0.0 to 1.0)
final progress = controller.getProgress('kill_100');

// Detailed progress info
final details = controller.getProgressDetails('kill_100');
print('${details.current}/${details.target}'); // "45/100"
print('${details.percentage * 100}%');         // "45%"
print('State: ${details.state.displayName}');  // "In Progress"

Serialization

Save Progress

// Export all progress data
final progressJson = controller.exportProgress();
await saveToFile(jsonEncode(progressJson));

Load Progress

// Import saved progress
final savedData = await loadFromFile();
final progressJson = jsonDecode(savedData) as Map<String, dynamic>;
controller.importProgress(progressJson);

Condition Types

EventCondition

Triggered when a specific event occurs at least once.

// Unlock when player finishes the tutorial
EventCondition('tutorial_completed')

CountCondition

Requires an event to occur a specific number of times.

// Kill 100 enemies
CountCondition('enemy_killed', target: 100)

ThresholdCondition

Satisfied when a stat reaches a target value.

// Reach level 50
ThresholdCondition('player_level', target: 50)

// Deal 10,000 damage total
ThresholdCondition('total_damage', target: 10000)

// With comparison operators
ThresholdCondition(
  'health',
  target: 1,
  operator: ThresholdOperator.lessOrEqual, // Survive at 1 HP
)

CompositeCondition

Combines multiple conditions with AND/OR logic.

// Kill 100 enemies AND reach level 50
CompositeCondition.and([
  CountCondition('enemy_killed', target: 100),
  ThresholdCondition('player_level', target: 50),
])

// Complete tutorial OR skip tutorial
CompositeCondition.or([
  EventCondition('tutorial_completed'),
  EventCondition('tutorial_skipped'),
])

TimeCondition

Time-based challenges.

// Play for 10 hours total
TimeCondition(Duration(hours: 10))

// Survive for 30 minutes in survival mode
TimeCondition(
  Duration(minutes: 30),
  duringEvent: 'survival_mode_active',
)

SequenceCondition

Requires events to occur in a specific order.

// Execute a specific combo
SequenceCondition(
  ['light_attack', 'light_attack', 'heavy_attack'],
  strict: true, // Must be consecutive
)

// Complete story chapters in order
SequenceCondition(
  ['chapter_1', 'chapter_2', 'chapter_3'],
  strict: false, // Other events allowed between
)

Widgets

AchievementCard

Display a single achievement with progress.

AchievementCard(
  achievement: myAchievement,
  progress: 0.75,
  state: AchievementState.available,
  onTap: () => showDetails(myAchievement),
)

AchievementList

Scrollable list with filtering support.

AchievementList(
  controller: controller,
  filter: AchievementFilter.available, // all, available, unlocked, locked
  rarityFilter: AchievementRarity.rare, // Optional rarity filter
  categoryFilter: 'Combat',             // Optional category filter
  onTap: (achievement) => showDetails(achievement),
)

AchievementPopup

Animated unlock notification.

controller.onUnlock = (achievement) {
  showOverlay(
    context: context,
    builder: (context) => AchievementPopup(
      achievement: achievement,
      duration: Duration(seconds: 4),
      onDismiss: () => hideOverlay(),
    ),
  );
};

Note: AchievementPopup includes an internal Material wrapper with MaterialType.transparency to ensure proper text rendering when displayed via Flutter's Overlay. This prevents the yellow underline text issue that occurs when Text widgets lack a Material ancestor.

AchievementSummary

Overall progress statistics.

AchievementSummary(
  controller: controller,
  showRarityBreakdown: true,
  showCategoryBreakdown: true,
)

AchievementProgressBar

Standalone progress bar.

AchievementProgressBar(
  progress: 0.75,
  height: 8,
  foregroundColor: Colors.green,
)

---

Usage Patterns

Custom Achievement Data

Attach game-specific data to achievements:

class RewardData {
  final int gold;
  final String? itemId;

  RewardData({required this.gold, this.itemId});
}

final controller = AchievementController<RewardData>(
  achievements: [
    Achievement<RewardData>(
      id: 'boss_slayer',
      name: 'Boss Slayer',
      condition: EventCondition('boss_defeated'),
      data: RewardData(gold: 1000, itemId: 'legendary_sword'),
    ),
  ],
  onUnlock: (achievement) {
    if (achievement.data != null) {
      player.addGold(achievement.data!.gold);
      if (achievement.data!.itemId != null) {
        player.giveItem(achievement.data!.itemId!);
      }
    }
  },
);

Achievement Packs

Serialize achievement definitions for modding or DLC:

// Serialize achievements
final packJson = AchievementSerializer.serializePack<RewardData>(
  achievements,
  packId: 'base_game',
  packName: 'Base Game Achievements',
  dataSerializer: (data) => data.toJson(),
);

// Deserialize
final pack = AchievementSerializer.deserializePack<RewardData>(
  packJson,
  dataDeserializer: (json) => RewardData.fromJson(json),
);
controller.addAchievements(pack.achievements);

Filtering & Querying

// By state
final available = controller.availableAchievements;
final unlocked = controller.unlockedAchievements;
final locked = controller.lockedAchievements;

// By rarity
final legendary = controller.getByRarity(AchievementRarity.legendary);

// By category
final combat = controller.getByCategory('Combat');

// Get all categories
final categories = controller.categories;

// Statistics
print('Total points: ${controller.totalPoints}');
print('Earned points: ${controller.earnedPoints}');
print('Completion: ${(controller.completionPercentage * 100).toStringAsFixed(1)}%');

---

Platform Support

Platform	Support	Notes
Android	Yes
iOS	Yes
macOS	Yes
Linux	Yes
Windows	Yes
Web	Yes

---

Fifty Design Language Integration

This package is part of Fifty Flutter Kit:

• Theme-aware widgets - All widgets use Theme.of(context).colorScheme for colors (onSurface for text, surfaceContainerHighest for backgrounds, primary for accents, outline for borders)
• FDL token alignment - Spacing from FiftySpacing, typography from FiftyTypography, radii from FiftyRadii, motion from FiftyMotion
• Rarity semantic colors - Common, Uncommon, Rare, Epic, Legendary use intentional semantic colors
• Compatible packages - Works with fifty_tokens, fifty_theme, fifty_ui

Optional color overrides are provided as widget parameters:

AchievementCard(
  achievement: myAchievement,
  progress: 0.75,
  backgroundColor: Theme.of(context).colorScheme.surface,
  borderColor: Colors.amber,
)

---

Version

Current: 0.1.1

---

License

MIT License - see LICENSE for details.

Part of Fifty Flutter Kit.