~ubuntu-branches/ubuntu/maverick/typespeed/maverick

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Dafydd Harries
  • Date: 2007-12-07 05:14:13 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071207051413-zn96fxeem6wknkiz
Tags: 0.6.4-1
* New upstream release. Closes: #375136.
  - High priority due to fix for DoS attack. Closes: #454527
    (CVE-2007-6220).
  - Fixes segfault when $HOME is unset. Closes: #355887.
  - Adds Italian and French word lists, Dutch word file merged.
* New upstream maintainer.
  - Update homepage URL, debian/copyright, debian/watch.
  - This version is not network-compatible with versions prior to 0.5.2.
  - Stricter network code.
  - Improved memory management.
* High score file format has changed: install score conversion program to
  /usr/lib/typespeed and run it when package is configured.
* postinst:
  - Remove obsolete score file backup/create/restore code.
  - Add code to upgrade score files to the new text-based format.
* rules:
  - Update to new autotools build.
  - Put stamp files in debian/.
  - Support DEB_BUILD_OPTS=noopt.
* Remove unnecessary debian/install.
* Update man page installation.
* Change menu file to Games/Action section as per new menu policy.
* Bump to debhelper compat version 5.
* Bump standards version to 3.7.3.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Typespeed - Test your typing speed, and get your fingers' CPS.
2
 
 
3
 
Copyright (C) 1999-2003   Jani Ollikainen  <bestis@iki.fi>
4
 
                   & Jaakko Manelius  <jman@iki.fi>
5
 
 
6
 
<bestis@iki.fi>
7
 
 
8
 
Description: 
9
 
 
10
 
  Typespeed gives your fingers' cps (total and correct), typoratio and some
11
 
  points to compare with your friends.
12
 
 
13
 
  Typespeed's idea is ripped from ztspeed (a dos game made by Zorlim). Idea
14
 
  of the game should be clear to anyone, just type and type it fast, or be a
15
 
  lewser.
16
 
 
17
 
About the new way to calculate speed:
18
 
 
19
 
  In versions before 0.4.0, the speed of words going across the screen was
20
 
  calculated exactly as in ztspeed (looked up from ztspeed's source code).
21
 
  It didn't work as we wanted it to (and probably was the cause of some
22
 
  odd bugs), so we changed it.
23
 
 
24
 
  From version 0.4.0 the speed increases linearly. It makes the game a bit
25
 
  harder, because using the old way speed didn't increase almost at all in
26
 
  the beginning. But hopefully scores will now reflect player's actual
27
 
  typing speed more accurately.
28
 
 
29
 
  Scores will be about 10-25% smaller than with older versions (according to
30
 
  our tests). The CPS levels are not affected (why would they be?), but
31
 
  they might improve a little, because you won't be typing so long.. <g>
32
 
 
33
 
Command line options:
34
 
 
35
 
       --nocolors
36
 
              Turns  off  the  ncurses  colors,  it can be a more
37
 
              clear way to play the game in some situations.
38
 
 
39
 
       --cheat
40
 
              This will  enable  the  cheat,  which  wraps  words
41
 
              instantly  when  they  are  written  correctly. You
42
 
              don't need to  press  space/enter.  It  is  another
43
 
              question if this "cheat" actually helps..
44
 
 
45
 
       --training[=nm]
46
 
              Training  mode (where nm is speed number). It slows
47
 
              the game down. Speed number tells how  often  words
48
 
              are  moved,  normally  always.  So that with number
49
 
              "2", words move every second time in the  loop  and
50
 
              with  "4"  they  move  only  every fourth time. You
51
 
              can't obviously get your name  in  the  high  score
52
 
              list by using this option.
53
 
 
54
 
       --server
55
 
              Start typespeed in server mode. Typespeed will wait
56
 
              for other player to connect.
57
 
 
58
 
       --client=addr
59
 
              Start typespeed in client mode (where addr is  net-
60
 
              work  address of server) Typespeed will try to con-
61
 
              nect to the given address and start network play.
62
 
 
63
 
       --port[=port]
64
 
              Tells what tcp/ip port will typespeed be  using  in
65
 
              the network play. The default port is 6025.
66
 
 
67
 
       --makescores
68
 
              Reset/Make  scorefiles  for  the wordfiles found in
69
 
              the dir defined in the  configs  or  if  no  config
70
 
              files exist, then in the current dir. Doesn't start
71
 
              typespeed.
72
 
 
73
 
       --help Little explaining of the parameters
74
 
 
75
 
 
76
 
  Bugs/Ideas/Comments to <bestis@iki.fi>
77
 
 
78
 
COPYING:
79
 
 
80
 
  This program is free software; you can redistribute it and/or
81
 
  modify it under the terms of the GNU General Public License
82
 
  as published by the Free Software Foundation; either version 2
83
 
  of the License, or (at your option) any later version.
84
 
 
85
 
  This program is distributed in the hope that it will be useful,
86
 
  but WITHOUT ANY WARRANTY; without even the implied warranty of
87
 
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
88
 
  GNU General Public License for more details.
89
 
 
90
 
 
91
 
Copyright (C) 1999-2003   Jani Ollikainen  <bestis@iki.fi>
92
 
                   & Jaakko Manelius  <jman@iki.fi>
93
 
 
94
 
</bestis@iki.fi>
 
1
typespeed v0.6.4
 
2
----------------
 
3
Test your typing speed and get your fingers' CPS.
 
4
 
 
5
Index:
 
6
1 Latest Version
 
7
2 Overview
 
8
3 Usage
 
9
4 High Score File Format
 
10
5 Rule Sets
 
11
6 Frequently Asked Questions
 
12
7 Contact
 
13
 
 
14
 
 
15
1 Latest Version
 
16
----------------
 
17
 
 
18
You can download latest version of typespeed on typespeed's website
 
19
located at http://tobias.eyedacor.org/typespeed/.
 
20
 
 
21
 
 
22
2 Overview
 
23
----------
 
24
 
 
25
Typespeed gives your fingers' cps (total and correct), typoratio and
 
26
some points to compare with your friends.
 
27
 
 
28
Typespeed's idea is ripped from ztspeed (a dos game made by Zorlim).
 
29
Idea of the game should be clear to anyone, just type and type it fast
 
30
or be a loser.
 
31
 
 
32
 
 
33
3 Usage
 
34
-------
 
35
 
 
36
Please refer to typespeed's manual page.
 
37
 
 
38
 
 
39
4 High Score File Format
 
40
------------------------
 
41
 
 
42
In this section, the new high score file format will be explained.
 
43
The new way to save high scores is especially useful if you are
 
44
interested in creating statistics about your scores.
 
45
 
 
46
The file format has changed with v0.6.0 into a csv format (character
 
47
separated values).  The separation character in use is tab ('\t' if you
 
48
speak C).  If a tab is used in a field, it is escaped with a
 
49
backslash (\).  If a backslash is used in a field, it is escaped with
 
50
another backslash.
 
51
 
 
52
That being said, the field values have the following meaning:
 
53
 
 
54
Field | Name           | Meaning
 
55
------+----------------+-----------------------------------------------
 
56
  1   | score          | How many points has the player gathered?
 
57
  2   | total count    | How many characters has the player entered?
 
58
  3   | enter offset   | Count of enter/space pressed to finish a word
 
59
  4   | name           | What name has the player?
 
60
  5   | word list      | What word list was in use?
 
61
  6   | rule set       | Which rule set was in use?
 
62
  7   | duration       | How long lasted game session? (hundreds of seconds)
 
63
  8   | sinit          | Value used to fill in random number generator
 
64
 
 
65
Example:
 
66
227     229     39      Tobias  words.unix      rule.classic    5600    0
 
67
 
 
68
This means that player "Tobias" played word list "words.unix" with rule
 
69
set "rule.classic".  Further more it is easy to tell that no cheat mode
 
70
was in use, because an enter offset of 39 exists.  In cheat mode, this
 
71
value would be 0, because no enter/space has to be pressed.
 
72
 
 
73
The value for random number generator is unknown (0).  This means that
 
74
this entry has been converted with convert.  The score of player "Tobias"
 
75
was 227, with 229 characters typed in total.  The game lasted 56 seconds.
 
76
 
 
77
With these information, cps, tcps and typo ratio can be calculated:
 
78
 
 
79
cps = (score + enter offset) / duration * 100
 
80
tcps = (total count + enter offset) / duration * 100
 
81
typo ratio = (1 - (score + enter offset) / (total count + enter offset)) * 100
 
82
 
 
83
 
 
84
5 Rule Sets
 
85
-----------
 
86
 
 
87
If no default values have been changed, an example rule set can be found
 
88
at /usr/local/share/typespeed/rules/template.
 
89
 
 
90
You have to use "rule." as a prefix for your file to be treated as a rule
 
91
set.
 
92
 
 
93
Although all lines starting with "#" are handled as comments, the first
 
94
line is special.  In the first line, you have to specify the description
 
95
of the rule set - this line MUST start with #.
 
96
 
 
97
All other values should be commented perfectly fine.
 
98
 
 
99
 
 
100
6 Frequently Asked Questions
 
101
----------------------------
 
102
 
 
103
Q: Is typespeed's timing broken? I have used some other programs to
 
104
   determine my CPS and it is much higher than with typespeed.
 
105
 
 
106
A: No, typespeed's timing works fine.  But you are right, too.  At the
 
107
   beginning of a typespeed session, there are only a few words on
 
108
   screen.  Just try to contentrate on your typing rate.  If you are a
 
109
   fast typer, you will often wait and type nothing until something new
 
110
   appears.  At the end, you will be indeed faster than measured CPS.
 
111
   Typespeed calculates the whole time to measure CPS so the waiting at
 
112
   the beginning kills your high rates.  If you want to circumvent this,
 
113
   try to write an own rule set with min words != 0 and a high speed
 
114
   rate.  This way, you can measure your real CPS.
 
115
 
 
116
Q: There are no high scores listed in high score menu, but there are
 
117
   definitely some in my high score file.  What is going wrong?
 
118
 
 
119
A: I guess you have not selected the right rule set.  If you do not
 
120
   change anything, you have the default rule set.  To see other high
 
121
   scores, you have to change the rule set first (menu point 6).
 
122
 
 
123
   Another possibility is that you have created or removed a user-
 
124
   specific configuration file.  If that is the case, typespeed switched
 
125
   from system-wide high score to user-specific high score (or vice
 
126
   versa).  To get back to user-specific high score, just create an
 
127
   empty configuration file (~/.typespeed/config).
 
128
 
 
129
 
 
130
7 Contact
 
131
---------
 
132
 
 
133
Bugs/Ideas/Comments to Tobias Stoeckmann <tobias@bugol.de>.
 
134