Changes between Initial Version and Version 1 of LightningTalkTimer


Ignore:
Timestamp:
03/17/2014 10:37:20 AM (6 years ago)
Author:
carndt
Comment:

Created

Legend:

Unmodified
Added
Removed
Modified
  • LightningTalkTimer

    v1 v1  
     1= Lightning Talk Timer = 
     2 
     3A graphical countdown timer for lightning talk presenters and hosts. 
     4 
     5 Author:: Christopher Arndt 
     6 Version:: 0.1b 
     7 License:: GPL v2 
     8 
     9 
     10 
     11== Quicklinks == 
     12 
     13 * [source:/projects/ltt/trunk Browse Subversion source code repository] 
     14 * Check out Subversion repository: 
     15 
     16{{{ 
     17svn co svn://svn.chrisarndt.de/projects/ltt/trunk ltt 
     18}}} 
     19 
     20 
     21{{{#!rst 
     22Overview 
     23======== 
     24 
     25Lightning Talk Time (LTT) displays a countdown timer in a big window (or 
     26fullscreen mode) in big white numbers on a black background. When started 
     27(SPACE key) it starts counting down from the given duration (default: 5 min.) 
     28to 0:00. When the countdown timer reaches a certain remaining duration 
     29(default: 30 seconds), the timer display changes color to give a visible 
     30warning about the impending expiration of the countdown period. 
     31 
     32The behaviour and look of the program can be customized through many command 
     33line options or by changing default values at the start of the script. 
     34 
     35 
     36Requirements 
     37============ 
     38 
     39Lighnung Talk Timer is based on pygame_ and is compatible with Python 2.7. 
     40Python 3.2+ support has not been tested. 
     41 
     42 
     43Installation 
     44============ 
     45 
     46Lightning Talk Timer is structured as a self-contained application bundle. 
     47Currently it is only available from a Subversion repository. To use it, install 
     48PyGame >= 1.9.1 and check out LTT from the repository and run the ``main.py`` 
     49script located in the top directory:: 
     50 
     51    $ svn checkout svn://svn.chrisarndt.de/projects/ltt/trunk ltt 
     52    $ ./ltt/main.py 
     53 
     54 
     55Invocation 
     56========== 
     57 
     58:: 
     59 
     60    usage: main.py [OPTIONS] [SECONDS] 
     61 
     62    Lightning Talk Timer 
     63 
     64    positional arguments: 
     65      SECONDS               Duration of countdown timer in seconds (default: 300s) 
     66 
     67    optional arguments: 
     68      -h, --help            show this help message and exit 
     69      -v, --verbose         Print debugging info to standard output. 
     70      -f, --fullscreen      Start in fullscreen mode (press 'f' to toggle). 
     71      -W PX, --width PX     Width of display in pixels (default: 1600px). 
     72      -H PX, --height PX    Height of display in pixels (default: 900px). 
     73      -F NAME, --font NAME  Name/path of timer display font (default: 
     74                            'tuffy.ttf'). 
     75      -r FPS, --fps FPS     Max. display frames per second (default: 100fps). 
     76      -S PX, --size PX      Size of timer display font (default: (display 
     77                            height/3)px ). 
     78 
     79The actual default width and height of the display depend on your actual 
     80screen resolution. The horizontal size is equal to the screen width within a 
     81maximum of up to 1080 pixels. The vertical resolution is the horizontal 
     82resolution multiplied by the screen aspect ration (e.g. 1.6 for 16:10 screens). 
     83 
     84 
     85Keyboard Commands 
     86================= 
     87 
     88``SPACE`` 
     89    When timer is stopped: start countdown 
     90 
     91    When timer is running: pause countdown 
     92 
     93    When timer is paused: resume countdown 
     94 
     95``RETURN`` 
     96    When timer is stopped: start countdown 
     97 
     98    When timer is running/paused: reset countdown 
     99 
     100``q, ESCAPE`` 
     101    Quit program (without prompting) 
     102 
     103`f` 
     104   Toggle fullscreen mode 
     105 
     106The following commands only have an effect when the timer is stopped: 
     107 
     108``+`` (plus) 
     109    Increase countdown timer by 10 seconds 
     110 
     111``Shift-+`` (Shift and plus) 
     112    Increase countdown timer by 1 second 
     113 
     114``Ctrl-+`` (Control and plus) 
     115    Increase countdown timer by 1 minute 
     116 
     117``Ctrl-Shift-+`` (Control and Shift and plus) 
     118    Increase countdown timer by 10 minute1 
     119 
     120``-`` (minus/dash) 
     121    Decrease countdown timer by 10 seconds 
     122 
     123``Shift--`` (Shift and minus/dash) 
     124    Decrease countdown timer by 1 second 
     125 
     126``Ctrl--`` (Control and minus/dash) 
     127    Decrease countdown timer by 1 minute 
     128 
     129``Ctrl-Shift--`` (Control and Shift and minus/dash) 
     130    Decrease countdown timer by 10 minute1 
     131 
     132The maximum countdown duration is 999 minutes, 59 seconds and the minimum 1 
     133second. 
     134 
     135Bugs and Limitations 
     136-------------------- 
     137 
     138Fullscreen mode currently does not work correctly with multiple displays due to problems with the SDL 1.2 library used by !PyGame. I'm currently researching a solution. 
     139 
     140.. _pygame: http://pygame.org/ 
     141}}}