README.md (1302B)
1 # tt 2 3 `tt` is a terminal-based typing game. 4 5 ## Features 6 7 - **Read ahead**: Hides the current texts and highlight the following. 8 - **Network Play**: Connect with friends over a network using sockets. 9 10 ## Requisites 11 12 - `gcc` 13 - `make` 14 - `curl` or `wget` 15 - `ncurses` ([Debian](https://packages.debian.org/hu/sid/libncurses-dev), [Arch](https://archlinux.org/packages/core/x86_64/ncurses/)) 16 - `json-c` ([Debian](https://packages.debian.org/hu/sid/libjson-c-dev), [Arch](https://archlinux.org/packages/core/x86_64/json-c/)) 17 18 ## Installation 19 20 ```sh 21 git clone https://github.com/pablo-cardenas/tt.git 22 cd tt 23 make 24 sudo make install 25 ``` 26 27 ## Usage 28 29 First, download the quotes file from monkeytype. 30 31 ```sh 32 curl -o quotes_english.json https://monkeytype.com/quotes/english.json 33 # or 34 wget -O quotes_english.json https://monkeytype.com/quotes/english.json 35 ``` 36 37 Then, choose a port number (from 1024 to 65535) and run the server: 38 39 ```sh 40 ttsrv <port> quotes_english.json 41 ``` 42 43 In another terminal, run the client with the server's host and port. If you are 44 running the server and client on the same machine, you can use `127.0.0.1` as 45 the host. 46 47 ```sh 48 ttcli <host> <port> 49 ``` 50 51 In the client, press `Enter` to start the game. 52 53 ## License 54 55 This project is licensed under the MIT License. See the LICENSE file for 56 details.