Skip to content

Latest commit

 

History

History
151 lines (116 loc) · 4.71 KB

README_en.md

File metadata and controls

151 lines (116 loc) · 4.71 KB
Raw

Introduction

  • This project is a user interface developed based on the WPF framework, aiming to provide functionality similar to MaaPiCli.

Requirements

Usage Requirements

  • .NET8 runtime
  • A non-integrated project based on the maaframework.

How to Use

Automatic Installation

  • Download workflows/install.yml from the project and modify the following: project name, author name, project title, MAAxxx
  • Replace MAA project template .github/workflows/install.yml with the modified install.yml.
  • Push the new version.

Manual Installation

  • Download and extract the latest release.
  • Copy all content from maafw/assets/resource to MFAWPF/Resource.
  • Copy the maafw/assets/interface.json file to the root directory of MFAWPF/.
  • Modify the newly copied interface.json file.
  • Below is an example:
{
 "resource": [
   {
     "name": "Official",
     "path": "{PROJECT_DIR}/resource/base"
   },
   {
     "name": "Bilibili",
     "path": [
       "{PROJECT_DIR}/resource/base",
       "{PROJECT_DIR}/resource/bilibili"
     ]
   }
 ],
 "task": [
   {
     "name": "Task",
     "entry": "Task"
   }
 ]
}

Modify it as follows:

{
 "name": "Project Name", // Default is null
 "version":  "Project Version", // Default is null
 "url":  "Project URL (currently only supports Github)", // Default is null, for example, https://github.com/{GithubAccount}/{GithubRepo}
 "custom_title": "Custom Title", // Default is null, after using this field, the title bar will only show custom_title and version
 "default_controller": "adb", // Default is adb, the default controller after startup, options include adb or win32
 "lock_controller":false, // Default is false, whether to lock the controller; when enabled, users cannot switch between adb and win32
 "resource": [
   {
     "name": "Official",
     "path": "{PROJECT_DIR}/resource/base"
   },
   {
     "name": "Bilibili",
     "path": [
       "{PROJECT_DIR}/resource/base",
       "{PROJECT_DIR}/resource/bilibili"
     ]
   }
 ],
 "task": [
   {
     "name": "Task",
     "entry": "Task Interface",
     "checked": true,  // Default is false, whether the task is selected by default
     "doc": "Documentation",  // Default is null, displayed below the task setting options, supports rich text format (details below)
     "repeatable": true,  // Default is false, whether the task can be repeated
     "repeat_count": 1  // Default task repeat count, requires repeatable to be true
   }
 ]
}

docString Formatting：

Use tags like[color:red]Text Content[/color] to define text styles.

Supported tags include:

  • [color:color_name]: Color, such as[color:red].

  • [size:font_size]: Font size, such as[size:20].

  • [b]: Bold.

  • [i]: Italic.

  • [u]: Underline.

  • [s]：Strikethrough.

Note: The above comments are for documentation purposes and are not recommended for actual usage.

  • Run the project

Development Notes

  • The built-in MFATools can be used to crop images and obtain ROIs.
  • Some areas are not fully developed yet, and contributions are welcome.
  • Note that MaaFramework removed Exec Agent in version 2.0, so it's currently not possible to register Custom Actions and Custom Recognitions via interface registration.
  • Placing logo.ico in the same directory as the exe file will replace the window icon.

Note: In MFA, two new fields have been added to the task in the Pipeline, namely focus_tip and focus_tip_color.

  • focus : bool
    Whether to enable focus_tip. Optional, default is false.
  • focus_tip : string | list<string, >
    When executing a task, this is the content output on the right-side log in MFA. Optional, default is empty.
  • focus_tip_color : string | list<string, >
    The color of the content output when executing a task. Optional, default is Gray.

Acknowledgments

Open Source Libraries

Roadmap

v1.0

  • GUI interface for editing Pipelines
  • Support EN

v1.2

  • GUI interface for editing interface.json