https://github.com/py-mine/PyMine-Server

A fast and easy to use, moddable, Python based Minecraft server!
https://github.com/py-mine/PyMine-Server

async async-networking asyncio java-edition mc mc-server mcje mcpy mcserver minecraft minecraft-server minecraftserver plugins plugins-api pymc pymine python pythonmine pythonminecraft server

Last synced: 10 months ago
JSON representation

A fast and easy to use, moddable, Python based Minecraft server!

• Host: GitHub
• URL: https://github.com/py-mine/PyMine-Server
• Owner: py-mine
• License: gpl-3.0
• Created: 2020-12-19T00:00:04.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2022-12-13T13:33:23.000Z (about 3 years ago)
• Last Synced: 2024-08-02T16:45:20.845Z (over 1 year ago)
• Topics: async, async-networking, asyncio, java-edition, mc, mc-server, mcje, mcpy, mcserver, minecraft, minecraft-server, minecraftserver, plugins, plugins-api, pymc, pymine, python, pythonmine, pythonminecraft, server
• Language: Python
• Homepage:
• Size: 46.3 MB
• Stars: 176
• Watchers: 18
• Forks: 33
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
#  PyMine

[![discord](https://img.shields.io/discord/936788458939224094.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/qcyufdMVQP)

![quality](https://www.codefactor.io/repository/github/py-mine/pymine-server/badge)

![contributors](https://img.shields.io/badge/dynamic/json?color=0FAE6E&label=contributors&query=contributors.length&url=https%3A%2F%2Fraw.githubusercontent.com%2Fpy-mine%2FPyMine%2Fmain%2F.all-contributorsrc)

![code size](https://img.shields.io/github/languages/code-size/py-mine/PyMine?color=0FAE6E)

![build status](https://img.shields.io/github/workflow/status/py-mine/PyMine/Python%20App?color=0FAE6E)

![code style](https://img.shields.io/badge/code%20style-black-000000.svg)

*PyMine - The fastest, easiest to use, Python-based Minecraft Server!*

## Features

*Note: This list is not always up to date, and doesn't contain all the features that PyMine offers*

- [X] **Windows & Linux Support** - *completed and always will be a thing*

- [x] **Joinable** - *completed, players can load into the world*

- [ ] **Playable** - *currently a work in progress*

- [ ] **Packet Models** - *missing some clientbound packets*

- [x] **Status + Login Logic** - *completed*

- [ ] **Play Logic** - *currently a work in progress*

- [ ] **World Generation** - *superflat world generation has been completed, normal world gen is a work in progress*

- [ ] **Entities/Entity AI** - *not started yet*

- [x] **Plugin API** - *completed, but more will be added as the development continues*

- [x] **Command/Argument Parsing** - *parsers for primitive types and actual parsing has been completed*

- [x] **Query Support** - *completed*

- [ ] **RCON Support** - *not started yet*

## Contributing

- We'd love to have your help! Please read [CONTRIBUTING.md](https://github.com/py-mine/PyMine/blob/main/CONTRIBUTING.md) to get started!

## Installation / Usage

*Check out [the docs](https://pymine.readthedocs.io/) for more info*

### Installing from source

- First, clone the repository `git clone https://github.com/py-mine/PyMine.git` and move into that directory (`cd PyMine`)

- Next, install the required Python packages via pip (`python3 -m pip install -r requirements.txt`, `poetry install`)

- To run the server, you should run `python3 pymine`.

- It is recommended you do not use regular Python, but [PyPy3](https://www.pypy.org/)

## API/Plugin Examples

- [example-plugin](https://github.com/py-mine/example-plugin) - *the official example plugin*

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Milo Weinberg
💻 🎨 🔌 🔣 🧑‍🏫 📖 💬 🐛 💡 🤔 📆 👀 ⚠️ 🚇

    
Sh-wayz
💻 🐛 📖 💡 💬 👀 ⚠️ 📆 🚇

    
Ammar-sys
📖

    
emerald
💻 👀 🤔 🐛 📆 ⚠️

    
Paul Przybyszewski
💻

    
Ashwin Vinod
🤔 💻 📖

    
imSofi
🐛

  

  

    
Kevin Thomas
🤔 💻

    
Milan Mehra
🤔

    
the456gamer
🤔 💻 🐛 🚇

    
Jendrik A. Potyka
🤔 💻 ⚠️

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!