Metadata-Version: 2.1
Name: OrzMC
Version: 1.0.19
Summary: A project for deployment of minecraft game.
Home-page: https://github.com/OrzGeeker/OrzMC.git
Author: 王志舟<wangzhizhou>
Author-email: 824219521@qq.com
Maintainer: 王志舟
Maintainer-email: 824219521@qq.com
License: UNKNOWN
Description: # 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
        
        ```bash
        (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
        
        ![Minecraft-Client](screenshots/minecraft-client.png)
        
        ### run the client normally with latest version and default username
        
        ```bash
        $ pip install orzmc
        $ orzmc
        ```
        ![orzmc](screenshots/orzmc.png)
        
        ### if you know the client version and your username
        
        ```bash
        $ 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`
        
        ```bash
        $ 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
        
        ```bash
        $ pip install orzmc
        $ orzmc -s -m 512M -x 2G -v 1.13.2
        ```
        
        ### you can also deploy the spigot minecraft server with option `-o`
        
        ```bash
        $ 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
        
        - [x] add Spigot Server deploy option
        - [x] 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
        
        - [SpigotMC](https://www.spigotmc.org/)
        
        # Videos
        
        - [A Brief Introduction for the project](https://youtu.be/gx-JeoW2K5I)
        
Keywords: minecraft python
Platform: all
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=2.7, <4
Description-Content-Type: text/markdown
