Files
Pumpkin/README.md
Alexander Medvedev 7bff068dff fix: discord links
2026-06-09 16:49:32 +02:00

115 lines
3.5 KiB
Markdown

<div align="center">
# Pumpkin
![CI](https://github.com/Pumpkin-MC/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: GPL](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://opensource.org/licenses/gpl-3-0)
</div>
[Pumpkin](https://pumpkinmc.org/) 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.
<div align="center">
![chunk loading](/assets/pumpkin_chunk_loading.webp)
</div>
## Goals
- **Performance**: Leveraging multi-threading for maximum speed and efficiency.
- **Compatibility**: Supports the latest Java & Bedrock Minecraft server version while adhering 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.
> [!IMPORTANT]
> Pumpkin is currently under heavy development.
>
> [See what needs to be done before the 1.0.0 Release](https://github.com/Pumpkin-MC/Pumpkin/issues/449)
## Features
- [x] Configuration (toml)
- [Tracking: Protocol](https://github.com/Pumpkin-MC/Pumpkin/issues/1401)
- [x] Server Status/Ping
- [x] Encryption
- [x] Packet Compression
- [x] Java/Bedrock
- ...
- [Tracking: World](https://github.com/Pumpkin-MC/Pumpkin/issues/1403)
- [x] Player Tab-list
- [x] Scoreboard
- [x] World Loading
- [x] World Time
- [x] World Borders
- [x] World Saving
- [x] Lighting
- [x] Entity Spawning
- [x] Bossbar
- [x] Chunk Loading (Vanilla, Linear, Pump)
- [Chunk Generation](https://github.com/Pumpkin-MC/Pumpkin/issues/36)
- [x] Chunk Saving (Vanilla, Linear, Pump)
- [Redstone](https://github.com/Pumpkin-MC/Pumpkin/issues/1402)
- [x] Liquid Physics
- ...
- [Tracking: Player](https://github.com/Pumpkin-MC/Pumpkin/issues/1405)
- [x] Skins
- [x] Teleport
- [x] Movement
- [x] Animation
- [x] Inventory
- [Combat](https://github.com/Pumpkin-MC/Pumpkin/issues/1404)
- [x] Experience
- [x] Hunger
- [X] Off Hand
- [ ] Advancements
- [x] Eating
- ...
- Entities
- [x] Non-Living (Minecart, Eggs...) (W.I.P)
- [x] Entity Effects
- [x] Players
- [x] Mobs (W.I.P)
- [x] Animals (W.I.P)
- [Entity AI](https://github.com/Pumpkin-MC/Pumpkin/issues/1406)
- [x] Boss
- [ ] Villagers
- [X] Entity Saving
- Server
- [Plugins](https://github.com/Pumpkin-MC/Pumpkin/issues/1407)
- [x] Query
- [x] RCON
- [x] Inventories
- [x] Particles
- [x] Chat
- [Commands](https://github.com/Pumpkin-MC/Pumpkin/issues/15)
- [x] Permissions
- [x] Translations
- Proxy
- [x] Bungeecord
- [x] Velocity
<!-- Check out our [Github Project](https://github.com/orgs/Pumpkin-MC/projects/3) to see current progress. -->
## How to run
See our [Quick Start](https://docs.pumpkinmc.org/#quick-start) guide to get Pumpkin running.
## Contributions
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)
## Docs
Pumpkin's documentation can be found at <https://pumpkinmc.org/>
## Communication
Consider joining [our Discord server](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/Pumpkin-MC).