calagoapi-minecraft 1.0.dev2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- calagoapi_minecraft/__init__.py +52 -0
- calagoapi_minecraft/aio.py +64 -0
- calagoapi_minecraft/bridge.py +86 -0
- calagoapi_minecraft/config.py +79 -0
- calagoapi_minecraft/exceptions.py +23 -0
- calagoapi_minecraft/extension.py +52 -0
- calagoapi_minecraft/manager.py +56 -0
- calagoapi_minecraft/properties.py +43 -0
- calagoapi_minecraft/server.py +631 -0
- calagoapi_minecraft/versions.py +232 -0
- calagoapi_minecraft-1.0.dev2.dist-info/METADATA +204 -0
- calagoapi_minecraft-1.0.dev2.dist-info/RECORD +15 -0
- calagoapi_minecraft-1.0.dev2.dist-info/WHEEL +5 -0
- calagoapi_minecraft-1.0.dev2.dist-info/entry_points.txt +2 -0
- calagoapi_minecraft-1.0.dev2.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,232 @@
|
|
|
1
|
+
'''
|
|
2
|
+
The Calagopus Minecraft Version Changer panel extension (dev.0x7d8.minecraftversionchanger).
|
|
3
|
+
|
|
4
|
+
server.versions.getTypes()
|
|
5
|
+
build = server.versions.getLatestBuild('PAPER', '1.21.11')
|
|
6
|
+
server.versions.install(build)
|
|
7
|
+
|
|
8
|
+
panel.minecraft.versionChanger.getSettings() # admin
|
|
9
|
+
'''
|
|
10
|
+
from calagoapi.api.client import segment
|
|
11
|
+
from calagoapi.utils.exceptions import InvalidActionError, NotFoundError
|
|
12
|
+
from calagoapi.utils.model import idOf
|
|
13
|
+
|
|
14
|
+
from calagoapi_minecraft.config import settings
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
# identifier of the panel extension
|
|
18
|
+
PANEL_EXTENSION = 'dev.0x7d8.minecraftversionchanger'
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class VersionChangerAPI:
|
|
22
|
+
'''
|
|
23
|
+
HTTP calls of the Version Changer. Uses the panel's client, so authentication,
|
|
24
|
+
retries and errors behave like the rest of CalagoAPI.
|
|
25
|
+
'''
|
|
26
|
+
def __init__(self, client):
|
|
27
|
+
self.client = client
|
|
28
|
+
|
|
29
|
+
def _path(self, server_id, suffix=''):
|
|
30
|
+
return f'/api/client/servers/{server_id}/minecraft/versions{suffix}'
|
|
31
|
+
|
|
32
|
+
# client endpoints
|
|
33
|
+
def installed(self, server_id):
|
|
34
|
+
return self.client.get(self._path(server_id, '/installed'))['build']
|
|
35
|
+
|
|
36
|
+
def types(self, server_id):
|
|
37
|
+
return self.client.get(self._path(server_id, '/types'))['types']
|
|
38
|
+
|
|
39
|
+
def versions(self, server_id, type, search=None, page=None, per_page=None):
|
|
40
|
+
return self.client.list(self._path(server_id, f'/types/{segment(type)}'), 'versions', {'search': search},
|
|
41
|
+
page, per_page)
|
|
42
|
+
|
|
43
|
+
def builds(self, server_id, type, version, search=None, page=None, per_page=None):
|
|
44
|
+
return self.client.list(self._path(server_id, f'/types/{segment(type)}/{segment(version)}'), 'builds',
|
|
45
|
+
{'search': search}, page, per_page)
|
|
46
|
+
|
|
47
|
+
def install(self, server_id, build_uuid, truncate_directory=False, accept_eula=True):
|
|
48
|
+
return self.client.post(self._path(server_id, '/install'), json={
|
|
49
|
+
'build_uuid': build_uuid,
|
|
50
|
+
'truncate_directory': truncate_directory,
|
|
51
|
+
'accept_eula': accept_eula,
|
|
52
|
+
})
|
|
53
|
+
|
|
54
|
+
# admin endpoints
|
|
55
|
+
def _admin(self, suffix, method='GET', json=None):
|
|
56
|
+
return self.client.request(method, f'/api/admin/extensions/{PANEL_EXTENSION}/{suffix}', json=json)
|
|
57
|
+
|
|
58
|
+
def settings(self):
|
|
59
|
+
return self._admin('settings')['settings']
|
|
60
|
+
|
|
61
|
+
def updateSettings(self, values):
|
|
62
|
+
return self._admin('settings', 'PUT', json=values)
|
|
63
|
+
|
|
64
|
+
def statistics(self):
|
|
65
|
+
return self._admin('statistics/total')
|
|
66
|
+
|
|
67
|
+
def defaultOrder(self):
|
|
68
|
+
return self._admin('default-order')['mcjars_type_order']
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
def _buildId(build):
|
|
72
|
+
return build.get('uuid') if isinstance(build, dict) else idOf(build)
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
class VersionManager:
|
|
76
|
+
'''
|
|
77
|
+
The Version Changer of one server, available as `server.versions`.
|
|
78
|
+
|
|
79
|
+
Needs the Minecraft Version Changer panel extension on the panel; without it the
|
|
80
|
+
calls raise NotFoundError (check with isAvailable()).
|
|
81
|
+
|
|
82
|
+
Example:
|
|
83
|
+
build = server.versions.getLatestBuild('PAPER', '1.21.11')
|
|
84
|
+
server.versions.install(build) # backs up first with auto_backup
|
|
85
|
+
if server.versions.isUpToDate() is False:
|
|
86
|
+
server.versions.update()
|
|
87
|
+
'''
|
|
88
|
+
def __init__(self, server):
|
|
89
|
+
self.server = server
|
|
90
|
+
|
|
91
|
+
def __repr__(self):
|
|
92
|
+
return f'<VersionManager of {self.server!r}>'
|
|
93
|
+
|
|
94
|
+
@property
|
|
95
|
+
def api(self) -> VersionChangerAPI:
|
|
96
|
+
return VersionChangerAPI(self.server.panel.client)
|
|
97
|
+
|
|
98
|
+
def isAvailable(self) -> bool:
|
|
99
|
+
'''Returns True if the Version Changer panel extension answers for this server.'''
|
|
100
|
+
try:
|
|
101
|
+
self.getTypes()
|
|
102
|
+
return True
|
|
103
|
+
except NotFoundError:
|
|
104
|
+
return False
|
|
105
|
+
|
|
106
|
+
def getInstalled(self) -> dict:
|
|
107
|
+
'''
|
|
108
|
+
Returns what the Version Changer knows about the installed build:
|
|
109
|
+
`{'build': {...}, 'latest': {...}}`, or None if it was not installed with it.
|
|
110
|
+
|
|
111
|
+
Example:
|
|
112
|
+
installed = server.versions.getInstalled()
|
|
113
|
+
if installed:
|
|
114
|
+
print(f'{installed["build"]["name"]}, latest: {installed["latest"]["name"]}')
|
|
115
|
+
'''
|
|
116
|
+
return self.api.installed(self.server.server_id)
|
|
117
|
+
|
|
118
|
+
def getInstalledBuild(self) -> dict:
|
|
119
|
+
'''Returns the installed build (type, name, version_id, ...), or None.'''
|
|
120
|
+
installed = self.getInstalled()
|
|
121
|
+
return installed.get('build') if installed else None
|
|
122
|
+
|
|
123
|
+
def isUpToDate(self) -> bool:
|
|
124
|
+
'''Returns True if the installed build is the newest of its version, None if unknown.'''
|
|
125
|
+
installed = self.getInstalled()
|
|
126
|
+
if not installed or not installed.get('build') or not installed.get('latest'):
|
|
127
|
+
return None
|
|
128
|
+
return installed['build'].get('uuid') == installed['latest'].get('uuid')
|
|
129
|
+
|
|
130
|
+
def getTypes(self) -> dict:
|
|
131
|
+
'''Returns the available server types (PAPER, PURPUR, FABRIC, VANILLA, ...).'''
|
|
132
|
+
return self.api.types(self.server.server_id)
|
|
133
|
+
|
|
134
|
+
def getVersions(self, type: str, search: str = None, page: int = None, per_page: int = None):
|
|
135
|
+
'''
|
|
136
|
+
Returns the Minecraft versions available for a server type.
|
|
137
|
+
|
|
138
|
+
Example:
|
|
139
|
+
server.versions.getVersions('PAPER', page=1, per_page=10)
|
|
140
|
+
'''
|
|
141
|
+
return self.api.versions(self.server.server_id, type, search, page, per_page)
|
|
142
|
+
|
|
143
|
+
def getBuilds(self, type: str, version: str, search: str = None, page: int = None, per_page: int = None):
|
|
144
|
+
'''
|
|
145
|
+
Returns the builds of a version, newest first.
|
|
146
|
+
|
|
147
|
+
Example:
|
|
148
|
+
builds = server.versions.getBuilds('PAPER', '1.21.11', page=1, per_page=5)
|
|
149
|
+
'''
|
|
150
|
+
return self.api.builds(self.server.server_id, type, version, search, page, per_page)
|
|
151
|
+
|
|
152
|
+
def getLatestBuild(self, type: str, version: str) -> dict:
|
|
153
|
+
'''Returns the newest build of a version, or None.'''
|
|
154
|
+
builds = self.getBuilds(type, version, page=1, per_page=1)
|
|
155
|
+
return builds[0] if builds else None
|
|
156
|
+
|
|
157
|
+
def install(self, build, truncate_directory: bool = False, accept_eula: bool = True, backup: bool = None) -> None:
|
|
158
|
+
'''
|
|
159
|
+
Installs a server build.
|
|
160
|
+
|
|
161
|
+
Args:
|
|
162
|
+
build: Build dict from getBuilds() or a build UUID.
|
|
163
|
+
truncate_directory: Delete every file first.
|
|
164
|
+
accept_eula: Accept the Minecraft EULA.
|
|
165
|
+
backup: Make a backup first and only install if it succeeded. None uses the
|
|
166
|
+
`auto_backup` config (default False).
|
|
167
|
+
|
|
168
|
+
Raises:
|
|
169
|
+
InvalidActionError: The backup failed; nothing was installed.
|
|
170
|
+
|
|
171
|
+
Example:
|
|
172
|
+
server.versions.install(server.versions.getLatestBuild('FABRIC', '26.2'), backup=True)
|
|
173
|
+
'''
|
|
174
|
+
config = settings()
|
|
175
|
+
build_id = _buildId(build)
|
|
176
|
+
if config['auto_backup'] if backup is None else backup:
|
|
177
|
+
created = self.server.backups.createBackup(name=config['backup_name'])
|
|
178
|
+
created.waitUntilComplete(timeout=config['backup_timeout'])
|
|
179
|
+
if not created.isSuccessful():
|
|
180
|
+
raise InvalidActionError(f'The backup before installing {build_id} failed; nothing was installed.')
|
|
181
|
+
return self.api.install(self.server.server_id, build_id, truncate_directory, accept_eula)
|
|
182
|
+
|
|
183
|
+
def update(self, truncate_directory: bool = False, backup: bool = None) -> bool:
|
|
184
|
+
'''
|
|
185
|
+
Installs the newest build of the installed version. Returns False if already up to date.
|
|
186
|
+
|
|
187
|
+
Raises:
|
|
188
|
+
InvalidActionError: The installed version is unknown (use install()).
|
|
189
|
+
'''
|
|
190
|
+
installed = self.getInstalled()
|
|
191
|
+
if not installed or not installed.get('latest'):
|
|
192
|
+
raise InvalidActionError('The installed version is unknown, use server.versions.install() instead.')
|
|
193
|
+
if installed.get('build') and installed['build'].get('uuid') == installed['latest'].get('uuid'):
|
|
194
|
+
return False
|
|
195
|
+
self.install(installed['latest'], truncate_directory=truncate_directory, backup=backup)
|
|
196
|
+
return True
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
class VersionChangerAdmin:
|
|
200
|
+
'''
|
|
201
|
+
Admin settings of the Version Changer panel extension, available as
|
|
202
|
+
`panel.minecraft.versionChanger` (admin API key required).
|
|
203
|
+
|
|
204
|
+
Example:
|
|
205
|
+
settings = panel.minecraft.versionChanger.getSettings()
|
|
206
|
+
panel.minecraft.versionChanger.updateSettings(mcjars_url='https://mcjars.app')
|
|
207
|
+
'''
|
|
208
|
+
def __init__(self, panel):
|
|
209
|
+
self.panel = panel
|
|
210
|
+
|
|
211
|
+
def __repr__(self):
|
|
212
|
+
return '<VersionChangerAdmin>'
|
|
213
|
+
|
|
214
|
+
@property
|
|
215
|
+
def api(self) -> VersionChangerAPI:
|
|
216
|
+
return VersionChangerAPI(self.panel.client)
|
|
217
|
+
|
|
218
|
+
def getSettings(self) -> dict:
|
|
219
|
+
'''Returns the Version Changer settings.'''
|
|
220
|
+
return self.api.settings()
|
|
221
|
+
|
|
222
|
+
def updateSettings(self, **values) -> None:
|
|
223
|
+
'''Changes settings (mcjars_url, mcjars_api_key, type_egg_assignments, ...).'''
|
|
224
|
+
return self.api.updateSettings(values)
|
|
225
|
+
|
|
226
|
+
def getStatistics(self) -> dict:
|
|
227
|
+
'''Returns install statistics by server type and version.'''
|
|
228
|
+
return self.api.statistics()
|
|
229
|
+
|
|
230
|
+
def getDefaultOrder(self) -> list:
|
|
231
|
+
'''Returns the default order of server types in the version picker.'''
|
|
232
|
+
return self.api.defaultOrder()
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: calagoapi-minecraft
|
|
3
|
+
Version: 1.0.dev2
|
|
4
|
+
Summary: Minecraft servers for CalagoAPI: commands with output, console streaming, players and metrics through HungerBridge, the Version Changer, server.properties.
|
|
5
|
+
Author: iFamished
|
|
6
|
+
License: GPL-3.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/HungerNet/CalagoAPI
|
|
8
|
+
Project-URL: Documentation, https://github.com/HungerNet/CalagoAPI/tree/main/docs/tutorials/minecraft
|
|
9
|
+
Project-URL: Source, https://github.com/HungerNet/CalagoAPI/tree/main/src/extensions/calagoapi-minecraft
|
|
10
|
+
Project-URL: HungerBridge, https://github.com/HungerNet/HungerBridge
|
|
11
|
+
Project-URL: HungerBridgePy, https://github.com/HungerNet/HungerBridgePy
|
|
12
|
+
Keywords: calagopus,calagoapi,minecraft,hungerbridge,paper,fabric,extension
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Development Status :: 4 - Beta
|
|
17
|
+
Classifier: Intended Audience :: Developers
|
|
18
|
+
Classifier: Topic :: Games/Entertainment
|
|
19
|
+
Requires-Python: >=3.9
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
Requires-Dist: calagoapi>=2.0.dev1
|
|
22
|
+
Requires-Dist: hungerbridge>=1.0.dev2
|
|
23
|
+
Requires-Dist: requests
|
|
24
|
+
|
|
25
|
+
# calagoapi-minecraft
|
|
26
|
+
|
|
27
|
+
Minecraft servers for [CalagoAPI](https://github.com/HungerNet/CalagoAPI), the Calagopus
|
|
28
|
+
panel SDK. `MinecraftServer` is a `calagoapi.Server` with Minecraft features:
|
|
29
|
+
|
|
30
|
+
- **commands with output** and **live console streaming** through
|
|
31
|
+
[HungerBridge](https://github.com/HungerNet/HungerBridge), the plugin/mod inside the
|
|
32
|
+
game, using [HungerBridgePy](https://github.com/HungerNet/HungerBridgePy);
|
|
33
|
+
- players, TPS/MSPT, world data and JVM information;
|
|
34
|
+
- the Calagopus **Minecraft Version Changer** (`server.versions`);
|
|
35
|
+
- `server.properties`, EULA, chat and moderation helpers;
|
|
36
|
+
- installing HungerBridge and creating its tokens through the panel.
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
pip install calagoapi calagoapi-minecraft # also installs hungerbridge (HungerBridgePy)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
```python
|
|
43
|
+
from calagoapi import Panel
|
|
44
|
+
from calagoapi.extensions import enable
|
|
45
|
+
|
|
46
|
+
enable('minecraft', config={'bridge_token': 'calagoapi:9f2c...'})
|
|
47
|
+
|
|
48
|
+
with Panel(url='https://panel.example.com', api_key='c7sp_...') as panel:
|
|
49
|
+
server = panel.minecraft.getServer('abc123', bridge_url='http://10.0.0.5:1913')
|
|
50
|
+
|
|
51
|
+
print(server.sendCommand('list')) # the command's output
|
|
52
|
+
for line in server.streamConsole(history=10, timeout=30):
|
|
53
|
+
print(line)
|
|
54
|
+
print(f'{server.getPlayerCount()} online, TPS {server.getTPS("1m")}')
|
|
55
|
+
print(f'container {server.getRAM()} MiB, heap {server.getMemoryInfo()["used"]:.0f} MiB')
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Learn it step by step in the [Minecraft tutorials](../../../docs/tutorials/README.md#track-3-minecraft);
|
|
59
|
+
runnable code is in [examples/minecraft/](../../../examples/minecraft/README.md).
|
|
60
|
+
|
|
61
|
+
## Two channels
|
|
62
|
+
|
|
63
|
+
| Channel | Used by |
|
|
64
|
+
| --- | --- |
|
|
65
|
+
| **Panel / daemon** (CalagoAPI) | everything inherited from `Server`: `start()`, `stop()`, `restart()`, `getRAM()`, `getCPU()`, `getStatus()`, files, backups, ...; plus `server.properties`, EULA, `server.versions`, `sendPanelCommand()`, `installBridge()`, `createBridgeToken()`, `server.console` |
|
|
66
|
+
| **HungerBridge** (HungerBridgePy, `server.bridge`) | `sendCommand()`, `streamConsole()`, `onConsoleLine()`, chat helpers, players, TPS/MSPT, world, JVM info, `writeLog()` |
|
|
67
|
+
|
|
68
|
+
Nothing falls back silently. Bridge methods without a token raise
|
|
69
|
+
`BridgeNotConfiguredError`; HungerBridge errors are raised as HungerBridgePy's
|
|
70
|
+
`hungerbridge.HungerBridgeError` subclasses (`HungerBridgeAuthError` with `.reason`,
|
|
71
|
+
`HungerBridgeForbidden`, `HungerBridgeNotFound`, `HungerBridgeRateLimit`,
|
|
72
|
+
`HungerBridgeConnectionError`).
|
|
73
|
+
|
|
74
|
+
## Getting a server
|
|
75
|
+
|
|
76
|
+
```python
|
|
77
|
+
server = panel.minecraft.getServer('abc123') # after enable('minecraft')
|
|
78
|
+
server = panel.minecraft.getServer('abc123', address='play.example.com', bridge_url=..., bridge_token=...)
|
|
79
|
+
server = panel.minecraft.fromServer(panel.servers.getServerByName('Survival'))
|
|
80
|
+
servers = panel.minecraft.getServers() # every visible server, as MinecraftServer
|
|
81
|
+
|
|
82
|
+
from calagoapi_minecraft import MinecraftServer # works without enable() too
|
|
83
|
+
server = MinecraftServer(panel, 'abc123', bridge_token='calagoapi:9f2c...')
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Connecting HungerBridge
|
|
87
|
+
|
|
88
|
+
| Method | Description |
|
|
89
|
+
| --- | --- |
|
|
90
|
+
| `installBridge(minecraft_version=None, loader=None, release=None, replace=True)` | download the right jar into `/plugins` or `/mods` (detects loader and version); returns a `hungerbridge.ReleaseAsset` |
|
|
91
|
+
| `findBridgeRelease(minecraft_version, loader, release=None)` | the jar without installing it |
|
|
92
|
+
| `createBridgeToken(token_id='calagoapi', policy='admin', expiry=None, timeout=30, url=None)` | run `hb token create` on the console, redeem the pickup, connect; returns `'id:secret'` |
|
|
93
|
+
| `redeemBridgePickup(pickup_url)` | redeem a pickup URL (or its `/pickup/...` part) and connect |
|
|
94
|
+
| `connectBridge(url=None, token=None, **options)` | set URL/token (and `BridgeClient` options such as `timeout`) for this server |
|
|
95
|
+
| `setBridge(client)`, `closeBridge()` | use your own `BridgeClient`; close connections |
|
|
96
|
+
| `bridge` | the `hungerbridge.BridgeClient` (the full HungerBridgePy API) |
|
|
97
|
+
| `getBridgeUrl()`, `hasBridge()`, `isBridgeReachable()`, `waitForBridge(timeout=120)` | |
|
|
98
|
+
| `getBridgeInfo()`, `getBridgeTokenInfo()`, `getPlatform()`, `getMinecraftVersion()` | `/server/meta`, `/auth/check` |
|
|
99
|
+
|
|
100
|
+
The bridge URL is `bridge_url`, else the `bridge_url` config, else the server's address
|
|
101
|
+
with `bridge_port` (1913). HungerBridge binds `127.0.0.1` by default. Set its
|
|
102
|
+
`bind-address` and `security.yaml` `ips` so your code can reach it.
|
|
103
|
+
|
|
104
|
+
## Commands and console
|
|
105
|
+
|
|
106
|
+
| Method | Description |
|
|
107
|
+
| --- | --- |
|
|
108
|
+
| `sendCommand(command, *, silent=False, showConsole=False)` | HungerBridgePy `runCommand()`: returns the output text, `None` when silent |
|
|
109
|
+
| `sendCommands(commands, *, silent=False, showConsole=False)` | list of outputs |
|
|
110
|
+
| `sendPanelCommand(command)` | through the panel (`Server.sendCommand`), no output |
|
|
111
|
+
| `streamConsole(history=0, timeout=None, *, reconnect=None, sanitize=True)` | HungerBridgePy `streamLogs()`: yields `[HH:mm:ss LEVEL]: message` lines; `history` ≤ 200 (`True` = 200) |
|
|
112
|
+
| `onConsoleLine(callback, history=0, *, reconnect=None, sanitize=True)` | background callbacks; returns the `hungerbridge.Stream` (`.disconnect()`) |
|
|
113
|
+
| `writeLog(message, level='info', thread=None)` | write a line to the server log |
|
|
114
|
+
| `say`, `broadcast(message, prefix=None)`, `tellraw`, `kick`, `ban`, `pardon`, `op`, `deop`, `whitelistAdd`, `whitelistRemove`, `saveAll` | chat and moderation (return the command output) |
|
|
115
|
+
|
|
116
|
+
## Game and JVM information
|
|
117
|
+
|
|
118
|
+
These are **additional** to the panel's `getRAM()`, `getCPU()`, `getUptime()`, which stay
|
|
119
|
+
unchanged (the container as the panel sees it).
|
|
120
|
+
|
|
121
|
+
| Method | Returns |
|
|
122
|
+
| --- | --- |
|
|
123
|
+
| `getPlayers()`, `getPlayerCount()`, `getMaxPlayers()` | names, online count, slots |
|
|
124
|
+
| `getTPS(mode='current')` | `'current'`, `'1m'`, `'5m'`, `'15m'`; `-1` if unavailable |
|
|
125
|
+
| `getMSPT()` | milliseconds per tick |
|
|
126
|
+
| `getPerformance()` | `{'tps': {...}, 'mspt', 'players', 'max_players'}` |
|
|
127
|
+
| `getWorldTime()`, `getWorldTimeInfo()`, `getWeather()` | tick of day, time info, `clear`/`rain`/`thunder` |
|
|
128
|
+
| `getLoadedChunks()`, `getLoadedEntities()` | per dimension and total |
|
|
129
|
+
| `getMemoryInfo(unit='mib')` | heap, non-heap, JVM, process + `used`, `total`, `free`, `max` |
|
|
130
|
+
| `getProcessInfo(unit='mib')` | `process_used`, `process_virtual`, `uptime_ms` |
|
|
131
|
+
| `getProcessorInfo()` | `load` (JVM process, 0–1), `processors` |
|
|
132
|
+
| `getThreadInfo()` | `current`, `peak`, `daemon` |
|
|
133
|
+
| `getGarbageCollectorInfo()` | `gc_type`, `gc_count`, `gc_time_ms`, `last_gc_pause_ms`, `avg_gc_pause_ms` |
|
|
134
|
+
| `getNetworkInfo()` | `bytes_in_per_sec`, `bytes_out_per_sec`, `total_bytes_in`, `total_bytes_out` |
|
|
135
|
+
| `getJVMUptime(formatted=False)` | ms, or `'3h 12m'` |
|
|
136
|
+
|
|
137
|
+
## Version Changer
|
|
138
|
+
|
|
139
|
+
Needs the Calagopus Minecraft Version Changer panel extension.
|
|
140
|
+
|
|
141
|
+
| `server.versions.` | |
|
|
142
|
+
| --- | --- |
|
|
143
|
+
| `isAvailable()` | is the panel extension installed? |
|
|
144
|
+
| `getInstalled()`, `getInstalledBuild()`, `isUpToDate()` | the installed build and the newest build of its version |
|
|
145
|
+
| `getTypes()`, `getVersions(type, ...)`, `getBuilds(type, version, ...)`, `getLatestBuild(type, version)` | |
|
|
146
|
+
| `install(build, truncate_directory=False, accept_eula=True, backup=None)` | `backup=None` uses `auto_backup`; a failed backup installs nothing |
|
|
147
|
+
| `update(truncate_directory=False, backup=None)` | newest build of the installed version; `False` if up to date |
|
|
148
|
+
|
|
149
|
+
Admin (`panel.minecraft.versionChanger.`): `getSettings()`, `updateSettings(**values)`,
|
|
150
|
+
`getStatistics()`, `getDefaultOrder()`.
|
|
151
|
+
|
|
152
|
+
## server.properties and EULA
|
|
153
|
+
|
|
154
|
+
`getProperties()`, `getProperty(key, default=None)`, `setProperty(key, value)`,
|
|
155
|
+
`setProperties(values)` (comments and order are kept; booleans become `true`/`false`),
|
|
156
|
+
`getMOTD()`, `setMOTD(motd)`, `acceptEula()`, `isEulaAccepted()`.
|
|
157
|
+
|
|
158
|
+
## Configuration
|
|
159
|
+
|
|
160
|
+
`enable('minecraft', config={...})`, all optional:
|
|
161
|
+
|
|
162
|
+
| Key | Default | Meaning |
|
|
163
|
+
| --- | --- | --- |
|
|
164
|
+
| `bridge_url` | `None` | HungerBridge URL for every server; `None` uses the server's address + `bridge_port` |
|
|
165
|
+
| `bridge_port` | `1913` | |
|
|
166
|
+
| `bridge_token` | `None` | `'tokenId:secret'` (secret: masked in diagnostics) |
|
|
167
|
+
| `bridge_timeout` | `None` | seconds or `(connect, read)`; `None` = HungerBridgePy's `(5, 30)` |
|
|
168
|
+
| `bridge_max_retries` | `2` | retries after HTTP 429 |
|
|
169
|
+
| `stream_reconnect` | `True` | default `reconnect` of `streamConsole()` / `onConsoleLine()` |
|
|
170
|
+
| `auto_backup` | `False` | back up before `server.versions.install()` |
|
|
171
|
+
| `backup_name`, `backup_timeout` | `'Before version change'`, `3600` | |
|
|
172
|
+
| `release` | `'latest'` | HungerBridge release for `installBridge()` |
|
|
173
|
+
| `repository`, `github_api` | `'HungerNet/HungerBridge'`, `'https://api.github.com'` | where releases are published |
|
|
174
|
+
|
|
175
|
+
Without `enable()`, `MinecraftServer` uses these defaults (`calagoapi_minecraft.settings()`).
|
|
176
|
+
|
|
177
|
+
## Async
|
|
178
|
+
|
|
179
|
+
```python
|
|
180
|
+
async with AsyncPanel(url=..., api_key=...) as panel:
|
|
181
|
+
server = await panel.minecraft.getServer('abc123')
|
|
182
|
+
print(await server.sendCommand('list'))
|
|
183
|
+
async for line in server.streamConsole(history=10):
|
|
184
|
+
print(line)
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
`AsyncMinecraftServer` runs HungerBridgePy in worker threads (one per open stream);
|
|
188
|
+
`onConsoleLine()` accepts coroutine callbacks.
|
|
189
|
+
|
|
190
|
+
## Package layout
|
|
191
|
+
|
|
192
|
+
| Module | Responsibility |
|
|
193
|
+
| --- | --- |
|
|
194
|
+
| `server.py` | `MinecraftServer` |
|
|
195
|
+
| `bridge.py` | client creation, pickup parsing, loader/version detection |
|
|
196
|
+
| `versions.py` | `VersionManager`, `VersionChangerAdmin`, `VersionChangerAPI` |
|
|
197
|
+
| `properties.py` | `server.properties` text handling |
|
|
198
|
+
| `manager.py` | `MinecraftManager` (`panel.minecraft`) |
|
|
199
|
+
| `extension.py`, `config.py` | `MinecraftExtension`, defaults, validation, `settings()` |
|
|
200
|
+
| `aio.py` | `AsyncMinecraftServer`, async type registrations |
|
|
201
|
+
| `exceptions.py` | `MinecraftError`, `BridgeNotConfiguredError` |
|
|
202
|
+
|
|
203
|
+
Replaces the CalagoAPI 1.x packages `calagoapi-hungerbridge` and `calagoapi-version-changer`;
|
|
204
|
+
see [Migrating to 2.0](../../../docs/migrating-to-2.0.md).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
calagoapi_minecraft/__init__.py,sha256=5LPWqZn0QUZBm69Aq8ss2uXqkiWZnCFDFbjIe3GYywU,1880
|
|
2
|
+
calagoapi_minecraft/aio.py,sha256=FN7Zg6irq7mu4MQQ6K34NGFUYMCISTCWX9RU8T2DdkY,2564
|
|
3
|
+
calagoapi_minecraft/bridge.py,sha256=n2Tbj3Y2JeAqpw2ZwVE8G4kFKsEcfVvZh74X-M2wUDI,3585
|
|
4
|
+
calagoapi_minecraft/config.py,sha256=oEnEyEQdCsXz_VQfLpHh9lFZQQMRSZEdsrW92Pqlotg,3443
|
|
5
|
+
calagoapi_minecraft/exceptions.py,sha256=mFCXkJDeeKc8AR5mqxbBpUX3QVGhR20CyZVCBvs7nEk,852
|
|
6
|
+
calagoapi_minecraft/extension.py,sha256=k_PDc4dtQgXtEazawcQI5mQmQ6DF82tgdxqqo8jAcYA,2209
|
|
7
|
+
calagoapi_minecraft/manager.py,sha256=-RvNBw_ZQisrge8UgQrCpQUx9QFMcw44SkyvN8_d-VQ,2304
|
|
8
|
+
calagoapi_minecraft/properties.py,sha256=A9XVBhncJCuNLfTTlPBA0mNttzL6hNjI3eGAMviGR9Y,1474
|
|
9
|
+
calagoapi_minecraft/server.py,sha256=9GAgDOTfSmYuWleY3N7l9KZFe-sF0OdWoBsf7742rxQ,26429
|
|
10
|
+
calagoapi_minecraft/versions.py,sha256=xEmOi-xdz9EtjXj2bv0y68i2Rfnlls8slZftMlZxZjo,9076
|
|
11
|
+
calagoapi_minecraft-1.0.dev2.dist-info/METADATA,sha256=NNrvXZjTTkARDoihH9A5VSnYEZ53cxz0DzMSjh0s8nw,11129
|
|
12
|
+
calagoapi_minecraft-1.0.dev2.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
|
|
13
|
+
calagoapi_minecraft-1.0.dev2.dist-info/entry_points.txt,sha256=3Mrgl_5GFRYpJ3oO8xJCJ7Nfc8lGL4hKkmztyiBtBms,73
|
|
14
|
+
calagoapi_minecraft-1.0.dev2.dist-info/top_level.txt,sha256=FCpHAm2QeIOwW2v501vrIzPQxG7FoNa54sbZeGa1j0c,20
|
|
15
|
+
calagoapi_minecraft-1.0.dev2.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
calagoapi_minecraft
|