feat: add funcs, implement init and help (partial)

Author: Asudy

scoreboardHelper/scoreboardHelper.py

@@ -2,11 +2,11 @@
 import os, json
 
 class ScoreboardHelper(QtCore.QObject):
-    _cmd_prefix = '!sh'
+    _cmd_prefix = '!sb'
 
 
     def __init__(self, logger, core, config_file):
-        super(ScoreboardHelper, self).__init__(core)
+        super(ScoreboardHelper, self).__init__(core) 
         self.logger = logger
 
         # load config
@@ -18,4 +18,84 @@ def __init__(self, logger, core, config_file):
         else:
             self.logger.warning('config.json not found. Using default settings.')
 
-        
+        self.cycle_enabled = self.configs.get('cycle_enabled', True)
+
+        # load mcBasicLib
+        self.utils = core.get_plugin('mcBasicLib')
+        if self.utils is None:
+            self.logger.error('Failed to load plugin mcBasicLib. ScoreboardHelper will be disabled.')
+            self.logger.error('Please make sure that mcBasicLib has been added to plugins.')
+            return      # self.disabled = True
+
+        # connect signals and slots
+        self.utils.sig_input.connect(self.on_player_input)
+
+        # available commands
+        self.cmd_list = {
+            'help': self.help,
+            'list': self.list_visible_sb,
+            'view': self.view_sb,
+            'add': self.add_sb,
+            'rm': self.rm_sb,
+            'cycle': self.set_cycle,
+            'settime': self.set_time,
+        }
+
+
+    def unknown_command(self, player):
+        self.logger.warning('Unknown command sent by player {}.'.format(player.name))
+        self.utils.tell(player, 'Unknown command. Type "!sb help" for help.')
+
+
+    @QtCore.pyqtSlot(tuple)
+    def on_player_input(self, pair):
+        self.logger.debug(f'{self.__class__.__name__}.on_player_input() called')
+        player, text = pair
+        text_list = text.strip().split()
+        
+        if len(text_list) and text_list[0] == self._cmd_prefix:
+            if len(text_list) > 1 and text_list[1] in self.cmd_list:
+                self.cmd_list[text_list[1]](player, text_list)
+            else:
+                self.unknown_command(player)
+
+    
+    # Plugin Functions
+    def help(self, player, text_list):
+        help_info = '''\
+------------------ ScoreboardHelper Command List ------------------
+"!sb help": show this help message.
+"!sb list": list all scoreboards.
+"!sb view <name>": view a certain scoreboard for a period of time.
+-------------------------------------------------------------------'''
+        op_help_info = '''\
+"!sb cycle <true|false>": turn on/off scoreboard cycling.
+"!sb <add|rm> <visible|cycle> <name>": 
+    add/remove a scoreboard from visible/cycle list.
+"!sb settime <visible|cycle> <time_in_sec>":
+    
+'''
+
+
+    def list_visible_sb(self, player, text_list):
+        pass
+
+
+    def view_sb(self, player, text_list):
+        pass
+
+
+    def add_sb(self, player, text_list):
+        pass
+
+
+    def rm_sb(self, player, text_list):
+        pass
+
+
+    def set_cycle(self, player, text_list):
+        pass
+
+
+    def set_time(self, player, text_list):
+        pass