Skip to content

py-mine/PyMine-Server

Repository files navigation

PyMine

discord

quality contributors code size build status code style

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

  • Windows & Linux Support - completed and always will be a thing
  • Joinable - completed, players can load into the world
  • Playable - currently a work in progress
  • Packet Models - missing some clientbound packets
  • 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
  • Plugin API - completed, but more will be added as the development continues
  • Command/Argument Parsing - parsers for primitive types and actual parsing has been completed
  • Query Support - completed
  • RCON Support - not started yet

Contributing

Installation / Usage

Check out the docs 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

API/Plugin Examples

Contributors ✨

Thanks goes to these wonderful people (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 specification. Contributions of any kind welcome!