add API references

AlphaBs · AlphaBs · commit 3adfd6df4c99 · 2025-11-26T01:57:17.000+09:00
diff --git a/en/INSTRUCTIONS.md b/en/INSTRUCTIONS.md
@@ -56,12 +56,16 @@ do the following:
 - API Reference
     - [CmlLib.Core](https://cmllib.github.io/CmlLib.Core/api/toc.html)
     - [CmlLib.Core.Commons](https://cmllib.github.io/CmlLib.Core.Commons/api/toc.html)
+    - [CmlLib.Core.Auth.Microsoft](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/toc.html)
+    - [CmlLib.Core.Installer.Forge](https://cmllib.github.io/CmlLib.Core.Installer.Forge/api/toc.html)
 - NuGet packages:
     - [CmlLib.Core](https://www.nuget.org/packages/CmlLib.Core)
     - [CmlLib.Core.Auth.Microsoft](https://www.nuget.org/packages/CmlLib.Core.Auth.Microsoft)
+    - [CmlLib.Core.Installer.Forge](https://www.nuget.org/packages/CmlLib.Core.Installer.Forge)
 - Source codes:
     - [CmlLib.Core](https://github.com/CmlLib/CmlLib.Core)
     - [CmlLib.Core.Auth.Microsoft](https://github.com/CmlLib/CmlLib.Core.Auth.Microsoft)
+    - [CmlLib.Core.Installer.Forge](https://github.com/CmlLib/CmlLib.Core.Installer.Forge)
 - LLM metadata:
     - [llms.txt](https://cmllib.github.io/CmlLib.Core-wiki/en/llms.txt)
     - [llms-full.txt](https://cmllib.github.io/CmlLib.Core-wiki/en/llms-full.txt)
diff --git a/en/auth.microsoft/README.md b/en/auth.microsoft/README.md
@@ -19,3 +19,11 @@ Provides functionality commonly used by `CmlLib.Core.Auth.Microsoft` and `CmlLib
 ## [XboxAuthNet.Game.Msal](xboxauthnet.game.msal/README.md)
 
 By default, `CmlLib.Core.Auth.Microsoft` and `CmlLib.Core.Bedrock.Auth` only work on Windows. `XboxAuthNet.Game.Msal` provides extensions for use on other platforms such as Linux and macOS.
+
+## API Reference
+
+For accurate type information, namespace, and method signatures, refer to the [API Reference](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/toc.html). When using with LLMs, make sure to include this URL as well.
+
+## LLM
+
+[llms.txt](https://cmllib.github.io/CmlLib.Core-wiki/en/llms.txt) is provided.
diff --git a/en/auth.microsoft/cmllib.core.auth.microsoft/authentication-with-msal.md b/en/auth.microsoft/cmllib.core.auth.microsoft/authentication-with-msal.md
@@ -82,3 +82,11 @@ var session = await authenticator.ExecuteForLauncherAsync();
 ```
 
 For more methods in MSAL, such as `msal.Interactive()`, `msal.Silent()`, and more, see [OAuth](../xboxauthnet.game.msal/oauth.md).
+
+## API Reference
+
+- [JELoginHandler](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.JELoginHandler.html)
+- [MsalClientHelper](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Msal.MsalClientHelper.html)
+- [MsalCodeFlowProvider](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Msal.OAuth.MsalCodeFlowProvider.html)
+- [MsalDeviceCodeProvider](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Msal.OAuth.MsalDeviceCodeProvider.html)
+- [MsalOAuthBuilder](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Msal.MsalOAuthBuilder.html)
diff --git a/en/auth.microsoft/cmllib.core.auth.microsoft/jeauthenticator.md b/en/auth.microsoft/cmllib.core.auth.microsoft/jeauthenticator.md
@@ -44,3 +44,8 @@ If the OAuth token is from third-party client id, you should register the client
 ### 404: NOT_FOUND
 
 The user doesn't have the game. (Demo version)
+
+## API Reference
+
+- [Extensions](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.Extensions.html)
+- [JEAuthenticatorBuilder](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.Authenticators.JEAuthenticatorBuilder.html)
diff --git a/en/auth.microsoft/cmllib.core.auth.microsoft/jeloginhandler.md b/en/auth.microsoft/cmllib.core.auth.microsoft/jeloginhandler.md
@@ -219,3 +219,11 @@ Set Xbox authentication mode. Instead of `xbox => xbox.Basic()`, there are many
 ### 4. JEAuthenticator
 
 Set Minecraft: JE authentication mode. See [JEAuthenticator](jeauthenticator.md).
+
+## API Reference
+
+- [JELoginHandler](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.JELoginHandler.html)
+- [Extensions](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.Extensions.html)
+- [JEAuthenticatorBuilder](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.Authenticators.JEAuthenticatorBuilder.html)
+- [JEGameAccount](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.Sessions.JEGameAccount.html)
+- [IXboxGameAccountManager](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Accounts.IXboxGameAccountManager.html)
diff --git a/en/auth.microsoft/cmllib.core.auth.microsoft/jeloginhandlerbuilder.md b/en/auth.microsoft/cmllib.core.auth.microsoft/jeloginhandlerbuilder.md
@@ -32,3 +32,9 @@ If you pass a string type, this method will call `WithAccountManager(new JsonXbo
 ### WithLogger
 
 Set [ILogger](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.ilogger?view=dotnet-plat-ext-7.0) for logging. This library use [Microsoft.Extensions.Logging](https://learn.microsoft.com/en-us/dotnet/core/extensions/logging?tabs=command-line) to logging.
+
+## API Reference
+
+- [JELoginHandler](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.JELoginHandler.html)
+- [JELoginHandlerBuilder](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.JELoginHandlerBuilder.html)
+- [IXboxGameAccountManager](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Accounts.IXboxGameAccountManager.html)
diff --git a/en/auth.microsoft/xboxauthnet.game.msal/clientid.md b/en/auth.microsoft/xboxauthnet.game.msal/clientid.md
@@ -45,6 +45,8 @@ Click 'Save' button
 
 ## 4. Register Client ID
 
+After creating your application in Azure, you need to allowlist your Client ID to prevent 403: FORBIDDEN errors from the Minecraft authentication API. Follow the guidance in the official Minecraft help article to ensure your application is recognized.
+
 https://help.minecraft.net/hc/en-us/articles/16254801392141
 
 https://github.com/CmlLib/CmlLib.Core.Auth.Microsoft/issues/16
diff --git a/en/auth.microsoft/xboxauthnet.game.msal/msalclienthelper.md b/en/auth.microsoft/xboxauthnet.game.msal/msalclienthelper.md
@@ -47,3 +47,7 @@ Create an `IPublicClientApplication` set up for Xbox authentication and return i
 ## ToMicrosoftOAuthResponse(AuthenticationResult result)
 
 Convert the MSAL login result, `AuthenticationResult`, to a `MicrosoftOAuthResponse` object used by `XboxAuthNet`.
+
+## API Reference
+
+- [MsalClientHelper](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Msal.MsalClientHelper.html)
diff --git a/en/auth.microsoft/xboxauthnet.game.msal/oauth.md b/en/auth.microsoft/xboxauthnet.game.msal/oauth.md
@@ -86,3 +86,7 @@ authenticator.AddMsalOAuth(app, msal => msal.FromResult(result));
 ```
 
 Use MSAL authentication result.
+
+## API Reference
+
+- [MsalOAuthBuilder](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Msal.MsalOAuthBuilder.html)
diff --git a/en/auth.microsoft/xboxauthnet.game/accountmanager.md b/en/auth.microsoft/xboxauthnet.game/accountmanager.md
@@ -49,3 +49,8 @@ loginHandler.AccountManager.ClearAccounts();
 ```csharp
 loginHandler.AccountManager.SaveAccounts();
 ```
+
+## API Reference
+
+- [JEGameAccount](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.Sessions.JEGameAccount.html)
+- [IXboxGameAccountManager](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Accounts.IXboxGameAccountManager.html)
diff --git a/en/auth.microsoft/xboxauthnet.game/accounts.md b/en/auth.microsoft/xboxauthnet.game/accounts.md
@@ -43,3 +43,8 @@ For example, `JEGameAccount`, which represents a Minecraft Java Edition account,
 Indicates the last time this account was accessed.
 
 ### XboxTokens
+
+## API Reference
+
+- [JEGameAccount](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/CmlLib.Core.Auth.Microsoft.Sessions.JEGameAccount.html)
+- [IXboxGameAccountManager](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.Accounts.IXboxGameAccountManager.html)
diff --git a/en/auth.microsoft/xboxauthnet.game/oauth.md b/en/auth.microsoft/xboxauthnet.game/oauth.md
@@ -89,3 +89,7 @@ authenticator.AddMicrosoftOAuthBrowserSignout(clientInfo, codeFlow =>
     codeFlow.WithUITitle("My Window");
 });
 ```
+
+## API Reference
+
+- [MicrosoftOAuthBuilder](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.OAuth.MicrosoftOAuthBuilder.html)
diff --git a/en/auth.microsoft/xboxauthnet.game/xboxauth.md b/en/auth.microsoft/xboxauthnet.game/xboxauth.md
@@ -62,3 +62,7 @@ When using a authentication method that gets a DeviceToken, you can apply the De
 There are various error scenarios when authenticating with Xbox. If an error occurs during authentication, an `XboxAuthException` is thrown and you can get an ErrorCode and ErrorMessage.
 
 All ErrorCodes can be found [XboxAuthException](xboxauthexception.md).
+
+## API Reference
+
+- [XboxAuthBuilder](https://cmllib.github.io/CmlLib.Core.Auth.Microsoft/api/XboxAuthNet.Game.XboxAuth.XboxAuthBuilder.html)
diff --git a/en/cmllib.core/README.md b/en/cmllib.core/README.md
@@ -17,7 +17,7 @@ CmlLib.Core is a .NET library for building your own **Custom Minecraft launcher*
 * Crossplatform (Windows, Linux, macOS)
 * Highly customizable launch flow
 
-## API References
+## API Reference
 
 For accurate type information, namespace, and method signatures, refer to the [API Reference](https://cmllib.github.io/CmlLib.Core/api/toc.html). When using with LLMs, make sure to include this URL as well.
 
diff --git a/en/cmllib.core/getting-started/Handling-Events.md b/en/cmllib.core/getting-started/Handling-Events.md
@@ -74,7 +74,7 @@ IProgress<InstallerProgressChangedEventArgs> fileProgress = new SyncProgress<Ins
 });
 ```
 
-## API References
+## API Reference
 
 - [MinecraftLauncher](https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.MinecraftLauncher.html)
 - [ByteProgress](https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.ByteProgress.html)
diff --git a/en/cmllib.core/getting-started/MLaunchOption.md b/en/cmllib.core/getting-started/MLaunchOption.md
@@ -215,6 +215,6 @@ Default arguments are:
 
 Set extra game arguments. See [MArgument](../more-apis/margument.md)
 
-## API References
+## API Reference
 
-- https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.ProcessBuilder.MLaunchOption.html
+- [MLaunchOption](https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.ProcessBuilder.MLaunchOption.html)
diff --git a/en/cmllib.core/getting-started/MinecraftPath.md b/en/cmllib.core/getting-started/MinecraftPath.md
@@ -122,6 +122,6 @@ class MyMinecraftPath : MinecraftPath
 }
 ```
 
-## API References
+# API Reference
 
 - [MinecraftPath](https://cmllib.github.io/CmlLib.Core.Commons/api/CmlLib.Core.MinecraftPath.html)
diff --git a/en/cmllib.core/getting-started/README.md b/en/cmllib.core/getting-started/README.md
@@ -9,5 +9,3 @@ The latest version of the library is 4.x.x. It is recommended to use the command
 ```
 dotnet add package CmlLib.Core
 ```
-
-Go to next part ->
diff --git a/en/cmllib.core/getting-started/versions.md b/en/cmllib.core/getting-started/versions.md
@@ -6,8 +6,8 @@ The `GetAllVersionsAsync` method returns all vanilla and locally installed versi
 
 ```csharp
 var launcher = new MinecraftLauncher();
-var versions = await launcher.GetAllVersionsAsync();
-foreach (var version in versions)
+VersionMetadataCollection versions = await launcher.GetAllVersionsAsync();
+foreach (IVersionMetadata version in versions)
 {
     Console.WriteLine("Name: " + version.Name);
     Console.WriteLine("Type: " + version.GetVersionType());
@@ -21,7 +21,7 @@ foreach (var version in versions)
 
 ```csharp
 var launcher = new MinecraftLauncher();
-var version = await launcher.GetVersionAsync("1.20.4");
+IVersion version = await launcher.GetVersionAsync("1.20.4");
 // version.Id
 // version.Jar
 // version.Libraries
@@ -36,7 +36,7 @@ In version 1.16.5, the Multiplayer button is disabled when launch the game with
 
 ```csharp
 var launcher = new MinecraftLauncher();
-var version = (await launcher.GetVersionAsync("1.16.5")).ToMutableVersion();
+MinecraftVersion version = (await launcher.GetVersionAsync("1.16.5")).ToMutableVersion();
 
 // remove existing authlib
 version.LibraryList.RemoveAt(version.LibraryList.FindIndex(lib => lib.Name == "com.mojang:authlib:2.1.28"));
@@ -61,9 +61,9 @@ var process = launcher.BuildProcess(version, new MLaunchOption
 process.Start(); 
 ```
 
-## API References
+## API Reference
 
-- https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.Version.IVersion.html
-- https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.VersionMetadata.VersionMetadataCollection.html
-- https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.VersionMetadata.IVersionMetadata.html
-- https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.VersionMetadata.MVersionType.html
+- [IVersion](https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.Version.IVersion.html)
+- [VersionMetadataCollection](https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.VersionMetadata.VersionMetadataCollection.html)
+- [IVersionMetadata](https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.VersionMetadata.IVersionMetadata.html)
+- [MVersionType](https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.VersionMetadata.MVersionType.html)
diff --git a/en/cmllib.core/utilities/processwrapper.md b/en/cmllib.core/utilities/processwrapper.md
@@ -42,4 +42,4 @@ else
 
 ## API Reference
 
-- https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.ProcessBuilder.ProcessWrapper.html
+- [ProcessWrapper](https://cmllib.github.io/CmlLib.Core/api/CmlLib.Core.ProcessBuilder.ProcessWrapper.html)
diff --git a/en/installer.forge/README.md b/en/installer.forge/README.md
@@ -10,3 +10,11 @@ Forge Installer for [CmlLib.Core](../cmllib.core/README.md).
 * Automatic change of links to install Forge
 * Automatic installation of the Vanilla version of Minecraft before installing Forge
 * Skipping the Forge re-installation
+
+## API Reference
+
+For accurate type information, namespace, and method signatures, refer to the [API Reference](https://cmllib.github.io/CmlLib.Core.Installer.Forge/api/toc.html). When using with LLMs, make sure to include this URL as well.
+
+## LLM
+
+[llms.txt](https://cmllib.github.io/CmlLib.Core-wiki/en/llms.txt) is provided.
diff --git a/en/installer.forge/forgeinstaller.md b/en/installer.forge/forgeinstaller.md
@@ -130,4 +130,9 @@ Our efforts are supported by ads from the download page.
 If you MUST automate this, please consider supporting the project through https://www.patreon.com/LexManos
 ```
 
-If you want to disable this behavior, you can modify the [ForgeInstaller source code](https://github.com/CmlLib/CmlLib.Core.Installer.Forge/blob/main/CmlLib.Core.Installer.Forge/ForgeInstaller.cs) yourself.
+If you want to disable this behavior, you can modify the [ForgeInstaller source code](https://github.com/CmlLib/CmlLib.Core.Installer.Forge/blob/main/CmlLib.Core.Installer.Forge/ForgeInstaller.cs) yourself.
+
+## API Reference
+
+- [ForgeInstaller](https://cmllib.github.io/CmlLib.Core.Installer.Forge/api/CmlLib.Core.Installer.Forge.ForgeInstaller.html)
+- [ForgeInstallOptions](https://cmllib.github.io/CmlLib.Core.Installer.Forge/api/CmlLib.Core.Installer.Forge.ForgeInstallOptions.html)
diff --git a/en/installer.forge/getting-started.md b/en/installer.forge/getting-started.md
@@ -54,3 +54,8 @@ await processUtil.WaitForExitTaskAsync();
 ## Sample Installer
 
 [SampleForgeInstaller](https://github.com/CmlLib/CmlLib.Core.Installer.Forge/blob/main/SampleForgeInstaller/Program.cs)
+
+## API Reference
+
+- [ForgeInstaller](https://cmllib.github.io/CmlLib.Core.Installer.Forge/api/CmlLib.Core.Installer.Forge.ForgeInstaller.html)
+- [ForgeInstallOptions](https://cmllib.github.io/CmlLib.Core.Installer.Forge/api/CmlLib.Core.Installer.Forge.ForgeInstallOptions.html)
diff --git a/ko/cmllib.core/getting-started/MinecraftPath.md b/ko/cmllib.core/getting-started/MinecraftPath.md
@@ -120,95 +120,4 @@ class MyMinecraftPath : MinecraftPath
     public override string GetLogConfigFilePath(string configId)
         => NormalizePath($"{Assets}/log_configs/{configId}" + (!configId.EndsWith(".xml") ? ".xml" : ""));
 }
-```
-
-## API References
-
-### Constructors
-
-??? abstract "Constructors"
-
-    **public MinecraftPath()**
-
-    기본 경로로 인스턴스를 초기화합니다.
-    `new MinecraftPath(MinecraftPath.GetOSDefaultPath())` 와 동일합니다.
-
-    **public MinecraftPath(string p)**
-
-    지정된 경로 `p`로 인스턴스를 초기화합니다.
-    `Initialize(p)` 와 `CreateDirs()` 를 호출합니다.
-
-### Properties
-
-??? abstract "Properties"
-
-    **BasePath**
-
-    *Type: string*
-
-    루트 디렉터리 경로
-
-    **Assets**
-
-    *Type: string*
-
-    **Library**
-
-    *Type: string*
-
-    **Versions**
-
-    *Type: string*
-
-    **Runtime**
-
-    *Type: string*
-
-    `MJava`의 기본 다운로드 경로
-
-    **Resource**
-
-    *Type: string*
-
-    구버전 마인크래프트에서 Assets 디렉터리로 사용하는 경로
-
-### Methods
-
-??? abstract "Methods"
-
-    **public void CreateDirs()**
-
-    `BasePath`, `Assets`, `Library`, `Versions`, `Runtime`, `Resource` 디렉터리를 생성합니다.
-
-    **public virtual string GetIndexFilePath(string assetId)**
-
-    에셋 인덱스 파일 경로를 가져옵니다.
-
-    **public virtual string GetAssetObjectPath(string assetId)**
-
-    에셋 객체 디렉터리 경로를 가져옵니다.
-
-    **public virtual string GetAssetLegacyPath(string assetId)**
-
-    에셋 레거시 디렉터리 경로를 가져옵니다.
-
-    **public virtual string GetVersionJarPath(string id)**
-
-    클라이언트 jar 파일 경로를 가져옵니다.
-
-    **public virtual string GetVersionJsonPath(string id)**
-
-    클라이언트 json 파일 경로를 가져옵니다.
-
-    **public virtual string GetNativePath(string id)**
-
-    네이티브 디렉터리 경로를 가져옵니다.
-    네이티브 dll 파일들이 여기에 저장됩니다.
-
-    **protected static string Dir(string path)**
-
-    `path`를 정규화하고 디렉터리를 생성합니다.
-
-    **protected static string NormalizePath(string path)**
-
-    `path`를 정규화합니다. 상대 경로를 절대 경로로 변환하고 잘못된 디렉터리 구분자를 교체합니다. (Windows에서는 `/`를 `\`로 교체)
+```
diff --git a/pyproject.toml b/pyproject.toml
@@ -30,7 +30,7 @@ dependencies = [
     "mkdocs-git-authors-plugin==0.10.0",
     "mkdocs-git-revision-date-localized-plugin==1.4.7",
     "mkdocs-literate-nav>=0.6.2",
-    "mkdocs-llmstxt",
+    "mkdocs-llmstxt>=0.5.0",
     "mkdocs-material==9.6.17",
     "mkdocs-material-extensions==1.3.1",
     "mkdocs-mermaid2-plugin==1.2.1",
@@ -53,6 +53,3 @@ dependencies = [
     "urllib3==2.5.0",
     "watchdog==6.0.0",
 ]
-
-[tool.uv.sources]
-mkdocs-llmstxt = { git = "https://github.com/AlphaBs/mkdocs-llmstxt" }
diff --git a/uv.lock b/uv.lock
