From 7c22cdd158c9a1fa15d0311b904c17c9a4abd48f Mon Sep 17 00:00:00 2001 From: RTAkland Date: Thu, 10 Sep 2026 02:27:05 +0800 Subject: [PATCH] Update docs & README --- README.md | 4 ++++ docs/{Get-started.md => Protocol.md} | 4 ++-- docs/README.md | 2 ++ 3 files changed, 8 insertions(+), 2 deletions(-) rename docs/{Get-started.md => Protocol.md} (97%) diff --git a/README.md b/README.md index b3db259..5038784 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,10 @@ A lightweight minecraft client-side protocol library for Kotlin Native and JVM | | Linux ARM64 | **Not Tested** | | **macOS** | macOS ARM64 (Silicon) | **Not Tested** | +# Get started + +[LibMC Document](docs/README.md) + # Minecraft Protocol Library Status ## Implementation details diff --git a/docs/Get-started.md b/docs/Protocol.md similarity index 97% rename from docs/Get-started.md rename to docs/Protocol.md index 9b26912..72dd22b 100644 --- a/docs/Get-started.md +++ b/docs/Protocol.md @@ -92,11 +92,11 @@ fun main() { socketEngine = KtorNetworkEngine() } ) - cli.session.onEvent { + cli.onEvent { println(status()) disconnect() } - cli.session.onEvent { + cli.onEvent { println(it.reason.toJsonString()) } cli.connect() diff --git a/docs/README.md b/docs/README.md index 687b389..00eaa40 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,6 +18,8 @@ module relies on the following dependencies: # Protocol +[Protocol](Protocol.md) + > `libmc-protocol` is current under development. It only supports the latest Minecraft version > (Current supported Minecraft version: `26.2`, Protocol Version Number: `776`)