edwinksl / client

FAF Python Client

FA Forever Client

---

master	develop

This is the source code for the FA Forever Lobby.

Pre-requisites are:

• Python 2.7.x

• PyQt4 4.7+

• Requirements as in the requirements file.

  pip install -r requirements.txt

Contributing

By contributing, you agree to license your work to the FAForever project in such a way that it can forever be distributed under the conditions of the GPL v3.0 license.

Code-Style

Downlord's FAF Client Contribution Guidelines

• Quality has highest priority
• Write readable code
• Use comments only when absolutely necessary to explain complex algorithms or inherently unintuitive reasons for how or why your code functions
• Use the logger

Issues, PRs, and commit formatting

1. Open an issue for every improvement or problem you want to work on
2. Open a PR that references the issue, name of the feature branch for the PR should start with issue number
3. Use reasonably structured commits in your PR, for example like this:
   1. Cosmetic changes necessary to prepare your work
   2. Infrastructure / low level changes necessary for your high-level feature/fix
   3. Implementation of your feature/fix
   4. Additional work, such as localizations
4. Use "Closes #xxx" in commit messages
5. Changelog messages of the form * Fix the foo #issue (@myname #pr) are appreciated when done in a final rebase after PR is marked "ready", but otherwise tend to cause annoying merge conflicts
6. PRs without test coverage for all logic will not be accepted

Small fixes by contributors who "own" (have recently made commits on) the part of the project they are making changes on may be fast-tracked, but when in doubt open at least a PR with a descriptive title and description.

Running on Linux

This guide is about runnning the client from source repository. For a ready-made Arch-Linux package follow the instructions in the wiki.

Clone this repository locally:

git clone https://github.com/FAForever/client.git faf-client

Create a python virtualenv for installing its dependencies:

virtualenv2 ./faf-client-venv --system-site-packages
./faf-client-venv/bin/pip install -r ./faf-client/requirements.txt

Now download the faf-uid executable:

wget https://github.com/FAForever/uid/releases/download/v3.0.0/faf-uid -O ./faf-client/lib/faf-uid
chmod +x ./faf-client/lib/faf-uid

Note that the faf-uid smurf protection executable needs to run xrandr, lspci, lsblk and uname to gather unique system information.

Run the client:

cd ./faf-client && ../faf-client-venv/bin/python src/__main__.py

For more information see the wiki.

Running unit tests

Before running unit tests, set PYTEST_QT_API as follows:

export PYTEST_QT_API='pyqt4v2'

Run the lobby from the main directory using:

python2 src

Run the unit test suite using:

python2 runtests.py

License

GPLv3. See the license file.