Uploading partial tutorial so that I don't accidently lose it again.

Author: 4B796C65@gmail.com

examples/tutorial/1-Basics.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+"""
+    This script shows the basic use of the tdl module.
+    
+    The font is configured and the module is initialized, the script then goes
+    into an infinite loop where it will draw "Hello World" on the screen and
+    then check for an event that tells that the user has closed the window.
+    
+    When the window is closed the script quits out by raising a SystemExit
+    exception.
+"""
+
+import tdl
+
+# Define the window size (in character tiles.) We'll pick something small.
+WIDTH, HEIGHT = 40, 30 # 320x240 when the font size is taken into account
+
+# Set the font to the example font in the tutorial folder.  This font is
+# equivalent to the default font you will get if you skip this call.
+# With the characters rows first and the font size included in the filename
+# you won't have to specify any parameters other than the font file itself.
+tdl.setFont('terminal8x8_gs_ro.png')
+
+# Call tdl.init to create the root console.
+# We will call drawing operations on the returned object.
+console = tdl.init(WIDTH, HEIGHT, 'python-tdl tutorial')
+
+# Start an infinite loop.  Drawing and game logic will be put in this loop.
+while True:
+    
+    # Reset the console to a blank slate before drawing on it.
+    console.clear()
+    
+    # Now draw out 'Hello World' starting at an x,y of 1,2.
+    console.drawStr(1, 2, 'Hello World')
+    
+    # Now to update the image on the window we make sure to call tdl.flush
+    # in every loop.
+    tdl.flush()
+    
+    # Handle events by iterating over the values returned by tdl.event.get
+    for event in tdl.event.get():
+        # Check if this is a 'QUIT' event
+        if event.type == 'QUIT':
+            # Later we may want to save the game or confirm if the user really
+            # wants to quit but for now we break out of the loop by raising a
+            # SystemExit exception.
+            # The optional string parameter will be printed out on the
+            # terminal after the script exits.
+            raise SystemExit('The window has been closed.')

examples/tutorial/2-Movement.py

@@ -0,0 +1,77 @@
+#!/usr/bin/env python
+"""
+    
+"""
+
+import tdl
+
+WIDTH, HEIGHT = 40, 30 # Defines the window size.
+
+# Create a dictionary that maps keys to vectors.
+# Names of the available keys can be found in the online documentation:
+# http://packages.python.org/tdl/tdl.event-module.html
+MOVEMENT_KEYS = {
+                 # standard arrow keys
+                 'UP': [0, -1],
+                 'DOWN': [0, 1],
+                 'LEFT': [-1, 0],
+                 'RIGHT': [1, 0],
+                 
+                 # diagonal keys
+                 # keep in mind that the keypad won't use these keys even if
+                 # num-lock is off
+                 'HOME': [-1, -1],
+                 'PAGEUP': [1, -1],
+                 'PAGEDOWN': [1, 1],
+                 'END': [-1, 1],
+                 
+                 # number-pad keys
+                 # These keys will always show as KPx regardless if num-lock
+                 # is on or off.  Keep in mind that some keyboards and laptops
+                 # may be missing a keypad entirely.
+                 # 7 8 9
+                 # 4   6
+                 # 1 2 3
+                 'KP1': [-1, 1],
+                 'KP2': [0, 1],
+                 'KP3': [1, 1],
+                 'KP4': [-1, 0],
+                 'KP6': [1, 0],
+                 'KP7': [-1, -1],
+                 'KP8': [0, -1],
+                 'KP9': [1, -1],
+                 }
+
+
+tdl.setFont('terminal8x8_gs_ro.png') # Configure the font.
+
+# Create the root console.
+console = tdl.init(WIDTH, HEIGHT, 'python-tdl tutorial')
+
+# player coordinates
+playerX, playerY = 1, 2
+
+while True: # Continue in an infinite game loop.
+    
+    console.clear() # Blank the console.
+    
+    # Using "(x, y) in console" we can quickly check if a position is inside of
+    # a console.  And skip a draw operation that would otherwise fail.
+    if (playerX, playerY) in console:
+        console.drawChar(playerX, playerY, '@')
+    
+    tdl.flush() # Update the window.
+    
+    for event in tdl.event.get(): # Iterate over recent events.
+        if event.type == 'KEYDOWN':
+            # We mix special keys with normal characters so we use keychar.
+            if event.keychar.upper() in MOVEMENT_KEYS:
+                # Get the vector and unpack it into these two variables.
+                keyX, keyY = MOVEMENT_KEYS[event.keychar.upper()]
+                # Then we add the vector to the current player position.
+                playerX += keyX
+                playerY += keyY
+                
+        if event.type == 'QUIT':
+            # Halt the script using SystemExit
+            raise SystemExit('The window has been closed.')