serverwatcher 3.9__tar.gz → 4.0__tar.gz

{serverwatcher-3.9/src/serverwatcher.egg-info → serverwatcher-4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: serverwatcher
-Version: 3.9
+Version: 4.0
 Summary: A HungerLib-powered Minecraft server automation engine.
 Author: iFamished
 License: GPL-3.0

{serverwatcher-3.9 → serverwatcher-4.0}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "serverwatcher"
-version = "3.9"
+version = "4.0"
 description = "A HungerLib-powered Minecraft server automation engine."
 readme = "README.md"
 requires-python = ">=3.10"

{serverwatcher-3.9 → serverwatcher-4.0}/src/serverwatcher/__init__.py

@@ -7,9 +7,13 @@ except PackageNotFoundError:
     __version__ = '0.0.0'
 
 from .watcher import ServerWatcher
-
+from .configclasses.global_config import GlobalConfig
+from .configclasses.messages import MessagesConfig
+from .configclasses.watcher import WatcherConfig
 
 __all__ = [
-    # core utilities
     'ServerWatcher',
+    'GlobalConfig',
+    'MessagesConfig',
+    'WatcherConfig',
 ]

serverwatcher-4.0/src/serverwatcher/defaultconfigs/global.yaml

@@ -0,0 +1,16 @@
+panel:
+  panel_name: My Panel
+  panel_url: https://example.com
+  panel_api_key: CHANGE_ME
+
+origin:
+  origin_server_id: CHANGE_ME
+
+server:
+  server_name: My SMP
+  server_id: CHANGE_ME
+  server_domain: mc.example.com
+  server_port: 25565
+  rcon_port: 25575
+  rcon_password: password
+  tps_command: ticks

serverwatcher-4.0/src/serverwatcher/defaultconfigs/messages.yaml

@@ -0,0 +1,51 @@
+prefix: "<aqua>[Server Watcher]"
+
+broadcast_restart_at: "{prefix} The server will restart at {time} CDT."
+
+broadcast_minute:
+  minute_120: "{prefix} Restart in 2 hours!"
+  minute_60: "{prefix} Restart in 1 hour!"
+  minute_45: "{prefix} Restart in 45 minutes!"
+  minute_30: "{prefix} Restart in 30 minutes!"
+  minute_15: "{prefix} Restart in 15 minutes!"
+  minute_5: "{prefix} Restart in 5 minutes!"
+  minute_1: "{prefix} Restart in 1 minute!"
+
+broadcast_second:
+  second_10: "{prefix} Restart in 10 seconds!"
+  second_9: "{prefix} Restart in 9 seconds!"
+  second_8: "{prefix} Restart in 8 seconds!"
+  second_7: "{prefix} Restart in 7 seconds!"
+  second_6: "{prefix} Restart in 6 seconds!"
+  second_5: "{prefix} Restart in 5 seconds!"
+  second_4: "{prefix} Restart in 4 seconds!"
+  second_3: "{prefix} Restart in 3 seconds!"
+  second_2: "{prefix} Restart in 2 seconds!"
+  second_1: "{prefix} Restart in 1 second!"
+
+logging:
+  log_start: "ServerWatcher is running!"
+  log_status_check: "Checking server status..."
+  log_validation_fail: "Validation FAILED."
+  log_validation_ok: "All validation checks succeeded."
+  log_shutdown: "Shutting down ServerWatcher."
+  log_immediate_restart: "Restarting immediately."
+  log_no_restart: "The server does not need to restart."
+  log_scheduled: "Restart needed, but anti-restart factors outweigh it."
+  log_gap_low: "Gap {gap}. Scheduling restart in 2 hours."
+  log_gap_high: "Gap {gap}. Scheduling restart in 1 hour."
+
+reasons:
+  reason_restart_soon: "The server is set to restart soon"
+  reason_ram: "RAM usage ({ram}) is higher than {threshold} GB"
+  reason_cpu: "CPU usage ({cpu}) is higher than {threshold}%"
+  reason_uptime: "Uptime {uptime} exceeds {threshold}h"
+  reason_tps: "TPS {tps} is lower than {threshold}"
+  reason_low_uptime: "Uptime {uptime} is shorter than 30m"
+  reason_players: "There {verb} {count} {plural} online"
+
+restarts:
+  restart_action_sent: "Restart action sent. Waiting..."
+  server_back_online: "Server is back online!"
+  server_back_online_broadcast: "{prefix} <green>Restart successful!"
+  server_failed_restart: "Server failed to restart!"

serverwatcher-4.0/src/serverwatcher/defaultconfigs/watcher.yaml

@@ -0,0 +1,39 @@
+logging:
+  logger_name_template: "Server Watcher"
+  log_path: "/home/container/logs/"
+  timezone: "America/Chicago"
+
+terminal_settings:
+  console_backspaces: 8
+  clear_terminal: True
+
+schedules:
+  restart_soon_schedule_id: 0     # replace this with real schedule id
+  origin_disable_schedule_id: 0   # replace this with real schedule id
+
+thresolds:
+  ram_threshold: 6
+  cpu_threshold: 150
+  uptime_hours_threshold: 12
+  tps_threshold: 19.5
+
+weights:
+  weight_restart_soon: 3
+  weight_ram: 1
+  weight_cpu: 1
+  weight_uptime: 1
+  weight_tps: 1
+  weight_low_uptime: 5
+  weight_per_player: 1
+
+gaps:
+  low_gap_minutes: 120
+  high_gap_minutes: 60
+
+restart_intervals:
+  restart_wait_seconds: 45
+  restart_online_timeout: 120
+  restart_online_interval: 2
+
+watcher_intervals:
+  watch_interval: 60 

{serverwatcher-3.9 → serverwatcher-4.0}/src/serverwatcher/watcher.py

@@ -11,35 +11,47 @@ from hungerlib.addons import (
     waitForOnline,
     validateAll,
     runCountdownEvents,
+    loadConfig,
 )
-from hungerlib.addons.configmap import load_or_default
 
-from serverwatcher.config import GlobalConfig, MessagesConfig, WatcherConfig
-
-# Set directory
-BASE_DIR = os.getcwd()
-PACKAGE_DIR = os.path.dirname(__file__)
+from serverwatcher import GlobalConfig, MessagesConfig, WatcherConfig
 
 
 class ServerWatcher:
     def __init__(self):
-        # Load all configs in /config using configmap
-        cfgmap = load_or_default("config", skip_files=[])
 
-        self.global_cfg: GlobalConfig = cfgmap["global.yaml"]
-        self.messages: MessagesConfig = cfgmap["messages.yaml"]
-        self.cfg: WatcherConfig       = cfgmap["watcher.yaml"]
+        # load configs
+        self.global_cfg = loadConfig(
+            "config/global.yaml",
+            "/defaultconfigs/global.yaml",
+            GlobalConfig
+        )
+
+        self.messages = loadConfig(
+            "config/messages.yaml",
+            "/defaultconfigs/messages.yaml",
+            MessagesConfig
+        )
+
+        self.cfg = loadConfig(
+            "config/watcher.yaml",
+            "/defaultconfigs/watcher.yaml",
+            WatcherConfig
+        )
 
+        # initialize panels and servers
         self.panel = Panel(
             name=self.global_cfg.panel_name,
             url=self.global_cfg.panel_url,
             api_key=self.global_cfg.panel_api_key,
         )
+
         self.origin = GenericServer(
             name="Origin",
             panel=self.panel,
             server_id=self.global_cfg.origin_server_id
         )
+
         self.server = MinecraftServer(
             name=self.global_cfg.server_name,
             panel=self.panel,
@@ -50,34 +62,36 @@ class ServerWatcher:
             rcon_password=self.global_cfg.rcon_password,
             tpsCommand=self.global_cfg.tps_command,
         )
+
         logger_name = self.cfg.logger_name_template.format(
             server_name=self.global_cfg.server_name
         )
+
         self.log = HungerLogger(
             name=logger_name,
             server=self.server,
             log_path=self.cfg.log_path,
             console_backspaces=self.cfg.console_backspaces,
         )
+
         self.tz = ZoneInfo(self.cfg.timezone)
 
-    # format messages with prefix
+    # utility
     def fmt(self, template: str, **kwargs):
         return template.format(prefix=self.messages.prefix, **kwargs)
 
-    # simple shutdown
     def shutdown(self):
-        self.log.info(f"{self.messages.log_shutdown}")
+        self.log.info(self.messages.log_shutdown)
         raise SystemExit
 
     # restart logic
     def restart_and_wait(self):
         self.origin.disableSchedule(self.cfg.restart_soon_schedule_id)
         self.server.restart()
-        self.log.info(f"{self.messages.restart_action_sent}")
+        self.log.info(self.messages.restart_action_sent)
         time.sleep(self.cfg.restart_wait_seconds)
 
-        self.log.warn(f"{self.messages.log_status_check}")
+        self.log.warn(self.messages.log_status_check)
         alive = waitForOnline(
             self.server,
             timeout=self.cfg.restart_online_timeout,
@@ -85,13 +99,13 @@ class ServerWatcher:
         )
 
         if alive:
-            self.log.info(f"{self.messages.server_back_online}")
-            self.server.sendBroadcast(f"{self.messages.server_back_online_broadcast}")
+            self.log.info(self.messages.server_back_online)
+            self.server.sendBroadcast(self.messages.server_back_online_broadcast)
             self.origin.enableSchedule(self.cfg.origin_disable_schedule_id)
         else:
-            self.log.error(f"{self.messages.server_failed_restart}")
+            self.log.error(self.messages.server_failed_restart)
 
-    # schedule restart
+    # scheduled restart
     def schedule_restart(self, minutes):
         info = snapSchedule(minimumMinutes=minutes)
         scheduled = info["scheduled"]
@@ -99,50 +113,42 @@ class ServerWatcher:
         local_time = scheduled.astimezone(self.tz)
         time_str = local_time.strftime("%I:%M %p")
 
-        # Broadcast the scheduled restart time
-        self.server.sendBroadcast(self.fmt(self.messages.broadcast_restart_at, time=time_str))
-
-        # Collect all minute_* keys
-        minute_keys = [
-            k for k in vars(self.messages)
-            if k.startswith("minute_")
-        ]
+        self.server.sendBroadcast(
+            self.fmt(self.messages.broadcast_restart_at, time=time_str)
+        )
 
+        # minute_* callbacks
         minute_callbacks = {
             int(k.split("_")[1]): (
                 lambda msg=self.fmt(getattr(self.messages, k)):
                     self.server.sendBroadcast(msg)
             )
-            for k in minute_keys
+            for k in vars(self.messages)
+            if k.startswith("minute_")
         }
 
-        # Collect all second_* keys
-        second_keys = [
-            k for k in vars(self.messages)
-            if k.startswith("second_")
-        ]
-
+        # second_* callbacks
         second_callbacks = {
             int(k.split("_")[1]): (
                 lambda msg=self.fmt(getattr(self.messages, k)):
                     self.server.sendBroadcast(msg)
             )
-            for k in second_keys
+            for k in vars(self.messages)
+            if k.startswith("second_")
         }
 
-
         runCountdownEvents(
             target_time=scheduled,
             minute_callbacks=minute_callbacks,
             second_callbacks=second_callbacks,
         )
 
-    # main evaluation logic
+    # evaluation logic
     def evaluate(self):
-        self.log.info(f"{self.messages.log_start}")
+        self.log.info(self.messages.log_start)
 
         if not validateAll(self.panel, self.server):
-            self.log.error(f"{self.messages.log_validation_fail}")
+            self.log.error(self.messages.log_validation_fail)
             self.shutdown()
 
         self.server.refresh()
@@ -209,8 +215,9 @@ class ServerWatcher:
 
         gap = abs(pro - anti)
 
+        # decision
         if pro == 0:
-            self.log.info(f"{self.messages.log_no_restart}")
+            self.log.info(self.messages.log_no_restart)
             return
 
         if pro > anti and snap.players == 0:
@@ -229,9 +236,7 @@ class ServerWatcher:
 
         self.restart_and_wait()
 
-    # -----------------------------------------------------
-    # Main loop
-    # -----------------------------------------------------
+    # main loop
     def run(self):
         if self.cfg.clear_terminal:
             clearTerminal()

{serverwatcher-3.9 → serverwatcher-4.0/src/serverwatcher.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: serverwatcher
-Version: 3.9
+Version: 4.0
 Summary: A HungerLib-powered Minecraft server automation engine.
 Author: iFamished
 License: GPL-3.0

serverwatcher-4.0/src/serverwatcher.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+README.md
+pyproject.toml
+src/serverwatcher/__init__.py
+src/serverwatcher/watcher.py
+src/serverwatcher.egg-info/PKG-INFO
+src/serverwatcher.egg-info/SOURCES.txt
+src/serverwatcher.egg-info/dependency_links.txt
+src/serverwatcher.egg-info/requires.txt
+src/serverwatcher.egg-info/top_level.txt
+src/serverwatcher/configclasses/__init__.py
+src/serverwatcher/configclasses/global_config.py
+src/serverwatcher/configclasses/messages.py
+src/serverwatcher/configclasses/watcher.py
+src/serverwatcher/defaultconfigs/global.yaml
+src/serverwatcher/defaultconfigs/messages.yaml
+src/serverwatcher/defaultconfigs/watcher.yaml

serverwatcher-3.9/src/serverwatcher.egg-info/SOURCES.txt

@@ -1,14 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-src/serverwatcher/__init__.py
-src/serverwatcher/watcher.py
-src/serverwatcher.egg-info/PKG-INFO
-src/serverwatcher.egg-info/SOURCES.txt
-src/serverwatcher.egg-info/dependency_links.txt
-src/serverwatcher.egg-info/requires.txt
-src/serverwatcher.egg-info/top_level.txt
-src/serverwatcher/configmap/configclasses/__init__.py
-src/serverwatcher/configmap/configclasses/global_config.py
-src/serverwatcher/configmap/configclasses/messages.py
-src/serverwatcher/configmap/configclasses/watcher.py