Removing init_visualdialog function of automatic import, delay time between each characters has been now set to 0.04 by default, delay time between each downtime_characters has been now set to 0.6 by default, some minors changes typography changes to respect PEP8 in core.py, example file are now contained in doc/examples folder, renaming the file monologue_example.py to monologue.py, some clarifications and improvements in examples files(monologue.py confrontation.py).

Author: Tim-ats-d

doc/confrontation.py

@@ -3,7 +3,7 @@
 
 import curses
 
-from visualdialog import *
+from visualdialog import DialogBox
 
 
 def main(stdscr):
@@ -38,7 +38,7 @@ def main(stdscr):
     )
 
     # Definition of accepted key codes to pass a dialog.
-    # See documentation of the curses constants for more informations.
+    # See documentation of curses constants for more informations.
     phoenix_textbox.confirm_dialog_key = (10, 32)     # Key Enter and Space.
     april_may_textbox.confirm_dialog_key = (10, 32)  # Key Enter and Space.
     edgeworth_textbox.confirm_dialog_key = (10, 32)   # Key Enter and Space.

doc/monologue_example.py renamed to doc/monologue.py

@@ -3,14 +3,15 @@
 
 import curses
 
-from visualdialog import *
+from visualdialog import DialogBox
 
 
 def main(stdscr):
-    text = (
-        "Hello world",
-        "How are you today ?",
-        "Press a key to skip this dialog."
+    replys = (
+        "Hello world, how are you today ?",
+        "Press a key to skip this dialog.",
+        "That is a basic example.",
+        "See doc for more informations."
     )
 
     # Makes the cursor invisible.
@@ -32,15 +33,15 @@ def main(stdscr):
     textbox.confirm_dialog_key = (10, 32)  # Key Enter and Space.
 
     # Display each sentence contains in text.
-    for reply in text:
+    for reply in replys:
         textbox.char_by_char(stdscr,
             reply,
             2,  # Display of the reply variable colored with color pair 2.
-            delay=0.05
-        )
+            delay=0.04)  # Set delay between each characters to 0.04 seconde.
 
         textbox.getkey(stdscr)  # Waiting for a key press.
-        stdscr.clear()          # Clear the screen.
+        stdscr.clear()  # Clear the screen.
+
 
 # Execution of the function.
 curses.wrapper(main)

setup.py

@@ -10,7 +10,7 @@
     packages=find_packages(),
     author="Arnouts Timéo",
     author_email="[email protected]",
-    description="A librairie which provides class and functions to make easier dialog box in terminal.",
+    description="A librairie to make easier dialog box in terminal.",
     long_description=open("README.md").read(),
     include_package_data=True,
     url="https://github.com/Tim-ats-d/Visual-dialog",
@@ -35,6 +35,5 @@
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: Implementation",
         "Topic :: Games/Entertainment :: Role-Playing",
-        "Topic :: Software Development :: Libraries :: Python Modules",
-        "Topic :: Software Development :: Libraries :: pygame"]
+        "Topic :: Software Development :: Libraries :: Python Modules"]
 )

visualdialog/__init__.py

@@ -8,4 +8,3 @@
 __version__ = 0.2
 
 from .core import DialogBox
-from .core import init_visualdialog

visualdialog/core.py

@@ -21,38 +21,33 @@
 #
 #
 
-__all__ = ["init_visualdialog", "DialogBox"]
-__version__ = 0.2
+__all__ = ["DialogBox"]
+__version__ = 0.3
 __author__ = "Arnouts Timéo"
 
 
 import curses
 import curses.textpad
 import random
+import textwrap
 import time
 
 from typing import Tuple
 
 
-def init_visualdialog():
-    ...
-
-
 class DialogBox :
     """This class provides methods and attributs to manage a dialog text box."""
 
     # curses constants are supported .
     confirm_dialog_key = () # List of accepted key codes to pass a dialog.
-    acceleration_dialog_key = None  # TODO: To patch.
 
     def __init__(self,
             pos_x: int, pos_y: int,
             box_length: int, box_width: int,
             title: str, title_colors_pair_nb: int,
             downtime_chars: Tuple[str] = ("!", ",", ".", ":", ";", "?"),
-            downtime_chars_delay: float = 0.7,
+            downtime_chars_delay: float = 0.6,
             end_dialog_indicator: str = "►"):
-
         self.pos_x, self.pos_y = pos_x, pos_y
         self.box_length, self.box_width = box_length, box_width
 
@@ -120,7 +115,7 @@ def _display_end_dialog_indicator(self, stdscr,
     def char_by_char(self, stdscr,
             text: str, colors_pair_nb: int,
             flash_screen: bool = False,
-            delay: int = .065, random_delay: Tuple[int, int] = (0, 0)):
+            delay: int = .05, random_delay: Tuple[int, int] = (0, 0)):
         """Writes the given text character by character at position self.pos_x;self.pos_y.
 
         The colors_pair_nb corresponds to the number of the curses color pair with which the text
@@ -130,7 +125,7 @@ def char_by_char(self, stdscr,
         dialog.
 
         The delay parameter affects the waited time between the writing of each character in seconds
-        (set by default on 0.7 seconde).
+        (set by default on 0.05 seconde).
 
         The random_delay parameter affects time between the writing of each character in seconds where
         waited time is a number generated in the given interval (as a tuple).
@@ -144,7 +139,6 @@ def char_by_char(self, stdscr,
             stdscr.addstr(
                 self.text_pos_y, self.text_pos_x + x,
                 char, curses.color_pair(colors_pair_nb))
-
             stdscr.refresh()
 
             if char in self.downtime_chars:
@@ -158,7 +152,7 @@ def word_by_word(self, stdscr,
             text: str, colors_pair_nb: int,
             cut_char: str = " ",
             flash_screen: bool = False,
-            delay: int = .065, random_delay: Tuple[int, int] = (0, 0)):
+            delay: int = .05, random_delay: Tuple[int, int] = (0, 0)):
         """Writes the given text word by word at position at position self.pos_x;self.pos_y.
 
         The colors_pair_nb corresponds to the number of the curses color pair with which the text
@@ -170,7 +164,7 @@ def word_by_word(self, stdscr,
         dialog.
 
         The delay parameter affects the waited time between the writing of each word in seconds
-        (set by default on 0.7 seconde).
+        (set by default on 0.05 seconde).
 
         The random_delay parameter affects time between the writing of each word in seconds where
         waited time is a number generated in the given interval (as a tuple).
@@ -187,18 +181,18 @@ def word_by_word(self, stdscr,
                 word, curses.color_pair(colors_pair_nb))
 
             stdscr.refresh()
-            offsetting_x += len(word) + 1 # Compensates for the space between words.
+            offsetting_x += len(word) + 1  # Compensates for the space between words.
             time.sleep(delay + random.uniform(*random_delay))
 
         self._display_end_dialog_indicator(stdscr)
 
 
 def main(stdscr):
     text = (
-        "Hello world",
-        "How are you today ?",
-        "Hi, bien ?",
-        "Objection !"
+        "Hello world, how are you today ?",
+        "Press a key to skip this dialog.",
+        "That is a basic example.",
+        "See doc for more informations."
     )
 
     curses.curs_set(0)
@@ -214,13 +208,15 @@ def main(stdscr):
         title="Dogm", title_colors_pair_nb=3,
         end_dialog_indicator="►")
 
+    textbox.confirm_dialog_key = (10, 32)
+
     for reply in text:
         textbox.framing_box(stdscr)
-        textbox.char_by_char(stdscr, reply, 2, flash_screen=True)
+        textbox.char_by_char(stdscr, reply, 2)
 
         textbox.getkey(stdscr)
         stdscr.clear()
 
+
 if __name__ == "__main__":
     curses.wrapper(main)
-