Move

Author: FTS427

docs/MinecraftLaunch/authenticators/index.md

@@ -0,0 +1,7 @@
+# 验证器
+
+账户信息是启动 Minecraft 的一个重要参数，没有账户信息您将无法正常启动游戏
+
+:::tip
+验证器模块在 3.0.0 以下需要安装 `MinecraftOAuth` 才能使用，而 3.0.0 以上版本则无需安装！
+:::

docs/MinecraftLaunch/authenticators/microsoft.md

@@ -0,0 +1,70 @@
+# 微软验证器
+
+微软验证器提供给用于 Minecraft 正版的用户，允许进入正版验证的服务器
+
+## 参数详解
+
+|   参数名  |         说明           |
+|:--------:|:---------------------:|
+| account  |        微软账户信息     |
+| clientId | 在 Azure 中获取的 AppID |
+
+- 初始化代码示例
+
+```cs
+//构造方法一 适用于设备流验证
+MicrosoftAuthenticator authenticator = new("Your Client ID");
+
+//构造方法一 适用于刷新验证
+MicrosoftAccount account;//此处的Account是您的旧的微软账户信息
+MicrosoftAuthenticator authenticator = new(account);
+```
+
+除此之外，验证器还提供了一个 'IsCheckOwnership' 属性用于确定是否检查游戏所有权
+
+## 获取验证代码以及 Microsoft 访问令牌
+
+在初始化完毕后即可获取验证代码
+
+- 代码示例
+
+```cs
+await authenticator.DeviceFlowAuthAsync(dc => {
+    //在获取到一次性代码后要执行的代码
+});
+```
+
+## 验证
+
+在获取访问令牌后即可开始验证步骤
+
+- 代码示例
+
+``` cs
+var userProfile = await authenticator.AuthenticateAsync();
+```
+
+在上述示例中，'AuthenticateAsync' 方法的返回值便是构建好的账户信息类，可以直接用于启动游戏
+
+## 完整示例
+
+- 代码示例
+
+``` cs
+//设备流验证
+MicrosoftAuthenticator authenticator = new("Your Client ID");
+await authenticator.DeviceFlowAuthAsync(dc => {
+    //在获取到一次性代码后要执行的代码
+    Console.WriteLine(dc.UserCode);
+});
+
+var userProfile = await authenticator.AuthenticateAsync();
+
+//刷新验证
+MicrosoftAuthenticator authenticator = new(account);//account为您的旧的微软账户信息
+var userProfile = await authenticator.AuthenticateAsync();
+```
+
+:::tip
+若出现 await 报错，请在您的方法中添加 async 关键字合理解决
+:::

docs/MinecraftLaunch/authenticators/offline.md

@@ -0,0 +1,41 @@
+# 离线验证器
+
+离线账户可以使没有购买 Minecraft 正版的用户游玩，但无法进入开了正版验证的服务器
+
+## 初始化验证器
+
+``` cs
+OfflineAuthenticator(string name, Guid uuid = default)
+```
+
+|参数名|说明     |
+|:---:|:------:|
+|name| 账户名   |
+|uuid| 账户的 Uuid，可以忽略 |
+
+- 初始化代码示例
+
+``` cs
+OfflineAuthenticator authenticator = new("Your name");
+```
+
+## 验证
+
+在初始化完毕后即可开始验证步骤
+
+- 代码示例
+
+``` cs
+var userProfile = authenticator.Authenticate();
+```
+
+在上述示例中，'Authenticate' 方法的返回值便是构建好的账户信息类，可以直接用于启动游戏
+
+## 完整示例
+
+- 代码示例
+
+``` cs
+OfflineAuthenticator authenticator = new("Yang114");
+var userProfile = authenticator.Authenticate();
+```

docs/MinecraftLaunch/authenticators/yggdrasil.md

@@ -0,0 +1,48 @@
+# 外置验证器
+
+此验证器适用于所有基于 [AuthLib-Injector](https://github.com/yushijinhun/authlib-injector) 的第三方验证服务（例如 LittleSkin）
+
+## 初始化验证器
+
+|参数名|说明|
+|:------:|:----:|
+|uri | 验证服务器地址 |
+|email | 用户账户邮件 |
+|password | 用户账户密码 |
+|account | 旧的 Yggdrasil 账户|
+
+- 初始化代码示例
+
+``` cs
+//刷新验证
+YggdrasilAuthenticator authenticator = new(account);//account为您的旧的Yggdrasil账户信息
+
+//请求验证
+YggdrasilAuthenticator authenticator = new("Server Url", "Your Email", "Your Password");
+```
+
+## 验证
+
+在初始化完毕后即可开始验证步骤
+
+- 代码示例
+
+``` cs
+var userProfile = await authenticator.AuthenticateAsync();
+```
+
+在上述示例中，'AuthenticateAsync' 方法的返回值便是构建好的所有账户信息类，可以直接用于启动游戏
+
+## 完整示例
+
+- 代码示例
+
+``` cs
+//刷新验证
+YggdrasilAuthenticator authenticator = new(account);//account为您的旧的Yggdrasil账户信息
+var userProfile = await authenticator.AuthenticateAsync();
+
+//请求验证
+YggdrasilAuthenticator authenticator = new("Server Url", "Your Email", "Your Password");
+var userProfile = await authenticator.AuthenticateAsync();
+```

docs/MinecraftLaunch/checkers/index.md

@@ -0,0 +1,3 @@
+# 检查器
+
+`ML` 提供了各式各样的检查器用来进行一些检查操作

docs/MinecraftLaunch/checkers/resource.md

@@ -0,0 +1,40 @@
+# 游戏资源检查器
+
+游戏资源检查器用于检查 Minecraft 游戏实例的依赖库以及资源文件是否缺失
+
+## 初始化检查器
+
+``` cs
+IChecker resourceChecker = new ResourceChecker(GameEntry entry);
+```
+
+- 参数详解
+
+|参数名|说明|
+|:------:|:----:|
+|entry | Minecraft 游戏实例 |
+
+## 开始检查
+
+在异步上下文中，使用 CheckAsync 来完成检查步骤：
+
+``` cs
+await resourceChecker.CheckAsync();
+```
+
+:::info
+在检查完成后 CheckAsync 方法会返回检查结果，如果返回值为 `false` 则可以通过类的 `MissingResources` 属性获取缺失的文件
+:::
+
+## 控制台示例
+
+为了满足一些懒狗的模块（
+
+``` cs
+IChecker resourceChecker = new ResourceChecker(GameEntry entry);
+var result = await resourceChecker.CheckAsync();
+
+if (!result) {
+    Console.WriteLine($"有资源缺失，总计 {resourceChecker.MissingResources.Count} 个");
+}
+```

docs/MinecraftLaunch/fetchers/curseforge.md

@@ -0,0 +1,37 @@
+# Curseforge 资源搜寻器
+
+它可以搜寻 [Curseforge](https://www.curseforge.com/minecraft) 上的任何资源
+
+:::tip
+在使用搜寻器前您需要先拥有 Curseforge 的 Api Key
+:::
+
+## 初始化
+
+``` cs
+CurseForgeFetcher(string apiKey)
+```
+
+|参数名|说明|
+|:------:|:----:|
+|apiKey | Curseforge 的 Api Key |
+
+- 初始化代码示例
+
+``` cs
+var curseForgeFetcher = new("Your Api Key");
+```
+
+## 搜索资源
+
+``` cs
+SearchResourcesAsync(string searchFilter, int classId = 6,  int category = -1, string gameVersion = null,  LoaderType modLoaderType = LoaderType.Any)
+```
+
+|参数名|说明|
+|:------:|:----:|
+|searchFilter | 要搜寻的资源名字，例如 “JEI” |
+|classId | 资源类别 |
+|category | 资源类别 |
+|gameVersion | 资源的 Minecraft 版本 |
+|modLoaderType | 资源的加载器类别 |

docs/MinecraftLaunch/fetchers/index.md

@@ -0,0 +1,3 @@
+# 搜寻器
+
+`ML` 提供了各式各样的搜寻器用来搜寻网络或本地的一些资源