Skip to content

Commit

Permalink
Make this a Python package
Browse files Browse the repository at this point in the history
  • Loading branch information
fenhl committed Sep 30, 2017
1 parent 4bc8ca5 commit 9dd148c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
This is **a systemd init script for one or more Notchian (vanilla) [Minecraft][] servers**, with some [Wurstmineberg][]-specific extras.

This is version 3.2.5 ([semver][Semver]) of the init script. The versioned API includes a CLI, as found in the docstring of [`minecraft.py`](minecraft.py), as well as a Python API including all documented functions defined in minecraft.py.
This is version 4.0.0 ([semver][Semver]) of the init script. The versioned API includes a CLI, as found in the docstring of [`minecraft/__init__.py`](minecraft/__init__.py), as well as a Python API including all documented functions defined in that file.

Requirements
============
# Requirements

* systemd
* [Python][] 3.4
Expand All @@ -15,12 +14,11 @@ Requirements
* [more-itertools][MoreItertools] 2.1
* [requests][Requests] 2.1

Configuration
=============
# Configuration

1. Clone the repository somewhere on your system.
2. Create a symlink to `minecraft.py` in your Python 3 module search path or add the repository to the module search path.
3. Optionally, create a symlink to `minecraft.sh` called `minecraft` in your `PATH`. This will allow you to use commands like `minecraft update`.
2. Create a symlink to the `minecraft` directory in your Python 3 module search path or add the repository to the module search path.
3. Optionally, create a symlink to `minecraft/__init__.py` called `minecraft` in your `PATH`. This will allow you to use commands like `minecraft update`.
4. To immediately start the Minecraft server, `systemctl start minecraft`. To automatically start the Minecraft server with the system, `systemctl enable minecraft`.

To make this work for another server, you may have to modify the paths and other things in the config file.
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion version.py → minecraft/version.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

__version__ = None
try:
from _version import version as __version__
from minecraft._version import version as __version__
except ImportError:
from setuptools_scm import get_version
__version__ = get_version(root='.', relative_to=__file__)
Expand Down

0 comments on commit 9dd148c

Please sign in to comment.