OrzMC

A tool for deploying minecraft client and server

Only supports Python >=2.7, <4

Requires Java Runtime Environment to be configured!

Supported Minecraft Client Version

  • supports all versions of client

  • you should make sure the version of the minecraft server that you will connect to is the same as that of the client.

  • This Program has been uploaded into PyPI

Supported Operating System

  • mainly for MacOS.
  • Maybe can run on windows, as a backup schema.

Usage

You should have a jre runtime on you device

orzmc -h to check the help info

$ orzmc -h

    NAME

        orzmc -- A command line tool for start minecraft client or deploy minecraft server

    Usage

        orzmc [-v client_version_number] [-u username] [-h]

            -s, --server
                deploy minecraft server, if there is no this flag, this command line tool start minecraft as default

            -v, --version  
                Specified the Minecraft clinet version number to start

            -u, --username 
                pick an username for player when start the client

            -t, --game_type
                Specified the type of game: "pure"/"spigot"/"forge" for server, "pure/forge" for client

            -m, --mem_min
                Specified the JVM initial memory allocation

            -x, --mem_max
                Specified the JVM max memory allocation

            -V, --Verbose
                Output some debug info for bugfix

            -h, --help 
                show the command usage info

Run Client

Minecraft-Client

run the client normally with latest version and default username

$ pip install orzmc
$ orzmc

orzmc

if you know the client version and your username

$ pip install orzmc
$ orzmc -v 1.13.2 -u player_name

Deploy Server

use default setting to deploy the pure server

default set jvm initial memory alloc 512M, and max memory alloc 1024M

$ pip install orzmc
$ orzmc -s

you can specify the initial memory and max memory alloced for the jvm with options -s and -x to run the minecraft server

$ pip install orzmc
$ orzmc -s -m 512M -x 2G -v 1.13.2

you can also deploy the spigot/forge minecraft server with option -t

Spigot Server

$ pip install orzmc
$ orzmc -s -t spigot -m 512M -x 1G -v 1.13.2

Forge Server

$ pip install orzmc
$ orzmc -s -t forge -m 512M -x 1G -v 1.13.2

The game resources are saved under user's home directory, and named .minecraft

Tips

This is not a game for one player, so you should invit someone you like to make you guys own beautiful world!!!

TODO List

  • add Spigot Server deploy option
  • add a homepage for this project
  • add world backup function
  • refine the project script for readable
  • automation the process of installing JDK/JRE Runtime
  • add some unit test case to guarantee quality
  • create a Docker Mojang Mirror Server for personal CDN

Reference

Videos

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.0.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for wangzhizhou from gravatar.com wangzhizhou

Credits

Author/Maintainer: 王志舟<wangzhizhou>

License

Apache Software License

Requires

Python >=2.7, <4

Tags

minecraft python

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

OrzMC-1.0.20.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

OrzMC-1.0.20-py2.py3-none-any.whl (18.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file OrzMC-1.0.20.tar.gz.

File metadata

  • Download URL: OrzMC-1.0.20.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for OrzMC-1.0.20.tar.gz
Algorithm Hash digest
SHA256 731e589a4e279dcc82236c9674076e87fe1197d71edc6df455ff77b606cee33e
MD5 80f7f2a687731cf37320c5dba46b8ed2
BLAKE2b-256 56467b06682a5097f079ea13b1e078ddafc4a383b5cb1723ba339b2f90dc1aa1

See more details on using hashes here.

File details

Details for the file OrzMC-1.0.20-py2.py3-none-any.whl.

File metadata

  • Download URL: OrzMC-1.0.20-py2.py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for OrzMC-1.0.20-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7ed5e7ba65d7473913734d4a9a874dd183b0b58e5218771fb3e4a34cdd5b2783
MD5 d83a3b9425061977d461b3e95faff71c
BLAKE2b-256 c4e2f108a9a1f0f5349285e35396bcfe9a8affd1c0eb59ab8e816291650991b3

See more details on using hashes here.

Release history Release notifications | RSS feed

2.0.1

2 files

2.0.0

2 files

1.0.118

2 files

1.0.113

2 files

1.0.111

2 files

1.0.109

2 files

1.0.108

2 files

1.0.104

2 files

1.0.103

2 files

1.0.102

2 files

1.0.101

2 files

1.0.100

2 files

1.0.99

2 files

1.0.97

2 files

1.0.96

2 files

1.0.95

2 files

1.0.92

2 files

1.0.91

2 files

1.0.90

2 files

1.0.89

2 files

1.0.88

2 files

1.0.87

2 files

1.0.85

2 files

1.0.84

2 files

1.0.83

2 files

1.0.82

2 files

1.0.81

2 files

1.0.80

2 files

1.0.79

2 files

1.0.78

2 files

1.0.77

2 files

1.0.75

2 files

1.0.74

2 files

1.0.73

2 files

1.0.72

2 files

1.0.71

2 files

1.0.70

2 files

1.0.69

2 files

1.0.68

2 files

1.0.66

2 files

1.0.63

2 files

1.0.62

2 files

1.0.61

2 files

1.0.59

2 files

1.0.58

2 files

1.0.57

2 files

1.0.55

2 files

1.0.53

2 files

1.0.52

2 files

1.0.50

2 files

1.0.49

2 files

1.0.48

2 files

1.0.46

2 files

1.0.45

2 files

1.0.44

2 files

1.0.43

2 files

1.0.42

2 files

1.0.41

2 files

1.0.40

2 files

1.0.38

2 files

1.0.37

2 files

1.0.36

2 files

1.0.35

2 files

1.0.34

2 files

1.0.33

2 files

1.0.32

2 files

1.0.31

2 files

1.0.30

2 files

1.0.29

2 files

1.0.28

2 files

1.0.27

2 files

1.0.26

2 files

1.0.25

2 files

1.0.24

2 files

1.0.23

2 files

1.0.22

2 files

1.0.21

2 files

This release

1.0.20 This release

2 files

1.0.19

2 files

1.0.18

2 files

1.0.17

2 files

1.0.16

2 files

1.0.15

2 files

1.0.14

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page