{"id":18425757,"url":"https://github.com/faforever/client","last_synced_at":"2025-04-04T12:07:45.249Z","repository":{"id":21100343,"uuid":"24400684","full_name":"FAForever/client","owner":"FAForever","description":"FAF Python Client","archived":false,"fork":false,"pushed_at":"2025-01-09T23:22:49.000Z","size":16336,"stargazers_count":75,"open_issues_count":97,"forks_count":88,"subscribers_count":24,"default_branch":"develop","last_synced_at":"2025-03-28T11:08:00.289Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FAForever.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-09-24T04:25:57.000Z","updated_at":"2025-01-09T23:22:54.000Z","dependencies_parsed_at":"2024-06-06T19:02:36.979Z","dependency_job_id":"2e4e3999-f98c-49e7-b827-4dbfaccfb96d","html_url":"https://github.com/FAForever/client","commit_stats":null,"previous_names":[],"tags_count":192,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAForever%2Fclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAForever%2Fclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAForever%2Fclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAForever%2Fclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FAForever","download_url":"https://codeload.github.com/FAForever/client/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247174418,"owners_count":20896078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T05:05:27.524Z","updated_at":"2025-04-04T12:07:45.222Z","avatar_url":"https://github.com/FAForever.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Development status\n==================\nThis is the legacy client. The offically supported version can be found [here](https://github.com/FAForever/downlords-faf-client). The development is more or less discontinued.\n\nFA Forever Client\n=================\n\nThis is the source code for the FA Forever Lobby.\n\nPre-requisites are:\n\n- Python 3.12+\n- PyQt5 \u003e=6.7\n- Requirements as in the [requirements](requirements.txt) (Linux) or [win_requirements](win_requirements.txt) (Windows) file.\n\n\n    pip install -r requirements.txt\n\n\nContributing\n-------\n\nBy 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.\n\n### Code-Style\n\n[Downlord's FAF Client Contribution Guidelines](https://github.com/FAForever/java-guidelines/wiki/Contribution-Guidelines)\n* [Quality has highest priority](https://github.com/FAForever/java-guidelines/wiki/Contribution-Guidelines#quality-has-highest-priority)\n* [Write readable code](https://github.com/FAForever/java-guidelines/wiki/Contribution-Guidelines#write-readable-code)\n* [Use comments only when absolutely necessary to explain complex algorithms or inherently unintuitive reasons for how or why your code functions](https://github.com/FAForever/java-guidelines/wiki/Contribution-Guidelines#avoid-javadoc-and-comments)\n* [Use the logger](https://github.com/FAForever/java-guidelines/wiki/Contribution-Guidelines#logging)\n\n### Issues, PRs, and commit formatting\n\n1. Open an issue for every improvement or problem you want to work on\n2. Open a PR that references the issue, name of the feature branch for the PR should start with issue number\n3. Use reasonably structured commits in your PR, for example like this:\n    1. Cosmetic changes necessary to prepare your work\n    2. Infrastructure / low level changes necessary for your high-level feature/fix\n    3. Implementation of your feature/fix\n    4. Additional work, such as localizations\n3. Use \"Closes #xxx\" in commit messages\n4. 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\n5. PRs without test coverage for all logic will not be accepted\n\nSmall 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.\n\nRunning on Windows\n-------\n\nhttps://github.com/FAForever/client/wiki/Windows-Dev-Py36\n\nRunning on Linux\n-------\nThis guide is about runnning the client from source repository. For a [ready-made Arch-Linux package](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=python-fafclient) [follow the instructions in the wiki](http://wiki.faforever.com/index.php?title=Setting_Up_FAF_Linux).\n\nClone this repository locally:\n\n    git clone https://github.com/FAForever/client.git faf-client\n\nCreate a python3(!) virtualenv for installing its dependencies:\n\n    virtualenv ./faf-client-venv --system-site-packages\n    ./faf-client-venv/bin/pip install -r ./faf-client/requirements.txt\n\n**Note that many distributions have separate names for Python 2 and Python 3 virtualenv, such as \"virtualenv\" and \"virtualenv3\" - ensure you're using the Python 3 specific version on your distribution!**\n\nNow download the `faf-uid` executable:\n\n    mkdir ./faf-client/natives\n    wget https://github.com/FAForever/uid/releases/download/v4.0.6/faf-uid -O ./faf-client/natives/faf-uid\n    chmod +x ./faf-client/natives/faf-uid\n\nNote that the `faf-uid` smurf protection executable needs to run `xrandr`, `lspci`, `lsblk` and `uname` to gather unique system information. Additionally the `lsblk` command must support the \"--json\" flag, which was added in util-linux-2.27.\n\nYou will also need [java-ice-adapter](https://github.com/faforever/java-ice-adapter) in `faf-client/natives/ice-adapter` and JRE (java runtime environment) in `faf-client/natives/ice-adapter/jre`\n\nRun the client:\n\n    cd ./faf-client \u0026\u0026 PATH=$PATH:./natives \u0026\u0026 ./faf-client-venv/bin/python -m src\n\nFor more information see [the wiki](http://wiki.faforever.com/index.php?title=Setting_Up_FAF_Linux).\n\nRunning unit tests\n-------\n\nRun the lobby from the main directory using:\n\n    python3 -m src\n\nRun the unit test suite using:\n\n    python3 runtests.py\n\n\nLicense\n-------\n\nGPLv3. See the [license](license.txt) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaforever%2Fclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffaforever%2Fclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaforever%2Fclient/lists"}