mirror-chatterino2/README.md

Chatterino 2

Chatterino 2 is the second installment of the Twitch chat client series "Chatterino". For now you can check out Chatterino 1 at chatterino.com.

Code style

The code is normally formated using clang format in Qt Creator. .clang-format contains the style file for clang format.

Building

Before building run git submodule update --init --recursive to get required submodules.

Windows

Using Qt Creator

boost

download the boost library and extract it to C:\local\boost

open-ssl

1. download binaries for OpenSSL >= 1.0.2 or compile it from source. example download
2. Place libeay32.dll and ssleay32.dll from OpenSSL in a directory in PATH.

rapidjson

1. download rapidjson zip from https://github.com/miloyip/rapidjson/releases/latest
2. extract to C:/local/rapidjson so that C:/local/rapidjson/include/rapidjson/ is a proper path

Using MSYS2

Building using MSYS2 can be quite easier process. Check out MSYS2 at msys2.org.

1. open appropriate MSYS2 terminal and do pacman -S mingw-w64-<arch>-boost mingw-w64-<arch>-qt5 mingw-w64-<arch>-rapidjson where <arch> is x86_64 or i686
2. go into the project directory
3. create build folder mkdir build && cd build
4. qmake .. && mingw32-make

Linux

Ubuntu 16.04.2 LTS

most likely works the same for other Debian-like distros

1. install QT Creator sudo apt-get install qtcreator qtmultimedia5-dev
2. install boost-dev sudo apt-get install libboost-all-dev
3. copy include/rapidjson from rapidjson into the chatterino directory so that the file <chatterino2 directory>/rapidjson/document.h exists
4. open chatterino.pro with QT Creator and build

Arch Linux

1. sudo pacman -S qt5 boost rapidjson
2. go into project directory
3. create build folder mkdir build && cd build
4. qmake .. && make

Mac OSX

1. install Xcode and Xcode Command Line Utilites
2. install Qt Creator
3. install brew https://brew.sh/
4. brew install boost openssl rapidjson
5. build the project using Qt Creator