Skip to content

Commit

Permalink
docs: add troubleshooting
Browse files Browse the repository at this point in the history
  • Loading branch information
Snowiiii committed Oct 13, 2024
1 parent 47f149d commit 033648b
Show file tree
Hide file tree
Showing 7 changed files with 72 additions and 48 deletions.
6 changes: 6 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ export default defineConfig({
{ text: "Advanced", link: "/config/advanced" },
],
},
{
text: "Troubleshooting",
items: [
{ text: "Common Issues", link: "/troubleshooting/common_issues.md" },
],
},
],

socialLinks: [
Expand Down
9 changes: 6 additions & 3 deletions docs/config/introduction.md
Original file line number Diff line number Diff line change
@@ -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.
- Plugin-Free Customization: Achieve desired changes without the need for additional plugins.

- Extensive Customization: Configure server settings, player behavior, world generation, and more.
- Performance Optimization: Optimize server performance through configuration tweaks.
- Plugin-Free Customization: Achieve desired changes without the need for additional plugins.
56 changes: 19 additions & 37 deletions docs/developer/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

```rust
name: String
```

```rust
properties: Array<Property>
```

> [!IMPORTANT]
> Optional, Only present when actions are taken
```rust
profile_actions: Array<ProfileAction>
struct GameProfile {
id: UUID,
name: String,
properties: Vec<Property>,
profile_actions: Option<Vec<ProfileAction>>, // Optional, Only present when actions are applied
}
```

##### Property

```rust
name: String
```

> [!IMPORTANT]
> base 64
```rust
- value: String
```

> [!IMPORTANT]
> Optional, base 64
```rust
- signature: String
struct Property {
name: String,
value: String, // Base64 encoded
signature: Option<String>, // Optional, Base64 encoded
}
```

##### Profile Action

```rust
FORCED_NAME_CHANGE
USING_BANNED_SKIN
enum ProfileAction {
FORCED_NAME_CHANGE,
USING_BANNED_SKIN,
}
```
2 changes: 1 addition & 1 deletion docs/developer/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
33 changes: 33 additions & 0 deletions docs/troubleshooting/common_issues.md
Original file line number Diff line number Diff line change
@@ -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`
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"docs:preview": "vitepress preview docs"
},
"devDependencies": {
"vitepress": "^1.4.0",
"vitepress": "^1.4.1",
"vue": "^3.5.12"
}
}

0 comments on commit 033648b

Please sign in to comment.