0
0
mirror of https://github.com/Snowiiii/Pumpkin.git synced 2024-11-23 12:26:16 +00:00
Pumpkin/README.md

106 lines
3.1 KiB
Markdown

<div align="center">
# 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.3-blue)
</div>
[Pumpkin](https://snowiiii.github.io/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)
## What Pumpkin wants to achieve
- **Performance**: Leveraging multi-threading for maximum speed and efficiency.
- **Compatibility**: Supports the latest Minecraft server version and adheres to vanilla game mechanics.
- **Security**: Prioritizes security by preventing known security exploits.
- **Flexibility**: Highly configurable, with the ability to disable unnecessary features.
- **Extensibility**: Provides a foundation for plugin development.
## What Pumpkin will not
- Be compatible with plugins or mods for other servers
- Function as a framework for building a server from scratch.
> [!IMPORTANT]
> Pumpkin is currently under heavy development.
## Features (WIP)
- [x] Configuration (toml)
- [x] Server Status/Ping
- Login
- [x] Encryption
- [x] Packet Compression
- Player Configuration
- [x] Registries (biome types, paintings, dimensions)
- [x] Server Brand
- [ ] Server Links
- [x] Set Resource Pack
- [ ] Cookies
- World
- [x] World Joining
- [x] Player Tab-list
- [x] World Loading
- [x] Lighting
- [x] Entity Spawning
- [x] Chunk Loading
- [x] Chunk Generation
- [ ] World Time
- [x] Scoreboard
- [x] World Borders
- [ ] World Saving
- Player
- [x] Player Skins
- [x] Player Client brand
- [x] Player Teleport
- [x] Player Movement
- [x] Player Animation
- [x] Player Inventory
- [x] Player Combat
- Entities
- [x] Players
- [ ] Mobs
- [ ] Animals
- [ ] Entity AI
- [ ] Minecart
- [ ] Boss
- Server
- [ ] Plugins
- [x] Query
- [x] RCON
- [x] Inventories
- [x] Particles
- [x] Chat
- [x] Commands
- Proxy
- [x] Bungeecord
- [x] Velocity
Check out our [Github Project](https://github.com/users/Snowiiii/projects/12/views/3) to see current progress
## How to run
See our [Quick Start](https://snowiiii.github.io/Pumpkin/about/quick-start.html) Guide to get Pumpkin running
## Contributions
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)
## Docs
The Documentation of Pumpkin can be found at https://snowiiii.github.io/Pumpkin/
## Communication
Consider joining our [discord](https://discord.gg/wT8XjrjKkf) to stay up-to-date on events, updates, and connect with other members.
## Funding
If you want to fund me and help the project, Check out my [GitHub sponsors](https://github.com/sponsors/Snowiiii) or my [PayPal](https://www.paypal.me/alexxmedvedev)