mirror-chatterino2/README.md
2018-04-06 20:33:34 +02:00

3.2 KiB

alt text Chatterino 2

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

Code style

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

To setup automatic code formating with QT Creator, see this guide.

Building

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

Windows

Using Qt Creator

Visual Studio 2017

Install Visual Studio 2017 and select "Desktop development with C++" and "Universal Windows Platform development. 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.

Using MSYS2

Building using MSYS2 can be quite easier process. Check out MSYS2 at msys2.org. Be sure to add "-j <number of cores*2>" as a make argument so it will use all your cpu cores to build. example setup

  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 install qtcreator qtmultimedia5-dev libqt5svg5-dev
  2. install boost-dev sudo apt install libboost-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

Ubuntu 18.04

most likely works the same for other Debian-like distros

  1. Install dependencies (and the C++ IDE Qt Creator) sudo apt install qtcreator qtmultimedia5-dev libqt5svg5-dev libboost-dev
  2. Install rapidjson to /usr/local/ like this: From the Chatterino2 root folder: sudo cp -r lib/rapidjson/include/rapidjson /usr/local/include. If you want to install it to another place, you have to make sure it's in the chatterino.pro include path
  3. open chatterino.pro with QT Creator and build

Arch Linux

install chatterino2-git from the aur or build manually as follows:

  1. sudo pacman -S qt5-base qt5-multimedia gst-plugins-ugly gst-plugins-good 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