1typespeed v0.6.4 2---------------- 3Test your typing speed and get your fingers' CPS. 4 5Index: 61 Latest Version 72 Overview 83 Usage 94 High Score File Format 105 Rule Sets 116 Frequently Asked Questions 127 Contact 13 14 151 Latest Version 16---------------- 17 18You can download latest version of typespeed on typespeed's website 19located at http://tobias.eyedacor.org/typespeed/. 20 21 222 Overview 23---------- 24 25Typespeed gives your fingers' cps (total and correct), typoratio and 26some points to compare with your friends. 27 28Typespeed's idea is ripped from ztspeed (a dos game made by Zorlim). 29Idea of the game should be clear to anyone, just type and type it fast 30or be a loser. 31 32 333 Usage 34------- 35 36Please refer to typespeed's manual page. 37 38 394 High Score File Format 40------------------------ 41 42In this section, the new high score file format will be explained. 43The new way to save high scores is especially useful if you are 44interested in creating statistics about your scores. 45 46The file format has changed with v0.6.0 into a csv format (character 47separated values). The separation character in use is tab ('\t' if you 48speak C). If a tab is used in a field, it is escaped with a 49backslash (\). If a backslash is used in a field, it is escaped with 50another backslash. 51 52That being said, the field values have the following meaning: 53 54Field | 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 65Example: 66227 229 39 Tobias words.unix rule.classic 5600 0 67 68This means that player "Tobias" played word list "words.unix" with rule 69set "rule.classic". Further more it is easy to tell that no cheat mode 70was in use, because an enter offset of 39 exists. In cheat mode, this 71value would be 0, because no enter/space has to be pressed. 72 73The value for random number generator is unknown (0). This means that 74this entry has been converted with convert. The score of player "Tobias" 75was 227, with 229 characters typed in total. The game lasted 56 seconds. 76 77With these information, cps, tcps and typo ratio can be calculated: 78 79cps = (score + enter offset) / duration * 100 80tcps = (total count + enter offset) / duration * 100 81typo ratio = (1 - (score + enter offset) / (total count + enter offset)) * 100 82 83 845 Rule Sets 85----------- 86 87If no default values have been changed, an example rule set can be found 88at /usr/local/share/typespeed/rules/template. 89 90You have to use "rule." as a prefix for your file to be treated as a rule 91set. 92 93Although all lines starting with "#" are handled as comments, the first 94line is special. In the first line, you have to specify the description 95of the rule set - this line MUST start with #. 96 97All other values should be commented perfectly fine. 98 99 1006 Frequently Asked Questions 101---------------------------- 102 103Q: 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 106A: 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 116Q: 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 119A: 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 1307 Contact 131--------- 132 133Bugs/Ideas/Comments to Tobias Stoeckmann <tobias@bugol.de>. 134 135