home · contact · privacy
Improve help system.
[plomrogue2] / rogue_chat_curses.py
index 7ce1496756505878132edc4d643cf92e12b09332..67f3c055e6be65c263c44637833039c323cbdfb7 100755 (executable)
@@ -111,7 +111,6 @@ def cmd_GAME_STATE_COMPLETE(game):
     game.info_db = {}
     if game.tui.mode.name == 'post_login_wait':
         game.tui.switch_mode('play')
-        game.tui.help()
     if game.tui.mode.shows_info:
         game.tui.query_info()
     player = game.get_thing(game.player_id, False)
@@ -198,28 +197,29 @@ class TUI:
 
     class Mode:
 
-        def __init__(self, name, has_input_prompt=False, shows_info=False,
-                     is_intro = False):
+        def __init__(self, name, help_intro, has_input_prompt=False,
+                     shows_info=False, is_intro = False):
             self.name = name
             self.has_input_prompt = has_input_prompt
             self.shows_info = shows_info
             self.is_intro = is_intro
+            self.help_intro = help_intro
 
     def __init__(self, host):
         import os
         import json
         self.host = host
-        self.mode_play = self.Mode('play')
-        self.mode_study = self.Mode('study', shows_info=True)
-        self.mode_edit = self.Mode('edit')
-        self.mode_annotate = self.Mode('annotate', has_input_prompt=True, shows_info=True)
-        self.mode_portal = self.Mode('portal', has_input_prompt=True, shows_info=True)
-        self.mode_chat = self.Mode('chat', has_input_prompt=True)
-        self.mode_waiting_for_server = self.Mode('waiting_for_server', is_intro=True)
-        self.mode_login = self.Mode('login', has_input_prompt=True, is_intro=True)
-        self.mode_post_login_wait = self.Mode('post_login_wait', is_intro=True)
-        self.mode_teleport = self.Mode('teleport', has_input_prompt=True)
-        self.mode_password = self.Mode('password', has_input_prompt=True)
+        self.mode_play = self.Mode('play', 'This mode allows you to interact with the map.')
+        self.mode_study = self.Mode('study', 'This mode allows you to study the map and its tiles in detail.  Move the question mark over a tile, and the right half of the screen will show detailed information on it (unless obscured by this help screen here, which you can disappear with any key).', shows_info=True)
+        self.mode_edit = self.Mode('edit', 'This mode allows you to change the map tile you currently stand on (if your terrain editing password authorizes you so).  Just enter any printable ASCII character to imprint it on the ground below you.')
+        self.mode_annotate = self.Mode('annotate', 'This mode allows you to add/edit a comment on the tile you are currently standing on.  Hit Return to leave.', has_input_prompt=True, shows_info=True)
+        self.mode_portal = self.Mode('portal', 'This mode imprints/edits/removes a teleportation target on the ground you are currently standing on.  Enter or edit a URL to imprint a teleportation target; enter emptiness to remove a pre-existing teleportation target.  Hit Return to leave.', has_input_prompt=True, shows_info=True)
+        self.mode_chat = self.Mode('chat', 'This mode allows you to engage in chit-chat with other users.  Any line you enter into the input prompt that does not start with a "/" will be sent to all users.  Lines that start with a "/" are used for commands like:', has_input_prompt=True)
+        self.mode_waiting_for_server = self.Mode('waiting_for_server', 'Waiting for a server response.', is_intro=True)
+        self.mode_login = self.Mode('login', 'Pick your player name.', has_input_prompt=True, is_intro=True)
+        self.mode_post_login_wait = self.Mode('post_login_wait', 'Waiting for a server response.', is_intro=True)
+        self.mode_teleport = self.Mode('teleport', 'Follow the instructions to re-connect and log-in to another server, or enter anything else to abort.', has_input_prompt=True)
+        self.mode_password = self.Mode('password', 'This mode allows you to change the password that you send to authorize yourself for editing password-protected tiles.  Hit return to confirm and leave.', has_input_prompt=True)
         self.game = Game()
         self.game.tui = self
         self.parser = Parser(self.game)
@@ -256,6 +256,7 @@ class TUI:
                 keys_conf = json.loads(f.read())
             for k in keys_conf:
                 self.keys[k] = keys_conf[k]
+        self.show_help = False
         curses.wrapper(self.loop)
 
     def flash(self):
@@ -286,6 +287,8 @@ class TUI:
             self.explorer = YX(player.position.y, player.position.x)
         if self.mode.name == 'waiting_for_server':
             self.log_msg('@ waiting for server …')
+        if self.mode.name == 'edit':
+            self.show_help = True
         elif self.mode.name == 'login':
             if self.login_name:
                 self.send('LOGIN ' + quote(self.login_name))
@@ -303,32 +306,6 @@ class TUI:
         elif self.mode.name == 'password':
             self.input_ = self.password
 
-    def help(self):
-        self.log_msg("HELP:");
-        self.log_msg("chat mode commands:");
-        self.log_msg("  /nick NAME - re-name yourself to NAME");
-        self.log_msg("  /msg USER TEXT - send TEXT to USER");
-        self.log_msg("  /help - show this help");
-        self.log_msg("  /%s or /play - switch to play mode" % self.keys['switch_to_play']);
-        self.log_msg("  /%s or /study - switch to study mode" % self.keys['switch_to_study']);
-        self.log_msg("commands common to study and play mode:");
-        if 'MOVE' in self.game.tasks:
-            self.log_msg("  %s - move" % ','.join(self.movement_keys));
-        self.log_msg("  %s - switch to chat mode" % self.keys['switch_to_chat']);
-        self.log_msg("commands specific to play mode:");
-        self.log_msg("  %s - enter terrain password" % self.keys['switch_to_password']);
-        if 'WRITE' in self.game.tasks:
-            self.log_msg("  %s - write following ASCII character" % self.keys['switch_to_edit']);
-        if 'FLATTEN_SURROUNDINGS' in self.game.tasks:
-            self.log_msg("  %s - flatten surroundings" % self.keys['flatten']);
-        self.log_msg("  %s - switch to study mode" % self.keys['switch_to_study']);
-        self.log_msg("commands specific to study mode:");
-        self.log_msg("  %s - switch to play mode" % self.keys['switch_to_play']);
-        if 'MOVE' not in self.game.tasks:
-            self.log_msg("  %s - move" % ','.join(self.movement_keys));
-        self.log_msg("  %s - annotate terrain" % self.keys['switch_to_annotate']);
-        self.log_msg("  %s - toggle terrain/control view" % self.keys['toggle_map_mode']);
-
     def loop(self, stdscr):
         import time
         import datetime
@@ -464,7 +441,10 @@ class TUI:
             safe_addstr(0, self.window_width, 'TURN: ' + str(self.game.turn))
 
         def draw_mode():
-            safe_addstr(1, self.window_width, 'MODE: ' + self.mode.name)
+            help = "hit [%s] for help" % self.keys['help']
+            if self.mode.has_input_prompt:
+                help = "enter /help for help"
+            safe_addstr(1, self.window_width, 'MODE: %s – %s' % (self.mode.name, help))
 
         def draw_map():
             if not self.game.turn_complete:
@@ -511,10 +491,52 @@ class TUI:
                 term_y += 1
                 map_y += 1
 
+        def draw_help():
+            content = "%s mode help (hit any key to disappear)\n\n%s\n\n" % (self.mode.name,
+                                                            self.mode.help_intro)
+            if self.mode == self.mode_play:
+                content += "Available actions:\n"
+                if 'MOVE' in self.game.tasks:
+                    content += "[%s] – move player\n" % ','.join(self.movement_keys)
+                if 'FLATTEN_SURROUNDINGS' in self.game.tasks:
+                    content += "[%s] – flatten player's surroundings\n" % self.keys['flatten']
+                content += 'Other modes available from here:\n'
+                content += '[%s] – terrain edit mode\n' % self.keys['switch_to_edit']
+                content += '[%s] – terrain password edit mode\n' % self.keys['switch_to_password']
+                content += '[%s] – chat mode\n' % self.keys['switch_to_chat']
+                content += '[%s] – study mode\n' % self.keys['switch_to_study']
+            elif self.mode == self.mode_study:
+                content += 'Available actions:\n'
+                content += '[%s] – move question mark\n' % ','.join(self.movement_keys)
+                content += '[%s] – toggle view between terrain, and password protection areas\n' % self.keys['toggle_map_mode']
+                content += '\n\nOther modes available from here:'
+                content += '[%s] – chat mode\n' % self.keys['switch_to_chat']
+                content += '[%s] – play mode\n' % self.keys['switch_to_play']
+                content += '[%s] – portal mode\n' % self.keys['switch_to_portal']
+                content += '[%s] – annotation mode\n' % self.keys['switch_to_annotate']
+            elif self.mode == self.mode_chat:
+                content += '/nick NAME – re-name yourself to NAME\n'
+                content += '/msg USER TEXT – send TEXT to USER\n'
+                content += '/%s or /play – switch to play mode\n' % self.keys['switch_to_play']
+                content += '/%s or /study – switch to study mode\n' % self.keys['switch_to_study']
+            for i in range(self.size.y):
+                safe_addstr(i,
+                            self.window_width * (not self.mode.has_input_prompt),
+                            ' '*self.window_width)
+            lines = []
+            for line in content.split('\n'):
+                lines += msg_into_lines_of_width(line, self.window_width)
+            for i in range(len(lines)):
+                if i >= self.size.y:
+                    break
+                safe_addstr(i,
+                            self.window_width * (not self.mode.has_input_prompt),
+                            lines[i])
+
         def draw_screen():
             stdscr.clear()
-            recalc_input_lines()
             if self.mode.has_input_prompt:
+                recalc_input_lines()
                 draw_input()
             if self.mode.shows_info:
                 draw_info()
@@ -524,6 +546,8 @@ class TUI:
             if not self.mode.is_intro:
                 draw_turn()
                 draw_map()
+            if self.show_help:
+                draw_help()
 
         curses.curs_set(False)  # hide cursor
         curses.use_default_colors();
@@ -554,15 +578,21 @@ class TUI:
                 self.do_refresh = True
             except curses.error:
                 continue
+            self.show_help = False
             if key == 'KEY_RESIZE':
                 reset_screen_size()
             elif self.mode.has_input_prompt and key == 'KEY_BACKSPACE':
                 self.input_ = self.input_[:-1]
+            elif self.mode.has_input_prompt and key == '\n' and self.input_ == '/help':
+                self.show_help = True
+                self.input_ = ""
             elif self.mode.has_input_prompt and key != '\n':  # Return key
                 self.input_ += key
                 max_length = self.window_width * self.size.y - len(input_prompt) - 1
                 if len(self.input_) > max_length:
                     self.input_ = self.input_[:max_length]
+            elif key == self.keys['help'] and self.mode != self.mode_edit:
+                self.show_help = True
             elif self.mode == self.mode_login and key == '\n':
                 self.login_name = self.input_
                 self.send('LOGIN ' + quote(self.input_))
@@ -579,8 +609,6 @@ class TUI:
                         self.switch_mode('play')
                     elif self.input_ in {'/' + self.keys['switch_to_study'], '/study'}:
                         self.switch_mode('study')
-                    elif self.input_ == '/help':
-                        self.help()
                     elif self.input_ == '/reconnect':
                         reconnect()
                     elif self.input_.startswith('/nick'):