Skip to content

Commit ba1ba66

Browse files
docs: Enhance documentation for concept
1 parent 57b1016 commit ba1ba66

5 files changed

Lines changed: 35 additions & 7 deletions

File tree

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
---
22
icon: book
3-
---
3+
---
4+
5+
# Concepts
6+
7+
Here you can find concepts of upcoming features and ideas that are being discussed in the community.
8+
These concepts are not yet implemented, but they provide a glimpse into the future direction of the project.
9+
We welcome feedback and suggestions on these concepts, so please feel free to share your thoughts.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
redirect: custom-models.md
2+
redirect: action-scripting
33
---
44

55
# FancyNpcs
Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
11
# Lightweight Minecraft Client SDK
22

3-
TODO
3+
## Problem
4+
5+
We need a lightweight Minecraft Client which can easily run in GitHub Actions or other CI systems to run e2e tests.
6+
7+
## Solution
8+
9+
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.
10+
The SDK should be able to have the basic functionality of a Minecraft Client:
11+
- Connect to a Minecraft server
12+
- Run commands
13+
- Interact with the world and entities
14+
- Send and receive packets
15+
16+
The SDK should provide a simple API that can be used to interact with the Minecraft server.
17+
18+
The SDK should have an easy way to get notified of any incoming packets from the server, to test our packet library.

docs/src/product-direction/concepts/tools/modrinth-sdk.md

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
11
# Plugin Testing Framework
22

3-
TODO
3+
The Plugin Testing Framework is a tool that allows developers to test their plugins in a controlled environment.
4+
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.
5+
6+
**Workflow:**
7+
1. Start a Minecraft server with the plugin installed.
8+
2. Let a [lightweight minecraft client](lightweight-minecraft-client-sdk.md) connect to the server.
9+
3. Run tests
10+
4. Assert results (e.g., if the correct packets were sent)
11+
5. Stop the server and the client
12+
13+
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.

0 commit comments

Comments
 (0)