add note about license
[small-misc-bash] / wpm-game
1 #!/bin/bash
2 # I, Ian Kelling, follow the GNU license recommendations at
3 # https://www.gnu.org/licenses/license-recommendations.en.html. They
4 # recommend that small programs, < 300 lines, be licensed under the
5 # Apache License 2.0. This file contains or is part of one or more small
6 # programs. If a small program grows beyond 300 lines, I plan to switch
7 # its license to GPL.
8
9 # Copyright 2024 Ian Kelling
10
11 # Licensed under the Apache License, Version 2.0 (the "License");
12 # you may not use this file except in compliance with the License.
13 # You may obtain a copy of the License at
14
15 # http://www.apache.org/licenses/LICENSE-2.0
16
17 # Unless required by applicable law or agreed to in writing, software
18 # distributed under the License is distributed on an "AS IS" BASIS,
19 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 # See the License for the specific language governing permissions and
21 # limitations under the License.
22
23
24 wpm-game() {
25 local help="Usage: wpm-game [--help]
26 Typing speed game
27
28 Starts counting when you type a non-space.
29 Starts over and prints the scrore when you press enter."
30 if [[ $1 == --help ]]; then
31 echo "$help"
32 return 0
33 fi
34 local x line chars seconds
35 local TIMEFORMAT=%R
36 while true
37 do
38 line=()
39 while ! [[ $line ]] || [[ $line == [[:space:]] ]] ; do
40 read -n 1 line
41 done
42 x=$( { time read line; echo "$line"; } 2>&1 )
43 seconds=${x%%[[:space:]]*}
44 x="${x#$seconds}"
45 chars=$(( ${#x} + 1 )) # +1 for the first char we don't have
46 # this formual is the same as typeracer.com's 5 keys / word
47 # wikipedia says 6 is more accurate, I like typeracers flattery.
48 # chars / 5 and seconds/60 simplifies to * 12
49 echo -ne "$(echo "12 * $chars / $seconds" | bc)\t"
50 done
51 }
52 wpm-game "$@"