mcph#

Support Ukraine Build Status codecov Documentation Build Status Code style: black Python support versions badge (from pypi)

Minecraft plugin helper, updates and checks versions of all plugins on a server!

The project is archived#

I have no interest in continuing the project, as I no longer build servers in Minecraft. While I could build such software well, I just don’t need this. If you want to use something same, look at pluGET (this is originally their idea) or mineflake (same idea, but instead of managing already downloaded plugins, you can build an entire container for the server, where every plugin is compiled from sources during the build!).

Features#

  • Nice and powerful documentation!

  • Easy management plugins in simple commands!

  • Easy readable and supportable code!

  • Support for Spigotmc.org plugins!

Installing#

pip install mcph

Installing for local developing#

git clone https://github.com/PerchunPak/mcph.git
cd mcph

Installing poetry#

Next we need install poetry with recommended way.

If you use Linux, use command:

curl -sSL https://install.python-poetry.org | python -

If you use Windows, open PowerShell with admin privileges and use:

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -

Installing dependencies#

poetry install --no-dev

Configuration#

All configuration happens in config.yml, or with enviroment variables.

If something is not clear#

You can always write me!

Example#

Check updates for all plugins:

~ $ mcph check all .

┌────────────────────────────────────────────────────────────────────────────────┐
│ Num         Name          Current Version   Last Version  Update Available │
+─────+────────────────────+───────────────────+──────────────+──────────────────+
│  1         AuthMe        5.6.0-beta2-b2453  5.6.0-beta2        False       │
│  2        ClearLag             3.2.2           v3.2.2          False       │
│  3          CMI               9.0.2.9         1.1.2.4           True       │
│  4         CMILib             1.0.3.11        1.1.2.4           True       │
│  5      CoreProtect             20.1            21.2            True       │
│  6   FastAsyncWorldEdit   1.17-380;ee0d1b5   Not Found          None       │
│  7     Geyser-Spigot       1.4.3-SNAPSHOT    Not Found          None       │
│  8       LuckPerms             5.3.74          5.4.0            True       │
└────────────────────────────────────────────────────────────────────────────────┘

Updating#

For updating, just run pip install -U mcph. Or if you installed this for developing - git pull.

Thanks#

This project was generated with fire-square-style.

Pages#

API Reference

Indexes and tables#