MFAAvalonia

https://github.com/sweetsmellfox/mfaavalonia
Admin
MFAAvalonia is a next-generation cross-platform graphical user interface (GUI) solution for the...
Tokens:6,754
Snippets:63
Trust Score:6.6
License:GPL-3.0
Update:8 months ago
Show doc for...
Tokens:
Raw
### Command Line Interface Usage

Source: https://context7.com/sweetsmellfox/mfaavalonia/llms.txt

Examples of launching MFAAvalonia using command-line parameters for automation and scripting. Supports launching with default or specific configuration profiles.

```bash
# Launch with default configuration
./MFAAvalonia

# Launch with specific configuration profile
./MFAAvalonia -c "Profile1"

# Example: Windows
MFAAvalonia.exe -c "GameServer_Official"

# Example: Linux/macOS
./MFAAvalonia -c "GameServer_Bilibili"
```

--------------------------------

### Custom Webhook Payload Template Example

Source: https://github.com/sweetsmellfox/mfaavalonia/blob/master/docs/en/external-notification.md

An example demonstrating how to format a JSON payload for a custom webhook, using a placeholder for the message content. This is useful for integrating with services that require a specific request body structure.

```json
{
  "text": "{message}"
}
```

--------------------------------

### Android Resource File Structure Example

Source: https://github.com/sweetsmellfox/mfaavalonia/blob/master/MFAAvalonia.Android/Resources/AboutResources.txt

Illustrates a typical directory structure for Android resources within an application. This includes drawable images, UI layouts, and string definitions for internationalization.

```text
Resources/
    drawable/
        icon.png

    layout/
        main.axml

    values/
        strings.xml
```

--------------------------------

### C# ConfigurationManager API

Source: https://context7.com/sweetsmellfox/mfaavalonia/llms.txt

Programmatic access to application settings and profile management using the ConfigurationManager class in C#. Allows getting, setting, switching, adding, and saving configuration profiles.

```csharp
// Access current configuration
using MFAAvalonia.Configuration;

// Get configuration value with default
var enableLiveView = ConfigurationManager.Current.GetValue(
    ConfigurationKeys.EnableLiveView,
    defaultValue: true
);

// Set configuration value
ConfigurationManager.Current.SetValue(
    ConfigurationKeys.LiveViewRefreshRate,
    30.0
);

// Switch configuration profile
ConfigurationManager.SwitchConfiguration("Profile2");

// Get current profile name
string currentProfile = ConfigurationManager.GetCurrentConfiguration();

// Add new configuration profile
var newConfig = ConfigurationManager.Add("NewProfile");

// Save configuration changes
ConfigurationManager.SaveConfiguration("Profile1");
```

--------------------------------

### External Notification Service Configurations

Source: https://context7.com/sweetsmellfox/mfaavalonia/llms.txt

Configuration examples for various external notification providers to send alerts upon task completion. Supports DingTalk, Telegram, Discord Webhook, Custom Webhook, ServerChan, and SMTP Email.

```jsonc
// Supported notification providers configuration

// DingTalk
{
  "provider": "dingtalk",
  "bot_token": "https://oapi.dingtalk.com/robot/send?access_token=xxx",
  "secret": "SECxxxxx"  // Optional signing secret
}

// Telegram
{
  "provider": "telegram",
  "chat_id": "-100123456789",
  "bot_token": "123456789:ABCdefGHIjklMNOpqrsTUVwxyz"
}

// Discord Webhook
{
  "provider": "discord_webhook",
  "webhook_url": "https://discord.com/api/webhooks/xxx/yyy",
  "webhook_name": "MFA Bot"
}

// Custom Webhook
{
  "provider": "custom",
  "webhook_url": "https://api.example.com/notify",
  "content_type": "application/json",
  "payload_template": "{\"text\": \"{message}\", \"priority\": \"high\"}"
}

// ServerChan
{
  "provider": "serverchan",
  "send_key": "SCTxxxxxxxxxx"
}

// SMTP Email
{
  "provider": "smtp",
  "smtp_server": "smtp.gmail.com",
  "smtp_port": 587,
  "smtp_ssl": true,
  "smtp_auth": true,
  "smtp_user": "your-email@gmail.com",
  "smtp_password": "app-password",
  "smtp_from": "your-email@gmail.com",
  "smtp_to": "recipient@example.com"
}
```

--------------------------------

### Example Custom Layout Structure (JSON)

Source: https://github.com/sweetsmellfox/mfaavalonia/blob/master/docs/en/custom-layout.md

This JSON structure defines global layout settings such as rows, columns, and spacing, along with specific positions and spans for individual cards like 'TaskList' and 'LogPanel'.

```json
{
  "rows": 3,
  "columns": 4,
  "spacing": 10,
  "TaskList": {
    "row": 0,
    "col": 0,
    "row_span": 2,
    "col_span": 2
  },
  "LogPanel": {
    "row": 0,
    "col": 2,
    "row_span": 3,
    "col_span": 2
  }
}
```

--------------------------------

### Default Layout Example (JSON)

Source: https://github.com/sweetsmellfox/mfaavalonia/blob/master/docs/en/custom-layout.md

This JSON object represents the default layout configuration for the TaskQueueView, specifying the number of rows, columns, spacing, and the layout parameters for various components like 'settings', 'task_list', 'task_desc', 'live_view', and 'log'.

```json
{
  "rows": 8,
  "columns": 12,
  "spacing": 10,
  "settings": {
    "row": 0,
    "col": 4,
    "row_span": 5,
    "col_span": 4
  },
  "task_list": {
    "row": 0,
    "col": 0,
    "row_span": 8,
    "col_span": 4
  },
  "task_desc": {
    "row": 5,
    "col": 4,
    "row_span": 3,
    "col_span": 4
  },
  "live_view": {
    "row": 0,
    "col": 8,
    "row_span": 4,
    "col_span": 4
  },
  "log": {
    "row": 4,
    "col": 8,
    "row_span": 4,
    "col_span": 4
  }
}
```

--------------------------------

### Launch MFAAvalonia with a Specific Configuration

Source: https://github.com/sweetsmellfox/mfaavalonia/blob/master/README_en.md

This command shows how to launch the MFAAvalonia application with a custom configuration file. By appending the '-c' flag followed by the configuration file name, users can override default settings and tailor the application's behavior. This is useful for managing different application profiles or environments.

```bash
MFAAvalonia -c config-name
```

--------------------------------

### MFAAvalonia Project Configuration (interface.json)

Source: https://context7.com/sweetsmellfox/mfaavalonia/llms.txt

Defines the overall structure of an MFAAvalonia automation project. It includes metadata, update service configuration, multi-language support, resource definitions for different game variants, controller presets (ADB, Win32, PlayCover), and task definitions with their respective entry points and descriptions.

```json
{
  "name": "MyAutomationProject",
  "version": "1.2.0",
  "url": "https://github.com/username/my-maa-project",
  "custom_title": "My Game Automation Tool",

  "mirrorchyan_rid": "MyProject",
  "mirrorchyan_multiplatform": false,

  "languages": {
    "zh-cn": "lang/zh-cn.json",
    "en-us": "lang/en-us.json"
  },

  "resource": [
    {
      "name": "Official",
      "path": "{PROJECT_DIR}/resource/base"
    },
    {
      "name": "Bilibili",
      "path": [
        "{PROJECT_DIR}/resource/base",
        "{PROJECT_DIR}/resource/bilibili"
      ]
    }
  ],

  "controller": [
    {
      "name": "Adb",
      "type": "Adb",
      "label": "$controller.adb",
      "display_short_side": 720,
      "adb": {}
    },
    {
      "name": "Win32",
      "type": "Win32",
      "label": "$controller.win32",
      "win32": {
        "class_regex": "UnityWndClass",
        "window_regex": "^MyGame$"
      }
    },
    {
      "name": "PlayCover",
      "type": "PlayCover",
      "label": "$controller.playcover",
      "playcover": {
        "uuid": "com.game.bundle"
      }
    }
  ],

  "task": [
    {
      "name": "Daily Login",
      "entry": "DailyLogin",
      "default_check": true,
      "description": "Automatically claim daily login rewards",
      "repeatable": false
    },
    {
      "name": "Auto Battle",
      "entry": "AutoBattle",
      "default_check": false,
      "description": "Run automated battles",
      "repeatable": true,
      "repeat_count": 5
    }
  ]
}
```

--------------------------------

### Basic Configuration Structure for MFAAvalonia

Source: https://github.com/sweetsmellfox/mfaavalonia/blob/master/README_en.md

This JSON structure defines the basic configuration for an MFAAvalonia project. It includes project information, update settings for Mirror Chyan, resource configurations, and task definitions. This file is crucial for setting up and running automated tasks with the framework.

```json
{
  // Project Information
  "name": "Project Name",
  "version": "1.0.0",
  "url": "https://github.com/{username}/{repository}",
  "custom_title": "Custom Window Title",
  
  // Mirror Chyan Update Configuration
  "mirrorchyan_rid": "Project ID",
  "mirrorchyan_multiplatform": false,
  
  // Resource Configuration
  "resource": [
    {
      "name": "Official",
      "path": "{PROJECT_DIR}/resource/base"
    },
    {
      "name": "Bilibili",
      "path": [
        "{PROJECT_DIR}/resource/base",
        "{PROJECT_DIR}/resource/bilibili"
      ]
    }
  ],
  
  // Task Configuration
  "task": [
    {
      "name": "Task Name",
      "entry": "Task Entry",
      "default_check": true,
      "description": "Task Documentation",
      "repeatable": true,
      "repeat_count": 1
    }
  ]
}
```

--------------------------------

### Configure Multi-Language Support in MFAAvalonia

Source: https://github.com/sweetsmellfox/mfaavalonia/blob/master/README_en.md

This snippet demonstrates how to set up multi-language support in MFAAvalonia. It involves creating a 'lang' directory with language-specific JSON files and defining the paths to these files within the 'languages' object in 'interface.json'. MFAAvalonia will automatically load translations based on user settings.

```json
{
  "languages": {
    "zh-cn": "lang/zh-cn.json",
    "zh-tw": "lang/zh-tw.json",
    "en-us": "lang/en-us.json"
  }
}
```

--------------------------------

### MFAAvalonia Task Node Configuration (Pipeline JSON)

Source: https://context7.com/sweetsmellfox/mfaavalonia/llms.txt

Defines individual automation steps within a task pipeline. Each node specifies recognition methods (e.g., TemplateMatch, OCR), actions to perform (e.g., Click), target elements, flow control (e.g., `next`, `on_error`), and timing parameters. It also supports rich logging and focus messages.

```json
{
  "DailyLogin": {
    "recognition": "TemplateMatch",
    "template": "images/login_button.png",
    "roi": [100, 200, 300, 100],
    "threshold": 0.8,
    "action": "Click",
    "target": true,
    "next": ["ClaimReward"],
    "timeout": 10000,
    "pre_delay": 500,
    "post_delay": 1000,
    "focus": {
      "start": ["[color:cyan]Starting daily login...[/color]"],
      "succeeded": ["[color:green]Login successful![/color]"],
      "failed": ["[color:red]Login failed[/color]"],
      "toast": ["Daily Login", "Task completed"]
    }
  },

  "ClaimReward": {
    "recognition": "OCR",
    "expected": ["Claim", "Collect"],
    "action": "Click",
    "target": true,
    "on_error": ["RetryLogin"],
    "focus": {
      "Node.Action.Starting": "Claiming reward: {name}",
      "Node.Action.Succeeded": "Reward claimed successfully"
    }
  },

  "RetryLogin": {
    "recognition": "DirectHit",
    "action": "Click",
    "target": [540, 960],
    "next": ["DailyLogin"]
  }
}
```

--------------------------------

### C# MaaProcessor Task Execution API

Source: https://context7.com/sweetsmellfox/mfaavalonia/llms.txt

Handles task queue management and automation execution using the MaaProcessor class. Allows enqueuing tasks, starting/stopping execution, clearing logs, and accessing log output.

```csharp
// Task execution workflow
using MFAAvalonia.Extensions.MaaFW;

// Access the current processor instance
var processor = MaaProcessorManager.Instance.Current;

// Add task to queue
processor.TaskQueue.Enqueue(new MFATask
{
    Name = "DailyLogin",
    Entry = "DailyLogin",
    IsEnabled = true
});

// Start task execution
await processor.StartAsync();

// Stop execution
processor.Stop();

// Clear task queue
processor.TaskQueue.Clear();

// Access log output
foreach (var log in processor.LogItemViewModels)
{
    Console.WriteLine($"[{log.Time}] {log.Message}");
}

// Clear logs
processor.ClearLogs();
```

--------------------------------

### Multi-Language JSON Localization Files

Source: https://context7.com/sweetsmellfox/mfaavalonia/llms.txt

JSON files used for internationalization (i18n) to support multiple languages. Each file corresponds to a specific language code and contains key-value pairs for UI elements and messages.

```json
// lang/en-us.json
{
  "controller.adb": "Android (ADB)",
  "controller.win32": "Windows Application",
  "controller.playcover": "iOS (PlayCover)",
  "option.battle_mode": "Battle Mode",
  "option.battle_mode.auto": "Automatic",
  "option.battle_mode.manual": "Manual Control",
  "option.repeat_count": "Repeat Count",
  "option.skip_dialogs": "Skip Dialogs",
  "task.daily_login": "Daily Login",
  "task.auto_battle": "Auto Battle"
}
```

```json
// lang/zh-cn.json
{
  "controller.adb": "安卓模拟器 (ADB)",
  "controller.win32": "Windows 应用",
  "controller.playcover": "iOS (PlayCover)",
  "option.battle_mode": "战斗模式",
  "option.battle_mode.auto": "自动",
  "option.battle_mode.manual": "手动控制",
  "option.repeat_count": "重复次数",
  "option.skip_dialogs": "跳过对话",
  "task.daily_login": "每日登录",
  "task.auto_battle": "自动战斗"
}
```

--------------------------------

### Generated R Class for Android Resources

Source: https://github.com/sweetsmellfox/mfaavalonia/blob/master/MFAAvalonia.Android/Resources/AboutResources.txt

Demonstrates the structure of the auto-generated 'R' class in Android development. This class contains static inner classes and constants that serve as resource IDs, allowing programmatic access to various resource types.

```csharp
public class R {
    public class drawable {
        public const int icon = 0x123;
    }

    public class layout {
        public const int main = 0x456;
    }

    public class strings {
        public const int first_string = 0xabc;
        public const int second_string = 0xbcd;
    }
}
```
Tokens:
Raw