From ba1ba66f1d2b9d86ed06e8239db5361db59f3efe Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 17 Apr 2025 23:51:10 +0200 Subject: [PATCH] docs: Enhance documentation for concept --- docs/src/product-direction/concepts/concepts.md | 8 +++++++- .../concepts/fancynpcs/fancynpcs.md | 2 +- .../tools/lightweight-minecraft-client-sdk.md | 17 ++++++++++++++++- .../concepts/tools/modrinth-sdk.md | 3 --- .../concepts/tools/plugin-testing-framework.md | 12 +++++++++++- 5 files changed, 35 insertions(+), 7 deletions(-) delete mode 100644 docs/src/product-direction/concepts/tools/modrinth-sdk.md diff --git a/docs/src/product-direction/concepts/concepts.md b/docs/src/product-direction/concepts/concepts.md index b5459f05..c7aebab6 100644 --- a/docs/src/product-direction/concepts/concepts.md +++ b/docs/src/product-direction/concepts/concepts.md @@ -1,3 +1,9 @@ --- icon: book ---- \ No newline at end of file +--- + +# Concepts + +Here you can find concepts of upcoming features and ideas that are being discussed in the community. +These concepts are not yet implemented, but they provide a glimpse into the future direction of the project. +We welcome feedback and suggestions on these concepts, so please feel free to share your thoughts. \ No newline at end of file diff --git a/docs/src/product-direction/concepts/fancynpcs/fancynpcs.md b/docs/src/product-direction/concepts/fancynpcs/fancynpcs.md index d9fa40c8..980ee351 100644 --- a/docs/src/product-direction/concepts/fancynpcs/fancynpcs.md +++ b/docs/src/product-direction/concepts/fancynpcs/fancynpcs.md @@ -1,5 +1,5 @@ --- -redirect: custom-models.md +redirect: action-scripting --- # FancyNpcs \ No newline at end of file diff --git a/docs/src/product-direction/concepts/tools/lightweight-minecraft-client-sdk.md b/docs/src/product-direction/concepts/tools/lightweight-minecraft-client-sdk.md index 9532e824..b449bce6 100644 --- a/docs/src/product-direction/concepts/tools/lightweight-minecraft-client-sdk.md +++ b/docs/src/product-direction/concepts/tools/lightweight-minecraft-client-sdk.md @@ -1,3 +1,18 @@ # Lightweight Minecraft Client SDK -TODO \ No newline at end of file +## Problem + +We need a lightweight Minecraft Client which can easily run in GitHub Actions or other CI systems to run e2e tests. + +## Solution + +The solution is to create a lightweight Minecraft Client SDK that can be used in GitHub Actions or other CI systems to run e2e tests. +The SDK should be able to have the basic functionality of a Minecraft Client: +- Connect to a Minecraft server +- Run commands +- Interact with the world and entities +- Send and receive packets + +The SDK should provide a simple API that can be used to interact with the Minecraft server. + +The SDK should have an easy way to get notified of any incoming packets from the server, to test our packet library. diff --git a/docs/src/product-direction/concepts/tools/modrinth-sdk.md b/docs/src/product-direction/concepts/tools/modrinth-sdk.md deleted file mode 100644 index 4d67aef1..00000000 --- a/docs/src/product-direction/concepts/tools/modrinth-sdk.md +++ /dev/null @@ -1,3 +0,0 @@ -# Modrinth SDK - -TODO \ No newline at end of file diff --git a/docs/src/product-direction/concepts/tools/plugin-testing-framework.md b/docs/src/product-direction/concepts/tools/plugin-testing-framework.md index 2541c276..c6feabe0 100644 --- a/docs/src/product-direction/concepts/tools/plugin-testing-framework.md +++ b/docs/src/product-direction/concepts/tools/plugin-testing-framework.md @@ -1,3 +1,13 @@ # Plugin Testing Framework -TODO \ No newline at end of file +The Plugin Testing Framework is a tool that allows developers to test their plugins in a controlled environment. +It provides a set of tools and libraries that make it easy to create and run tests for plugins, ensuring that they work as expected and do not introduce any bugs or issues. + +**Workflow:** +1. Start a Minecraft server with the plugin installed. +2. Let a [lightweight minecraft client](lightweight-minecraft-client-sdk.md) connect to the server. +3. Run tests +4. Assert results (e.g., if the correct packets were sent) +5. Stop the server and the client + +This process can be automated using GitHub Actions or other CI systems, allowing developers to run tests automatically whenever they make changes to their plugins. \ No newline at end of file