docs: add troubleshooting

docs/.vitepress/config.mts

@@ -41,6 +41,12 @@ export default defineConfig({
           { text: "Advanced", link: "/config/advanced" },
         ],
       },
+      {
+        text: "Troubleshooting",
+        items: [
+          { text: "Common Issues", link: "/troubleshooting/common_issues.md" },
+        ],
+      },
     ],
 
     socialLinks: [

docs/config/introduction.md

@@ -1,13 +1,16 @@
 ### Configuration
+
 Pumpkin offers a robust configuration system that allows users to customize various aspects of the server's behavior without relying on external plugins. This provides flexibility and control over the server's operation.
 
 ### Basic / Advanced
+
 Pumpkin's Configuration is split into a basic Configuration made for quick changes and important changes and a more Advanced Configuration
 
 - `configuration.toml`: simple and can be compared to the vanilla `server.properties`.
 - `features.toml`: designed to have all features of pumpkin at one place, making it a large configuration
 
 #### Key Features:
-    - Extensive Customization: Configure server settings, player behavior, world generation, and more.
+
-    - Performance Optimization: Optimize server performance through configuration tweaks.
+- Extensive Customization: Configure server settings, player behavior, world generation, and more.
-    - Plugin-Free Customization: Achieve desired changes without the need for additional plugins.
+- Performance Optimization: Optimize server performance through configuration tweaks.
+- Plugin-Free Customization: Achieve desired changes without the need for additional plugins.

docs/developer/authentication.md

@@ -34,58 +34,40 @@ To ensure a player has a premium accounts:
 
 Pumpkin does support custom Authentication servers, You can replace the Authentication URL in `features.toml`.
 
-Pumpkin Authentication works like this (Mojang/Custom):
+#### How Pumpkin Authentication Works
 
-1. GET Request > Authentication
+1. **GET Request:** Pumpkin sends a GET request to the specified authentication URL.
 
-2. Status Code 200 > Successfull
+2. **Status Code 200:** If the authentication is successful, the server responds with a status code of 200.
 
-3. Successfull > Parse JSON Game Profile
+3. **Parse JSON Game Profile:** Pumpkin parses the JSON game profile returned in the response.
 
 #### Game Profile
 
 ```rust
-id: UUID
+struct GameProfile {
-```
+    id: UUID,
-
+    name: String,
-```rust
+    properties: Vec<Property>,
-name: String
+    profile_actions: Option<Vec<ProfileAction>>, // Optional, Only present when actions are applied
-```
+}
-
-```rust
-properties: Array<Property>
-```
-
-> [!IMPORTANT]
-> Optional, Only present when actions are taken
-
-```rust
-profile_actions: Array<ProfileAction>
 ```
 
 ##### Property
 
 ```rust
-name: String
+struct Property {
-```
+    name: String,
-
+    value: String, // Base64 encoded
-> [!IMPORTANT]
+    signature: Option<String>, // Optional, Base64 encoded
-> base 64
+}
-
-```rust
-- value: String
-```
-
-> [!IMPORTANT]
-> Optional, base 64
-
-```rust
-- signature: String
 ```
 
 ##### Profile Action
 
 ```rust
-FORCED_NAME_CHANGE
+enum ProfileAction {
-USING_BANNED_SKIN
+    FORCED_NAME_CHANGE,
+    USING_BANNED_SKIN,
+}
 ```

docs/developer/introduction.md

@@ -5,4 +5,4 @@ Welcome to the Pumpkin Documentation!
 Whether you're an internal Pumpkin developer or working on a Pumpkin plugin, this documentation is your resource for everything Pumpkin.
 
 > [!IMPORTANT]
-> While Pumpkin currently doesn't have plugin support, this documentation provides valuable insights into the platform's architecture and functionality, which can be helpful for understanding how to create potential future plugins.
+> While Pumpkin currently doesn't have plugin support yet, this documentation provides valuable insights into the platform's architecture and functionality, which can be helpful for understanding how to create potential future plugins.

docs/troubleshooting/common_issues.md

@@ -0,0 +1,33 @@
+### Common Issues
+
+1. ### Broken Chunk Lighting
+
+   See [#93](https://github.com/Snowiiii/Pumpkin/issues/93)
+
+   **Issue:** Broken chunk lighting in your Minecraft server.
+
+   **Cause:** The server is currently not calculating lighting for chunks, we working on that.
+
+   **Temporary Fix:** Use a full-bright resource pack. This will temporarily resolve the issue by making all chunks appear brightly lit. You can find many full-bright resource packs online.
+
+2. ### I can place blocks inside me
+
+   See [#49](https://github.com/Snowiiii/Pumpkin/issues/49)
+
+   **Issue:** Players are able to place block in them.
+
+   **Cause:** The server is currently not calculating hitboxes for blocks, we working on that.
+
+3. ### Server is unresponsive
+
+   **Issue:** You have to wait before reconnect or can't do basic things while chunks are loading.
+
+   **Cause:** The server has currently blocking issues, we working on that.
+
+4. ### Failed to verify username
+
+   **Issue:** Some players reported having issues loggin into the Server, Having "Failed to verify username" error.
+
+   **Cause:** This has to do with Authentication, Usally with the prevent proxy connections setting.
+
+   **Fix:** Disable `prevent_proxy_connections` in `features.toml`

package-lock.json

@@ -5,7 +5,7 @@
   "packages": {
     "": {
       "devDependencies": {
-        "vitepress": "^1.4.0",
+        "vitepress": "^1.4.1",
         "vue": "^3.5.12"
       }
     },
@@ -2446,9 +2446,9 @@
       }
     },
     "node_modules/vitepress": {
-      "version": "1.4.0",
+      "version": "1.4.1",
-      "resolved": "https://registry.npmjs.org/vitepress/-/vitepress-1.4.0.tgz",
+      "resolved": "https://registry.npmjs.org/vitepress/-/vitepress-1.4.1.tgz",
-      "integrity": "sha512-JXCv4EsKTDyAFb6C/UjZr7nsGAzZ6mafVk2rx7rG5o8N+B/4QstIk+iEOe/9dKoU6V624UIC6g1pZ+K63rxhlw==",
+      "integrity": "sha512-C2rQ7PMlDVqgsaHOa0uJtgGGWaGv74QMaGL62lxKbtFkYtosJB5HAfZ8+pEbfzzvLemYaYwaiQdFLBlexK2sFw==",
       "dev": true,
       "license": "MIT",
       "dependencies": {
@@ -2460,7 +2460,7 @@
         "@types/markdown-it": "^14.1.2",
         "@vitejs/plugin-vue": "^5.1.4",
         "@vue/devtools-api": "^7.4.6",
-        "@vue/shared": "^3.5.11",
+        "@vue/shared": "^3.5.12",
         "@vueuse/core": "^11.1.0",
         "@vueuse/integrations": "^11.1.0",
         "focus-trap": "^7.6.0",
@@ -2468,7 +2468,7 @@
         "minisearch": "^7.1.0",
         "shiki": "^1.22.0",
         "vite": "^5.4.8",
-        "vue": "^3.5.11"
+        "vue": "^3.5.12"
       },
       "bin": {
         "vitepress": "bin/vitepress.js"

package.json

@@ -5,7 +5,7 @@
     "docs:preview": "vitepress preview docs"
   },
   "devDependencies": {
-    "vitepress": "^1.4.0",
+    "vitepress": "^1.4.1",
     "vue": "^3.5.12"
   }
 }