Skip to content

Commit

Permalink
docs: add MaaFramework.Binding.CSharp
Browse files Browse the repository at this point in the history
  • Loading branch information
moomiji committed Jul 23, 2024
1 parent b80f5da commit ce435ae
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/en_us/2.1-Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@ Please refer to the [NodeJS documentation](https://github.com/neko-para/maa-node
## Golang

Please refer to the [Golang binding documentation](https://github.com/MaaXYZ/maa-framework-go/blob/main/README.md).

## CSharp

Please refer to the [CSharp binding documentation](https://maaxyz.github.io/MaaFramework.Binding.CSharp/)
9 changes: 8 additions & 1 deletion docs/en_us/2.3-CustomTask.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In addition to writing JSON according to the pipeline protocol for low-code deve
- [FFI (Foreign Function Interface)](#ffi)

MaaFramework provides C and Python API, and in theory, it supports all major languages.
However, it is currently only adapted to C and Python. You may need to write other languages ​​by yourself (we also welcome you to submit a PR after completing it!).
However, it is currently only adapted to C, CSharp, Python. You may need to write other languages ​​by yourself (we also welcome you to submit a PR after completing it!).
Advantages: Relatively high execution efficiency, more in line with standard programming paradigms.

- [Executor Agent](#executor-agent)
Expand Down Expand Up @@ -34,6 +34,13 @@ The `SyncContext` can be used to invoke more clicking, sliding, screenshot recog
- [SyncContext](https://github.com/MaaXYZ/MaaFramework/blob/main/source/binding/Python/maa/context.py)
- [Sample](https://github.com/MaaXYZ/MaaFramework/blob/main/sample/python/__main__.py#L49)

- CSharp
- [Custom Recognizer](https://maaxyz.github.io/MaaFramework.Binding.CSharp/api/MaaFramework.Binding.Custom.IMaaCustomAction.html)
- [Custom Action](https://maaxyz.github.io/MaaFramework.Binding.CSharp/api/MaaFramework.Binding.Custom.IMaaCustomController.html)
- [Registration](https://maaxyz.github.io/MaaFramework.Binding.CSharp/api/MaaFramework.Binding.IMaaInstance.Register.html)
- [SyncContext](https://maaxyz.github.io/MaaFramework.Binding.CSharp/api/MaaFramework.Binding.IMaaSyncContext.html)
- [Sample](https://maaxyz.github.io/MaaFramework.Binding.CSharp/index.html#custom)

## Executor Agent

### Launch Parameters
Expand Down
4 changes: 4 additions & 0 deletions docs/zh_cn/2.1-集成文档.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@
## Golang

请参考 [Golang 绑定文档](https://github.com/MaaXYZ/maa-framework-go/blob/main/README.md)

## C#

请参考 [C# 绑定文档](https://maaxyz.github.io/MaaFramework.Binding.CSharp/)
9 changes: 8 additions & 1 deletion docs/zh_cn/2.3-自定义任务.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [FFI(语言交互接口)](#ffi)

MaaFramework 提供了 C 和 Python API,且理论上支持所有主流语言。
但目前已适配的 Binding 较少,仅支持 C Python,其他语言可能需要您自行编写(也欢迎在写完后向我们提交 PR!)。
但目前已适配的 Binding 较少,仅支持 C, C#, Python,其他语言可能需要您自行编写(也欢迎在写完后向我们提交 PR!)。
优点:执行效率相对较高,更符合标准编程范式。

- [执行器代理](#执行器代理)
Expand Down Expand Up @@ -34,6 +34,13 @@
- [SyncContext](https://github.com/MaaXYZ/MaaFramework/blob/main/source/binding/Python/maa/context.py)
- [Sample](https://github.com/MaaXYZ/MaaFramework/blob/main/sample/python/__main__.py#L49)

- C#
- [自定义识别器](https://maaxyz.github.io/MaaFramework.Binding.CSharp/api/MaaFramework.Binding.Custom.IMaaCustomAction.html)
- [自定义动作](https://maaxyz.github.io/MaaFramework.Binding.CSharp/api/MaaFramework.Binding.Custom.IMaaCustomController.html)
- [注册接口](https://maaxyz.github.io/MaaFramework.Binding.CSharp/api/MaaFramework.Binding.IMaaInstance.Register.html)
- [SyncContext](https://maaxyz.github.io/MaaFramework.Binding.CSharp/api/MaaFramework.Binding.IMaaSyncContext.html)
- [Sample](https://maaxyz.github.io/MaaFramework.Binding.CSharp/index.html#custom)

## 执行器代理

### 启动参数
Expand Down

0 comments on commit ce435ae

Please sign in to comment.