Remove: World Generation from README

I see people thinking Pumpkin does not have Chunk generation when they see that. What i actually meant was that there is no world folder structure saved. Pumpkin has Chunk generation
This commit is contained in:
Snowiiii
2024-10-16 09:09:39 +02:00
parent e222feb0c9
commit 5de4b808f0
4 changed files with 73 additions and 74 deletions

View File

@@ -48,7 +48,6 @@ and customizable experience. It prioritizes performance and player enjoyment whi
- [x] World Loading
- [x] Entity Spawning
- [x] Chunk Loading
- [ ] World Generation
- [x] Chunk Generation
- [ ] World Borders
- [ ] World Saving

View File

@@ -1,4 +1,4 @@
# Benchmarks
## Benchmarks
Here, I compare common Minecraft servers against Pumpkin.
@@ -12,9 +12,9 @@ ALL SERVERS USED ITS OWN TERRAIN GENERATION, NO WORLD WAS PRE-LOADED
![Screenshot From 2024-10-15 16-42-53](https://github.com/user-attachments/assets/e08fbb00-42fe-4479-a03b-11bb6886c91a)
# Specifications
## Specifications
## Technical
#### Technical
**Software**
@@ -41,7 +41,7 @@ ALL SERVERS USED ITS OWN TERRAIN GENERATION, NO WORLD WAS PRE-LOADED
- JRE Version: OpenJDK Runtime Environment (build 23+37)
- Vendor: Oracle
## Game
#### Game
- Minecraft version: 1.21.1
- View distance: 10
@@ -51,7 +51,7 @@ ALL SERVERS USED ITS OWN TERRAIN GENERATION, NO WORLD WAS PRE-LOADED
<sub><sup>online mode was disabled, so i can easier test with non premium accounts</sup></sub>
# Pumpkin
## Pumpkin
Build: [8febc50](https://github.com/Snowiiii/Pumpkin/commit/8febc5035d5611558c13505b7724e6ca284e0ada)
@@ -75,7 +75,7 @@ Run args:
<sub><sup>pumpkin does cache already loaded chunks, resulting in no extra RAM besides player data and minimal CPU usage</sup></sub>
# Vanilla
## Vanilla
Release: [1.21.1](https://piston-data.mojang.com/v1/objects/59353fb40c36d304f2035d51e7d6e6baa98dc05c/server.jar)
@@ -97,7 +97,7 @@ Run args: `nogui`
| 5 | 1.8GB | 2,0% | 20,0% |
| 10 | 2,2GB | 4,0% | 24,0% |
# Paper
## Paper
Build: [122](https://api.papermc.io/v2/projects/paper/versions/1.21.1/builds/122/downloads/paper-1.21.1-122.jar)
@@ -119,7 +119,7 @@ Run args: `nogui`
| 5 | 1.9GB | 1.5% | 15,0% |
| 10 | 2GB | 3,0% | 20,0% |
# Purpur
## Purpur
Build: [2324](https://api.purpurmc.org/v2/purpur/1.21.1/2324/download)
@@ -141,7 +141,7 @@ Run args: `nogui`
| 5 | 1.9GB | 1.6% | 20,0% |
| 10 | 2.2GB | 2-2,5,0% | 26,0% |
# Minestom
## Minestom
Commit: [0ca1dda2fe](https://github.com/Minestom/Minestom/commit/0ca1dda2fe11390a1b89a228bbe7bf78fefc73e1)

View File

@@ -1,6 +1,6 @@
### Advanced Configuration
# Advanced Configuration
### Proxy
## Proxy
`proxy`
@@ -10,7 +10,7 @@ Wether Proxy Configuration is enabled
enabled=false
```
#### Velocity
### Velocity
`proxy.velocity`
@@ -23,7 +23,7 @@ Wether [Velocity](https://papermc.io/software/velocity) Proxy is enabled
enabled=false
```
##### Velocity Secret
#### Velocity Secret
This secret is used to ensure that player info forwarded by Velocity comes from your proxy and not from someone pretending to run Velocity
@@ -31,7 +31,7 @@ This secret is used to ensure that player info forwarded by Velocity comes from
secret=
```
### Authentication
## Authentication
`authentication`
@@ -41,7 +41,7 @@ Wether Authentication is enabled
enabled=false
```
#### Authentication URL
### Authentication URL
The Authentication URL being used
@@ -54,7 +54,7 @@ The Authentication URL being used
auth_url="https://sessionserver.mojang.com/session/minecraft/hasJoined?username={username}&serverId={server_hash}"
```
#### Prevent Proxy Connections
### Prevent Proxy Connections
Prevent proxy connections
@@ -62,7 +62,7 @@ Prevent proxy connections
prevent_proxy_connections=false
```
#### Prevent Proxy Connections URL
### Prevent Proxy Connections URL
The Authentication URL being used
@@ -77,11 +77,11 @@ The Authentication URL being used
prevent_proxy_connection_auth_url = "https://sessionserver.mojang.com/session/minecraft/hasJoined?username={username}&serverId={server_hash}&ip={ip}"
```
#### Player Profile
### Player Profile
`authentication.player_profile`
##### Allow Banned Players
#### Allow Banned Players
Allow players flagged by Mojang (banned, forced name change)
@@ -89,7 +89,7 @@ Allow players flagged by Mojang (banned, forced name change)
allow_banned_players=false
```
##### Allowed Actions
#### Allowed Actions
Depends on the value above
@@ -102,7 +102,7 @@ FORCED_NAME_CHANGE
USING_BANNED_SKIN
```
#### Textures
### Textures
`authentication.textures`
@@ -112,7 +112,7 @@ Whether to filter/validate player textures (e.g. Skins/Capes)
enabled=true
```
##### Allowed URL Schemes
#### Allowed URL Schemes
Allowed URL Schemes for Textures
@@ -120,7 +120,7 @@ Allowed URL Schemes for Textures
allowed_url_schemes=["http", "https"]
```
##### Allowed URL Domains
#### Allowed URL Domains
Allowed URL domains for Textures
@@ -128,11 +128,11 @@ Allowed URL domains for Textures
allowed_url_domains=[".minecraft.net", ".mojang.com"]
```
#### Texture Types
### Texture Types
`authentication.textures.types`
##### Skin
#### Skin
Use player skins
@@ -140,7 +140,7 @@ Use player skins
skin=true
```
##### Cape
#### Cape
Use player capes
@@ -148,7 +148,7 @@ Use player capes
cape=true
```
##### Elytra
#### Elytra
Use player elytras
(i didn't know myself that there are custom elytras)
@@ -157,7 +157,7 @@ Use player elytras
elytra=true
```
### Compression
## Compression
`packet_compression`
@@ -167,9 +167,9 @@ Wether Packet Compression is enabled
enable=true
```
#### Compression Info
### Compression Info
##### Threshold
#### Threshold
The compression threshold used when compression is enabled
@@ -177,7 +177,7 @@ The compression threshold used when compression is enabled
threshold=256
```
##### Level
#### Level
The Compression Level
@@ -192,7 +192,7 @@ The Compression Level
level=4
```
### Resource Pack
## Resource Pack
`resource_pack`
@@ -202,7 +202,7 @@ Wether a Resource Pack is enabled
enable=false
```
#### Resource Pack URL
### Resource Pack URL
The download URL of the resource pack
@@ -210,7 +210,7 @@ The download URL of the resource pack
resource_pack_url=
```
#### Resource Pack SHA1
### Resource Pack SHA1
The SHA1 hash (40) of the resource pack
@@ -218,7 +218,7 @@ The SHA1 hash (40) of the resource pack
resource_pack_sha1=
```
#### Prompt Message
### Prompt Message
Custom prompt Text component, Leave blank for none
@@ -226,7 +226,7 @@ Custom prompt Text component, Leave blank for none
prompt_message=
```
#### Force
### Force
Will force the Player to accept the resource pack
@@ -234,11 +234,11 @@ Will force the Player to accept the resource pack
force=false
```
### Commands
## Commands
`commands`
#### Use Console
### Use Console
Are commands from the Console accepted
@@ -246,7 +246,7 @@ Are commands from the Console accepted
use_console=true
```
#### Log Console
### Log Console
Should be commands from players be logged in console
@@ -254,7 +254,7 @@ Should be commands from players be logged in console
log_console=true
```
### RCON Config
## RCON Config
`rcon`
@@ -264,7 +264,7 @@ Wether RCON is enabled
enable=false
```
#### Address
### Address
The network address and port where the RCON server will listen for connections
@@ -272,7 +272,7 @@ The network address and port where the RCON server will listen for connections
address=false
```
#### Password
### Password
The password required for RCON authentication
@@ -280,7 +280,7 @@ The password required for RCON authentication
password=
```
#### Maximum Connections
### Maximum Connections
The maximum number of concurrent RCON connections allowed
@@ -290,11 +290,11 @@ If 0 there is no limit
max_connections=0
```
#### RCON Logging
### RCON Logging
`rcon.logging`
##### Logged Successfully
#### Logged Successfully
Whether successful RCON logins should be logged
@@ -302,7 +302,7 @@ Whether successful RCON logins should be logged
log_logged_successfully=true
```
##### Wrong Password
#### Wrong Password
Whether failed RCON login attempts with incorrect passwords should be logged
@@ -310,7 +310,7 @@ Whether failed RCON login attempts with incorrect passwords should be logged
log_wrong_password=true
```
##### Commands
#### Commands
Whether all RCON commands, regardless of success or failure, should be logged
@@ -318,7 +318,7 @@ Whether all RCON commands, regardless of success or failure, should be logged
log_commands=true
```
##### Disconnect
#### Disconnect
Whether RCON client quit should be logged
@@ -326,7 +326,7 @@ Whether RCON client quit should be logged
log_quit=true
```
### PVP
## PVP
`pvp`
@@ -336,7 +336,7 @@ Whether PVP is enabled
enable=true
```
#### Hurt Animation
### Hurt Animation
Do we want to have the Red hurt animation & fov bobbing
@@ -344,7 +344,7 @@ Do we want to have the Red hurt animation & fov bobbing
hurt_animation=true
```
#### Protect Creative
### Protect Creative
Should players in creative be protected against PVP
@@ -352,7 +352,7 @@ Should players in creative be protected against PVP
protect_creative=true
```
#### Knockback
### Knockback
Has PVP Knockback (Velocity)
@@ -360,7 +360,7 @@ Has PVP Knockback (Velocity)
knockback=true
```
#### Swing
### Swing
Should player swing when attacking
@@ -368,7 +368,7 @@ Should player swing when attacking
swing=true
```
### Logging
## Logging
`logging`
Whether Logging is enabled
@@ -377,7 +377,7 @@ Whether Logging is enabled
enable=true
```
#### Level
### Level
At which level should be logged
@@ -394,7 +394,7 @@ Debug
Trace
```
#### Env
### Env
Enables the user to choose log level by setting `RUST_LOG=<level>` environment variable
@@ -402,7 +402,7 @@ Enables the user to choose log level by setting `RUST_LOG=<level>` environment v
env=false
```
#### Threads
### Threads
Should threads be printed in the message
@@ -410,7 +410,7 @@ Should threads be printed in the message
threads=true
```
#### Color
### Color
Should color be enabled for logging messages
@@ -418,7 +418,7 @@ Should color be enabled for logging messages
color=true
```
#### Timestamp
### Timestamp
Should the timestamp be printed in the message

View File

@@ -1,8 +1,8 @@
### Basic Configuration
# Basic Configuration
Representing `configuration.toml`
### Server Address
## Server Address
The address to bind the server to
@@ -10,7 +10,7 @@ The address to bind the server to
server_address=0.0.0.0
```
### Seed
## Seed
The seed for world generation
@@ -18,7 +18,7 @@ The seed for world generation
seed=
```
### Max players
## Max players
The maximum number of players allowed on the server
@@ -26,7 +26,7 @@ The maximum number of players allowed on the server
max_players=10000
```
### View distance
## View distance
The maximum view distance for players
@@ -34,7 +34,7 @@ The maximum view distance for players
view_distance=10
```
### Simulation distance
## Simulation distance
The maximum simulation distance for players
@@ -42,7 +42,7 @@ The maximum simulation distance for players
simulation_distance=10
```
### Default difficulty
## Default difficulty
The default game difficulty
@@ -57,7 +57,7 @@ Normal
Hard
```
### Allow nether
## Allow nether
Whether the Nether dimension is enabled
@@ -65,7 +65,7 @@ Whether the Nether dimension is enabled
allow_nether=true
```
### Hardcore
## Hardcore
Whether the server is in hardcore mode.
@@ -73,7 +73,7 @@ Whether the server is in hardcore mode.
hardcore=true
```
### Online Mode
## Online Mode
Whether online mode is enabled. Requires valid Minecraft accounts
@@ -81,7 +81,7 @@ Whether online mode is enabled. Requires valid Minecraft accounts
online_mode=true
```
### Encryption
## Encryption
Whether packet encryption is enabled
@@ -92,7 +92,7 @@ Whether packet encryption is enabled
encryption=true
```
### Motd
## Motd
The server's description displayed on the status screen.
@@ -100,7 +100,7 @@ The server's description displayed on the status screen.
motd=true
```
### Default gamemode
## Default gamemode
The default game mode for players
@@ -116,7 +116,7 @@ Adventure
Spectator
```
### IP Scrubbing
## IP Scrubbing
Whether to scrub player IPs from logs