Skip to main content

(Deprecated) Module to control Minehut servers via Python

Project description

This module is deprecated as of the Minehut API being shut down.

Welcome to the Minefob documentation.

Here you will learn how to use Minefob.

Initialization

m = Minefob("foorbar@example.domain", "password", "my_server")

Initializing a new Minefob class instance requires 3 arguments:

  • Email associated with Minehut account
  • Password of the aforementioned account
  • and the server name

will return RunTimeError if server name is misspelled.

Post Commands

Say

m.say("Hey there")

Will print the desired message to the chat. Appears like this [Server] Hey there

Title

m.title("Big text", subwords="little text", fadeIn=0, hold=20, fadeOut=0)

Will summon a title. The big text title is the first argument and the subtitle as the second argument. Subtitle is not required. I have a feeling the fadeIn, hold, and fadeOut are self-explanatory, however you must know that the time is in Minecraft ticks (20 ticks = 1 sec.)

Kick

m.kick("@a", "because i wanted to")

Will kick the selected player(s). Use the second argument to provide a reason, if wanted.

Command

m.command("/give @r minecraft:diamonds 64")

Will run the desired command.

Save

m.save()

Saves server.

Awaken

m.awaken()

Wakes server from hibernation.

Slumber

m.slumber(17)

Will kick players, save server, and put it into hibernation AFTER a countdown. Length of countdown is determined by the only argument passed into this function. Leave at 0 to skip countdown and shut down instantly.

Properties

Players

>>> m.players
3

Returns the number of active players on the server.

Online

>>> m.online
False

Returns whether the server is online or not.

Status

>>> m.status
'SERVER-DOWNLOADING'

Returns the current status of the server, basically a more detailed version of m.online

Started

>>> m.started
[09, 34, 55]

Returns the time the server was started as a list in this format: [HH:MM:SS]

Stopped

>>> m.stopped
[10, 16, 37]

Returns the time the server was stopped as a list in this format: [HH:MM:SS]

Project details


Download files

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

Source Distribution

minefob-2.0.0.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

minefob-2.0.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file minefob-2.0.0.tar.gz.

File metadata

  • Download URL: minefob-2.0.0.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for minefob-2.0.0.tar.gz
Algorithm Hash digest
SHA256 4a22ba6bac29fc65e9dcc181b1175fc76cf3b3bd535bc57a9707e039a1219ac2
MD5 02da9e65a02375be825bbc6461a37775
BLAKE2b-256 5df273356a61b25b1db501f806095425cf698d6f0641956132aecf3b9a743648

See more details on using hashes here.

File details

Details for the file minefob-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: minefob-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for minefob-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5bc32834e3efdbd5dbcdca4692290e2d57da69129a4929503d91161a2dd8d7ae
MD5 1f1dee7d55dab332970703e2ff80e290
BLAKE2b-256 0011e86d12006f15bedcd7fe611cc096c5d47499da089c30e657a67603831f9a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page