README.md

   1 # CheaterHub
   2
   3 A portable software for lovely cheaters, C++ Back-end, with Qt Front-end, self-practice project.
   4
   5 A simple customized asynchronous TCP for Back-end, by using multi-threading.
   6
   7 Implemented game(s):
   8
   9 + Wordscapes
  10
  11 ## Run
  12
  13 ### Qt Front-end
  14
  15 Located in `client/CheateHub`, build it, and config Back-end ip and port information at Config session in the application.
  16
  17 ### Back-end
  18
  19 Build by running `make` from `server/` directory, `make MODE=release` for releasing. Executable file will locate in `server/build/`.
  20
  21 #### Wordscapes
  22
  23 Module locate in `server/wordscapes/`.
  24
  25 For first time, have to generate dictionary before running, by using script `server/tools/generateDict.py`.
  26
  27 For testing this module individually, build by running `make test`.
  28
  29 ## TODO
  30
  31 Add config feature for back-end.
  32
  33 Makefile for server could be improved.
  34
  35 Message format for communicating between front-end and back-end could be improved, especially when implemented more games.