diff --git a/README.md b/README.md index ced02586..2d951403 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,17 @@ # Pumpkin ![CI](https://github.com/Snowiiii/Pumpkin/actions/workflows/rust.yml/badge.svg) +[![Discord](https://img.shields.io/discord/1268592337445978193.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/wT8XjrjKkf) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![Current version)](https://img.shields.io/badge/current_version-1.21.1-blue) -Pumpkin is a Minecraft server built entirely in Rust, offering a fast, efficient, +Pumpkin is a Minecraft server built entirely in Rust, offering a fast, efficient, and customizable experience. It prioritizes performance and player enjoyment while adhering to the core mechanics of the game. ![image](https://github.com/user-attachments/assets/7e2e865e-b150-4675-a2d5-b52f9900378e) - -Pumpkin is currently under heavy development. - ### What Pumpkin wants to achive: - **Performance**: Leveraging multi-threading for maximum speed and efficiency. - **Compatibility**: Supports the latest Minecraft server version and adheres to vanilla game mechanics. @@ -27,6 +25,9 @@ Pumpkin is currently under heavy development. - A direct replacement for Vanilla or Bukkit servers. - A framework for building a server from scratch. +> [!IMPORTANT] +> Pumpkin is currently under heavy development. + ### Features (WIP) - [x] Configuration (toml) - [x] Server Status/Ping @@ -37,7 +38,7 @@ Pumpkin is currently under heavy development. - [ ] Server Links - [x] Set Resource Pack - [ ] Cookies -- World +- World - [x] World Joining - [x] Player Tab-list - [x] World Loading @@ -47,19 +48,20 @@ Pumpkin is currently under heavy development. - [ ] World Borders - [ ] World Saving - Player - - [x] Player Skin + - [x] Player Skins - [x] Player Client brand - [x] Player Teleport - [x] Player Movement - [x] Player Animation - [ ] Player Inventory - - [ ] Player Attack + - [x] Player Combat - Server - [x] RCON - [x] Inventories - [x] Chat - [x] Commands - +- Proxy + - [x] Velocity Check out our [Github Project](https://github.com/users/Snowiiii/projects/12/views/3) to see current progress ## How to run @@ -72,10 +74,13 @@ cd Pumpkin ``` You also may have to [install rust](https://www.rust-lang.org/tools/install) when you don't already have. +For Now, until we don't have own chunk generation. You need to pregenerate the world and place it inside of the Pumpkin/ directory. Make sure to generate chunks close to (0,0) since that is where the player gets spawned by default. Then run: +> [!NOTE] +> This can take a while. Because we enabled heavy optimations for release builds ``` cargo run --release ```