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
(py3) $ 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 a
s 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, such as "pure"/"spigot"/"forge"
-m, --mem_min
Specified the JVM initial memory allocation
-x, --mem_max
Specified the JVM max memory allocation
-h, --help
show the command usage info
Run Client
run the client normally with latest version and default username
$ pip install 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 server
default set jvm initial memory alloc 512M, and max memory alloc 1024M
$ pip install orzmc
$ orzmc -s
The pure official server deploy directory located in the path: ~/.minecraft/deploy/
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 minecraft server with option -o
$ pip install orzmc
$ orzmc -s -t spigot -m 512M -x 1G -v 1.13.2
The Spigot Server deploy directory located in the path: ~/.minecraft/spigot/
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
Reference
Videos
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file OrzMC-1.0.19.tar.gz.
File metadata
- Download URL: OrzMC-1.0.19.tar.gz
- Upload date:
- Size: 12.0 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
33f4b24c9132547d8acf3579c55cab7eedee64b2c347df0c3519cb0d0ec607af
|
|
| MD5 |
36d3096e7790c8ae906878daa6668770
|
|
| BLAKE2b-256 |
6eb8f835f0c26c90fdbc567563420bb62328363d20bcaef8fd982c3e40dd8d54
|
File details
Details for the file OrzMC-1.0.19-py2.py3-none-any.whl.
File metadata
- Download URL: OrzMC-1.0.19-py2.py3-none-any.whl
- Upload date:
- Size: 18.3 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
440fafc0c5cfe7a743c3d5e85316d3a0e0873b84114d4450cd8fcb5fde8662f9
|
|
| MD5 |
2d8b01903fdc21e41a43e31b1ccbfd73
|
|
| BLAKE2b-256 |
32a2c3844149fe59729e590a68f081b40451756b55394678dab7e93e13218617
|
