maa

package module

Go to main page

Versions in this module

v2

v2.3.0

Aug 2, 2025

Changes in this version

type Context

+ func (ctx *Context) GetNodeJSON(name string) (bool, string)

type Resource

+ func (r *Resource) GetNodeJSON(name string) (bool, string)

+ func (r *Resource) OverrideNext(name string, nextList []string) bool

+ func (r *Resource) OverridePipeline(override any) bool

v2.2.0

Apr 23, 2025

Changes in this version

+ func AgentServerDetach()

+ func AgentServerJoin()

+ func AgentServerRegisterCustomAction(name string, action CustomAction) bool

+ func AgentServerRegisterCustomRecognition(name string, recognition CustomRecognition) bool

+ func AgentServerShutDown()

+ func AgentServerStartUp(identifier string) bool

+ type AgentClient struct

+ func NewAgentClient() *AgentClient

+ func (ac *AgentClient) BindResource(res *Resource) bool

+ func (ac *AgentClient) Connect() bool

+ func (ac *AgentClient) CreateSocket(identifier string) bool

+ func (ac *AgentClient) Destroy()

+ func (ac *AgentClient) Disconnect() bool

type Tasker

+ func (t *Tasker) Stopping() bool

v2.1.0

Mar 5, 2025

Changes in this version

+ const AdbInputMethodAdbShellValue

+ const AdbInputMethodAllValue

+ const AdbInputMethodDefaultValue

+ const AdbInputMethodEmulatorExtrasValue

+ const AdbInputMethodMaatouchValue

+ const AdbInputMethodMinitouchAndAdbKeyValue

+ const AdbScreencapMethodAllValue

+ const AdbScreencapMethodDefaultValue

+ const AdbScreencapMethodEmulatorExtrasValue

+ const AdbScreencapMethodEncodeToFileAndPullValue

+ const AdbScreencapMethodEncodeValue

+ const AdbScreencapMethodMinicapDirectValue

+ const AdbScreencapMethodMinicapStreamValue

+ const AdbScreencapMethodRawByNetcatValue

+ const AdbScreencapMethodRawWithGzipValue

+ const DbgControllerTypeCarouselImageValue

+ const DbgControllerTypeReplayRecordingValue

+ const Win32InputMethodSeizeValue

+ const Win32InputMethodSendMessageValue

+ const Win32ScreencapMethodDXGIDesktopDupValue

+ const Win32ScreencapMethodFramePoolValue

+ const Win32ScreencapMethodGDIValue

type AdbInputMethod

+ func ParseAdbInputMethod(methodStr string) (AdbInputMethod, error)

+ func (m AdbInputMethod) String() string

type AdbScreencapMethod

+ func ParseAdbScreencapMethod(methodStr string) (AdbScreencapMethod, error)

+ func (m AdbScreencapMethod) String() string

type DbgControllerType

+ func ParseDbgControllerType(typeStr string) (DbgControllerType, error)

+ func (t DbgControllerType) String() string

type Win32InputMethod

+ func ParseWin32InputMethod(methodStr string) (Win32InputMethod, error)

+ func (m Win32InputMethod) String() string

type Win32ScreencapMethod

+ func ParseWin32ScreencapMethod(methodStr string) (Win32ScreencapMethod, error)

+ func (m Win32ScreencapMethod) String() string

v2.0.0

Feb 15, 2025

Changes in this version

+ const InferenceDevice0

+ const InferenceDevice1

+ const InterenceDeviceAuto

+ func SetDebugMode(enabled bool) bool

+ func SetLogDir(path string) bool

+ func SetRecording(enabled bool) bool

+ func SetSaveDraw(enabled bool) bool

+ func SetShowHitDraw(enabled bool) bool

+ func SetStdoutLevel(level LoggingLevel) bool

+ func Version() string

+ type AdbDevice struct

+ AdbPath string

+ Address string

+ Config string

+ InputMethod AdbInputMethod

+ Name string

+ ScreencapMethod AdbScreencapMethod

+ type AdbInputMethod uint64

+ const AdbInputMethodAdbShell

+ const AdbInputMethodAll

+ const AdbInputMethodDefault

+ const AdbInputMethodEmulatorExtras

+ const AdbInputMethodMaatouch

+ const AdbInputMethodMinitouchAndAdbKey

+ const AdbInputMethodNone

+ type AdbScreencapMethod uint64

+ const AdbScreencapMethodAll

+ const AdbScreencapMethodDefault

+ const AdbScreencapMethodEmulatorExtras

+ const AdbScreencapMethodEncode

+ const AdbScreencapMethodEncodeToFileAndPull

+ const AdbScreencapMethodMinicapDirect

+ const AdbScreencapMethodMinicapStream

+ const AdbScreencapMethodNone

+ const AdbScreencapMethodRawByNetcat

+ const AdbScreencapMethodRawWithGzip

+ type Context struct

+ func (ctx *Context) Clone() *Context

+ func (ctx *Context) GetTaskJob() *TaskJob

+ func (ctx *Context) GetTasker() *Tasker

+ func (ctx *Context) OverrideNext(name string, nextList []string) bool

+ func (ctx *Context) OverridePipeline(override any) bool

+ func (ctx *Context) RunAction(entry string, box Rect, recognitionDetail string, override ...any) *NodeDetail

+ func (ctx *Context) RunRecognition(entry string, img image.Image, override ...any) *RecognitionDetail

+ func (ctx *Context) RunTask(entry string, override ...any) *TaskDetail

+ type Controller interface

+ CacheImage func() image.Image

+ Connected func() bool

+ Destroy func()

+ GetUUID func() (string, bool)

+ Handle func() uintptr

+ PostClick func(x, y int32) *Job

+ PostConnect func() *Job

+ PostInputText func(text string) *Job

+ PostPressKey func(keycode int32) *Job

+ PostScreencap func() *Job

+ PostStartApp func(intent string) *Job

+ PostStopApp func(intent string) *Job

+ PostSwipe func(x1, y1, x2, y2 int32, duration time.Duration) *Job

+ PostTouchDown func(contact, x, y, pressure int32) *Job

+ PostTouchMove func(contact, x, y, pressure int32) *Job

+ PostTouchUp func(contact int32) *Job

+ SetRecording func(enabled bool) bool

+ SetScreenshotTargetLongSide func(targetLongSide int32) bool

+ SetScreenshotTargetShortSide func(targetShortSide int32) bool

+ SetScreenshotUseRawSize func(enabled bool) bool

+ func NewAdbController(adbPath, address string, screencapMethod AdbScreencapMethod, ...) Controller

+ func NewCustomController(ctrl CustomController, notify Notification) Controller

+ func NewDbgController(readPath, writePath string, dbgCtrlType DbgControllerType, config string, ...) Controller

+ func NewWin32Controller(hWnd unsafe.Pointer, screencapMethod Win32ScreencapMethod, ...) Controller

+ type ControllerActionDetail struct

+ Action string

+ CtrlID uint64

+ UUID string

+ type CustomAction interface

+ Run func(ctx *Context, arg *CustomActionArg) bool

+ type CustomActionArg struct

+ Box Rect

+ CurrentTaskName string

+ CustomActionName string

+ CustomActionParam string

+ RecognitionDetail *RecognitionDetail

+ TaskDetail *TaskDetail

+ type CustomController interface

+ Click func(x, y int32) bool

+ Connect func() bool

+ Handle func() uintptr

+ InputText func(text string) bool

+ PressKey func(keycode int32) bool

+ RequestUUID func() (string, bool)

+ Screencap func() (image.Image, bool)

+ StartApp func(intent string) bool

+ StopApp func(intent string) bool

+ Swipe func(x1, y1, x2, y2, duration int32) bool

+ TouchDown func(contact, x, y, pressure int32) bool

+ TouchMove func(contact, x, y, pressure int32) bool

+ TouchUp func(contact int32) bool

+ type CustomControllerHandler struct

+ func NewCustomControllerHandler() CustomControllerHandler

+ func (c CustomControllerHandler) Handle() uintptr

+ type CustomRecognition interface

+ Run func(ctx *Context, arg *CustomRecognitionArg) (*CustomRecognitionResult, bool)

+ type CustomRecognitionArg struct

+ CurrentTaskName string

+ CustomRecognitionName string

+ CustomRecognitionParam string

+ Img image.Image

+ Roi Rect

+ TaskDetail *TaskDetail

+ type CustomRecognitionResult struct

+ Box Rect

+ Detail string

+ type DbgControllerType uint64

+ const DbgControllerTypeCarouselImage

+ const DbgControllerTypeNone

+ const DbgControllerTypeReplayRecording

+ type DesktopWindow struct

+ ClassName string

+ Handle unsafe.Pointer

+ WindowName string

+ type InterenceDevice = maa.MaaInferenceDevice

+ type J map[string]any

+ type Job struct

+ func NewJob(id int64, statusFunc func(id int64) Status, waitFunc func(id int64) Status) *Job

+ func (j *Job) Done() bool

+ func (j *Job) Failure() bool

+ func (j *Job) Invalid() bool

+ func (j *Job) Pending() bool

+ func (j *Job) Running() bool

+ func (j *Job) Status() Status

+ func (j *Job) Success() bool

+ func (j *Job) Wait() *Job

+ type LoggingLevel int32

+ const LoggingLevelAll

+ const LoggingLevelDebug

+ const LoggingLevelError

+ const LoggingLevelFatal

+ const LoggingLevelInfo

+ const LoggingLevelOff

+ const LoggingLevelTrace

+ const LoggingLevelWarn

+ type NodeActionDetail struct

+ Name string

+ NodeID uint64

+ TaskID uint64

+ type NodeDetail struct

+ ID int64

+ Name string

+ Recognition *RecognitionDetail

+ RunCompleted bool

+ type NodeNextListDetail struct

+ Name string

+ NextList []string

+ TaskID uint64

+ type NodeRecognitionDetail struct

+ Name string

+ RecID uint64

+ TaskID uint64

+ type Notification interface

+ OnControllerAction func(notifyType NotificationType, detail ControllerActionDetail)

+ OnResourceLoading func(notifyType NotificationType, detail ResourceLoadingDetail)

+ OnTaskAction func(notifyType NotificationType, detail NodeActionDetail)

+ OnTaskNextList func(notifyType NotificationType, detail NodeNextListDetail)

+ OnTaskRecognition func(notifyType NotificationType, detail NodeRecognitionDetail)

+ OnTaskerTask func(notifyType NotificationType, detail TaskerTaskDetail)

+ OnUnknownNotification func(msg, detailsJSON string)

+ type NotificationType int

+ const NotificationTypeFailed

+ const NotificationTypeStarting

+ const NotificationTypeSucceeded

+ const NotificationTypeUnknown

+ type RecognitionDetail struct

+ Algorithm string

+ Box Rect

+ DetailJson string

+ Draws []image.Image

+ Hit bool

+ ID int64

+ Name string

+ Raw image.Image

+ type Rect = buffer.Rect

+ type Resource struct

+ func NewResource(notify Notification) *Resource

+ func (r *Resource) Clear() bool

+ func (r *Resource) ClearCustomAction() bool

+ func (r *Resource) ClearCustomRecognition() bool

+ func (r *Resource) Destroy()

+ func (r *Resource) GetHash() (string, bool)

+ func (r *Resource) GetNodeList() ([]string, bool)

+ func (r *Resource) Loaded() bool

+ func (r *Resource) PostBundle(path string) *Job

+ func (r *Resource) RegisterCustomAction(name string, action CustomAction) bool

+ func (r *Resource) RegisterCustomRecognition(name string, recognition CustomRecognition) bool

+ func (r *Resource) UnregisterCustomAction(name string) bool

+ func (r *Resource) UnregisterCustomRecognition(name string) bool

+ func (r *Resource) UseAutoExecutionProvider() bool

+ func (r *Resource) UseCPU() bool

+ func (r *Resource) UseCoreml(coremlFlag InterenceDevice) bool

+ func (r *Resource) UseDirectml(deviceID InterenceDevice) bool

+ type ResourceLoadingDetail struct

+ Hash string

+ Path string

+ ResID uint64

+ type Status int32

+ const StatusFailure

+ const StatusInvalid

+ const StatusPending

+ const StatusRunning

+ const StatusSuccess

+ func (status Status) Done() bool

+ func (status Status) Failure() bool

+ func (status Status) Invalid() bool

+ func (status Status) Pending() bool

+ func (status Status) Running() bool

+ func (status Status) Success() bool

+ type TaskDetail struct

+ Entry string

+ ID int64

+ NodeDetails []*NodeDetail

+ Status Status

+ type TaskJob struct

+ func NewTaskJob(id int64, statusFunc func(id int64) Status, waitFunc func(id int64) Status, ...) *TaskJob

+ func (j *TaskJob) GetDetail() *TaskDetail

+ func (j *TaskJob) Wait() *TaskJob

+ type Tasker struct

+ func NewTasker(notify Notification) *Tasker

+ func (t *Tasker) BindController(ctrl Controller) bool

+ func (t *Tasker) BindResource(res *Resource) bool

+ func (t *Tasker) ClearCache() bool

+ func (t *Tasker) Destroy()

+ func (t *Tasker) GetController() Controller

+ func (t *Tasker) GetLatestNode(taskName string) *NodeDetail

+ func (t *Tasker) GetResource() *Resource

+ func (t *Tasker) Initialized() bool

+ func (t *Tasker) PostStop() *TaskJob

+ func (t *Tasker) PostTask(entry string, override ...any) *TaskJob

+ func (t *Tasker) Running() bool

+ type TaskerTaskDetail struct

+ Entry string

+ Hash string

+ TaskID uint64

+ UUID string

+ type Toolkit struct

+ func NewToolkit() *Toolkit

+ func (t *Toolkit) ClearPICustom(instId uint64)

+ func (t *Toolkit) ConfigInitOption(userPath, defaultJson string) bool

+ func (t *Toolkit) FindAdbDevices(specifiedAdb ...string) []*AdbDevice

+ func (t *Toolkit) FindDesktopWindows() []*DesktopWindow

+ func (t *Toolkit) RegisterPICustomAction(instId uint64, name string, action CustomAction)

+ func (t *Toolkit) RegisterPICustomRecognition(instId uint64, name string, recognition CustomRecognition)

+ func (t *Toolkit) RunCli(instId uint64, resourcePath, userPath string, directly bool, ...) bool

+ type Win32InputMethod uint64

+ const Win32InputMethodNone

+ const Win32InputMethodSeize

+ const Win32InputMethodSendMessage

+ type Win32ScreencapMethod uint64

+ const Win32ScreencapMethodDXGIDesktopDup

+ const Win32ScreencapMethodFramePool

+ const Win32ScreencapMethodGDI

+ const Win32ScreencapMethodNone

Other modules containing this package

github.com/MaaXYZ/maa-framework-go

github.com/MaaXYZ/maa-framework-go/v3

github.com/MaaXYZ/maa-framework-go/v4

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL