[
{
"path": ".github/workflows/appimage.yml",
"content": "name: Build and publish AppImages\n\non:\n push:\n tags:\n - \"v*\"\n\nenv:\n BASE_OS: ubuntu\n APT_PUBKEY: 871920D1991BC93C\n\njobs:\n build:\n runs-on: ubuntu-latest\n\n strategy:\n fail-fast: true\n matrix:\n platform:\n - linux/amd64\n - linux/arm64\n codename:\n - jammy\n - lunar\n - mantic\n\n steps:\n - uses: actions/checkout@v4\n - uses: rlespinasse/github-slug-action@v4\n\n - name: Setup qemu for docker\n uses: docker/setup-qemu-action@v2\n if: matrix.platform != 'linux/amd64'\n\n - name: Setup buildx for docker\n uses: docker/setup-buildx-action@v2\n\n - name: Compile in docker\n uses: docker/build-push-action@v4\n with:\n platforms: ${{ matrix.platform }}\n outputs: build\n build-args: |\n BASE_OS\n BASE_CODENAME=${{ matrix.codename }}\n\n - name: Prepare environment to build AppImage\n env:\n TARGET_PLATFORM: ${{ matrix.platform }}\n shell: bash\n run: |\n set -eua\n if [ -r build/.build-metadata.env ]; then\n . build/.build-metadata.env\n rm build/.build-metadata.env\n fi\n APPIMAGE_SOURCE=build\n APPIMAGE_VERSION=\"${GITHUB_REF_SLUG}-${{ matrix.codename }}\"\n APPIMAGE_APT_ARCH=\"${TARGETARCH}\"\n APPIMAGE_APT_DISTRO=\"${{ matrix.codename }}\"\n APPIMAGE_APT_PUBKEY=\"${APT_PUBKEY}\"\n APPIMAGE_ARCH=\"${TARGETMACHINE}\"\n printenv | grep ^APPIMAGE_ >>\"${GITHUB_ENV}\"\n\n - name: Build AppImage\n uses: AppImageCrafters/build-appimage@v1.3\n\n - name: Upload artifacts\n uses: actions/upload-artifact@v3\n with:\n name: appimages\n path: |\n ./*.AppImage\n ./*.AppImage.zsync\n if-no-files-found: error\n\n release:\n if: startsWith(github.ref, 'refs/tags/')\n runs-on: ubuntu-latest\n\n needs:\n - build\n\n permissions:\n contents: write\n\n steps:\n - name: Download artifacts\n uses: actions/download-artifact@v3\n with:\n name: appimages\n path: assets\n - name: Create checksum for release assets\n shell: bash\n run: |\n algo=\"${SHA_ALGORITHM:-256}\"\n find assets -type f | while read -r asset; do\n shasum --binary --algorithm \"${algo}\" \"${asset}\" >\"${asset}.sha${algo}\"\n done\n - name: Upload artifacts to GitHub release\n uses: softprops/action-gh-release@v1\n with:\n files: assets/*\n"
},
{
"path": ".github/workflows/scc-linux.yml",
"content": "name: SCC Linux CI\n\non:\n push:\n branches:\n - main\n - master\n - python3\n pull_request:\n branches:\n - main\n - master\n - python3\n\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-python@v4\n with:\n python-version: '3.11' \n # Install dependencies\n - run: pip install pytest vdf\n # Build\n - run: python setup.py build \n # Test\n - run: python -m pytest tests\n"
},
{
"path": "ADDITIONAL-LICENSES",
"content": "All images in images/ directory, profile files in default_profiles/\nand profile_examples/ and menu files in default_menus/ directories\nare licensed under CC0 license - https://creativecommons.org/publicdomain/zero/1.0/\n\nImages in images/menu-icons subdirectories are licensed as described\nin 'LICENSES' files in their respective subdirectories.\n\nlib/enum.py is licensed under BSD license, as described in that file.\nlib/usb1.py and lib/libusb1.py are licensed under LGPL 2.1, as described in those files.\nlib/jsonencoder.py is licensed under PSFL, https://www.python.org/download/releases/2.7/license/\nscripts/gamecontrollerdb.txt is taken from Simple DirectMedia Layer library and licensed under zlib license.\nlib/xwrappers.py and lib/vdf.py are part of SC-Controller, licensed under GPL2 as rest of the project.\n\nEverything else is licensed under GPL2, as described in 'LICENCE' file.\n"
},
{
"path": "AppImageBuilder.yml",
"content": "version: 1\n\nscript:\n- |\n if [ \"{{APPIMAGE_SOURCE}}\" != \"${TARGET_APPDIR}\" ]; then\n mv \"{{APPIMAGE_SOURCE}}\" \"${TARGET_APPDIR}\"\n fi\n # Manual installation of squashfs-tools is required\n # until https://github.com/AppImageCrafters/build-appimage/issues/5 is fixed\n if ! command -v mksquashfs >/dev/null; then\n apt-get update && apt-get install -y --no-install-recommends squashfs-tools\n fi\n\nAppDir:\n app_info:\n id: org.ryochan7.sc-controller\n name: sc-controller\n version: \"{{APPIMAGE_VERSION}}\"\n icon: sc-controller\n exec: usr/bin/python3\n exec_args: -c \"import os, sys; os.execvp('$APPDIR/usr/bin/scc', ['$APPDIR/usr/bin/scc'] + (sys.argv[1:] if len(sys.argv) > 1 else ['gui']))\" $@\n\n after_bundle: |\n set -eu\n\n # appimage-builder expects .desktop file to start with appinfo-id\n desktop=\"$(find \"${TARGET_APPDIR}/usr\" -name sc-controller.desktop)\"\n sed -i \"s:Exec=.*:Exec=./usr/bin/scc gui:g\" \"${desktop}\"\n ln -sr \"${desktop}\" \"${TARGET_APPDIR}/usr/share/applications/org.ryochan7.sc-controller.desktop\"\n\n # appimage-builder expects utf-8 encoding when patching shebangs,\n # but pygettext3 has iso-8859-1 encoding\n find \"${TARGET_APPDIR}/usr/bin\" -name 'pygettext*' | while read -r file; do\n encoding=\"ISO-8859-1\"\n if file -bi \"${file}\" | grep -iq \"${encoding}\"; then\n <\"${file}\" iconv -f \"${encoding}\" -t utf-8 -o \"${file}\"\n sed -i -E '1,2 s|^(\\s*#.*coding[=:]\\s*)([[:alnum:].-]+)|\\1utf-8|g' \"${file}\"\n fi\n done\n\n apt:\n arch:\n - \"{{APPIMAGE_APT_ARCH}}\"\n sources:\n - sourceline: deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ {{APPIMAGE_APT_DISTRO}} main universe\n key_url: http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x{{APPIMAGE_APT_PUBKEY}}\n - sourceline: deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ {{APPIMAGE_APT_DISTRO}}-updates main universe\n - sourceline: deb [arch=amd64] http://security.ubuntu.com/ubuntu/ {{APPIMAGE_APT_DISTRO}}-security main universe\n - sourceline: deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports/ {{APPIMAGE_APT_DISTRO}} main universe\n - sourceline: deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports/ {{APPIMAGE_APT_DISTRO}}-updates main universe\n - sourceline: deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports/ {{APPIMAGE_APT_DISTRO}}-security main universe\n\n include:\n - gir1.2-rsvg-2.0\n - libbluetooth3\n - librsvg2-common\n - python3-evdev\n - python3-gi-cairo\n - python3-pylibacl\n - python3-vdf\n - binutils # required for detection of bluetooth library\n - coreutils # provides /usr/bin/env\n - shared-mime-info # required for gui if host provides no MIME info, e.g. when XDG_DATA_DIRS is missing\n exclude:\n - gcc* # development\n - libgcc* # development\n - libstdc* # development\n - libtirpc* # development\n - libuuid* # development\n - libattr* # filesystem\n - libblkid* # filesystem\n - libmount* # filesystem\n - libbz* # codec\n - libjpeg* # codec\n - liblzma* # codec\n - libtiff* # codec\n - libxml* # codec\n - libwebp* # codec\n - media-types # codec\n - libpixman* # X\n - libxext* # X\n - libxrender* # X\n - libfontconfig* # fonts\n - libfreetype* # fonts\n - libfribidi* # i18n\n - libicu* # i18n\n - libgmp* # arithmetics\n - libmpdec* # arithmetics\n - libncurses* # terminal\n - libreadline* # terminal\n - readline* # terminal\n - libssl* # security\n - \"*crypt*\" # security\n - \"*krb*\" # security\n - libdb* # database\n - \"*sqlite*\" # database\n - libnsl* # network\n\n\n files:\n exclude:\n - usr/bin/*gold* # alternative for ld\n - usr/bin/*gp-display-html* # since Ubuntu Lunatic, requires perl\n - usr/lib/*/gconv # unicode\n - usr/lib/*/gdk-pixbuf-2.0/*/loaders/libpixbufloader-[!s]*.so # only svg is required\n - usr/lib/*/glib-2.0\n - usr/lib/python*/cgi.py\n - usr/lib/python*/email\n - usr/lib/python*/test\n - usr/lib/python*/unittest\n - usr/share/doc\n - usr/share/glib-2.0\n - usr/share/gtk-doc\n - usr/share/icu\n - usr/share/locale\n - usr/share/man\n - usr/share/python3/runtime.d\n - usr/share/thumbnailers\n\n runtime:\n env:\n # `usr/lib/python3.*/site-packages` is required in $PYTHONPATH,\n # but the python version and hence the actual location is unknown here.\n # Fortunately the site-packages directory is on the $PATH, so we add $PATH instead.\n # It must precede an existing $PYTHONPATH to work.\n PYTHONPATH: \"${APPDIR}/usr/lib/python3/dist-packages:${PATH}:${PYTHONPATH}\"\n SCC_SHARED: \"${APPDIR}/usr/share/scc\"\n\nAppImage:\n arch: \"{{APPIMAGE_ARCH}}\"\n update-information: \"gh-releases-zsync|Ryochan7|sc-controller|latest|sc-controller-*-{{APPIMAGE_APT_DISTRO}}-{{APPIMAGE_ARCH}}.AppImage.zsync\"\n"
},
{
"path": "Dockerfile",
"content": "ARG BASE_OS=ubuntu\nARG BASE_CODENAME=jammy\nFROM $BASE_OS:$BASE_CODENAME AS build-stage\n\n# Download build dependencies\nRUN apt-get update && apt-get install -y --no-install-recommends \\\n gcc librsvg2-bin linux-headers-generic python3-dev python3-setuptools\n\n# Prepare working directory and target\nCOPY . /work\nWORKDIR /work\nARG TARGET=/build/usr\n\n# Build and install\nRUN python3 setup.py build --executable \"/usr/bin/env python3\" && \\\n python3 setup.py install --single-version-externally-managed --home \"${TARGET}\" --record /dev/null\n\n# Provide input-event-codes.h as fallback for runtime systems without linux headers\nRUN cp -a \\\n \"$(find /usr -type f -name input-event-codes.h -print -quit)\" \\\n \"$(find \"${TARGET}\" -type f -name uinput.py -printf '%h\\n' -quit)\"\n\n# Create short name symlinks for static libraries\nRUN suffix=\".cpython-*-$(uname -m)-linux-gnu.so\" && \\\n find \"${TARGET}\" -type f -path \"*/site-packages/*${suffix}\" \\\n | while read -r path; do ln -sfr \"${path}\" \"${path%${suffix}}.so\"; done\n\n# Put AppStream metadata to required location according to https://wiki.debian.org/AppStream/Guidelines\nRUN metainfo=/build/usr/share/metainfo && \\\n mkdir -p \"${metainfo}\" && \\\n cp -a scripts/sc-controller.appdata.xml \"${metainfo}\"\n\n# Convert icon to png format (required for icons in .desktop file)\nRUN iconpath=\"${TARGET}/share/icons/hicolor/512x512/apps\" && \\\n mkdir -p \"${iconpath}\" && \\\n rsvg-convert --background-color none -o \"${iconpath}/sc-controller.png\" images/sc-controller.svg\n\n# Store build metadata\nARG TARGETOS TARGETARCH TARGETVARIANT\nRUN export \"TARGETMACHINE=$(uname -m)\" && printenv | grep ^TARGET >>/build/.build-metadata.env\n\n# Keep only files required for runtime\nFROM scratch AS export-stage\nCOPY --from=build-stage /build /\n"
},
{
"path": "LICENSE",
"content": "GNU GENERAL PUBLIC LICENSE\n Version 2, June 1991\n\n Copyright (C) 1989, 1991 Free Software Foundation, Inc., \n 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The licenses for most software are designed to take away your\nfreedom to share and change it. By contrast, the GNU General Public\nLicense is intended to guarantee your freedom to share and change free\nsoftware--to make sure the software is free for all its users. This\nGeneral Public License applies to most of the Free Software\nFoundation's software and to any other program whose authors commit to\nusing it. (Some other Free Software Foundation software is covered by\nthe GNU Lesser General Public License instead.) You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthis service if you wish), that you receive source code or can get it\nif you want it, that you can change the software or use pieces of it\nin new free programs; and that you know you can do these things.\n\n To protect your rights, we need to make restrictions that forbid\nanyone to deny you these rights or to ask you to surrender the rights.\nThese restrictions translate to certain responsibilities for you if you\ndistribute copies of the software, or if you modify it.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must give the recipients all the rights that\nyou have. You must make sure that they, too, receive or can get the\nsource code. And you must show them these terms so they know their\nrights.\n\n We protect your rights with two steps: (1) copyright the software, and\n(2) offer you this license which gives you legal permission to copy,\ndistribute and/or modify the software.\n\n Also, for each author's protection and ours, we want to make certain\nthat everyone understands that there is no warranty for this free\nsoftware. If the software is modified by someone else and passed on, we\nwant its recipients to know that what they have is not the original, so\nthat any problems introduced by others will not reflect on the original\nauthors' reputations.\n\n Finally, any free program is threatened constantly by software\npatents. We wish to avoid the danger that redistributors of a free\nprogram will individually obtain patent licenses, in effect making the\nprogram proprietary. To prevent this, we have made it clear that any\npatent must be licensed for everyone's free use or not licensed at all.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n GNU GENERAL PUBLIC LICENSE\n TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION\n\n 0. This License applies to any program or other work which contains\na notice placed by the copyright holder saying it may be distributed\nunder the terms of this General Public License. The \"Program\", below,\nrefers to any such program or work, and a \"work based on the Program\"\nmeans either the Program or any derivative work under copyright law:\nthat is to say, a work containing the Program or a portion of it,\neither verbatim or with modifications and/or translated into another\nlanguage. (Hereinafter, translation is included without limitation in\nthe term \"modification\".) Each licensee is addressed as \"you\".\n\nActivities other than copying, distribution and modification are not\ncovered by this License; they are outside its scope. The act of\nrunning the Program is not restricted, and the output from the Program\nis covered only if its contents constitute a work based on the\nProgram (independent of having been made by running the Program).\nWhether that is true depends on what the Program does.\n\n 1. You may copy and distribute verbatim copies of the Program's\nsource code as you receive it, in any medium, provided that you\nconspicuously and appropriately publish on each copy an appropriate\ncopyright notice and disclaimer of warranty; keep intact all the\nnotices that refer to this License and to the absence of any warranty;\nand give any other recipients of the Program a copy of this License\nalong with the Program.\n\nYou may charge a fee for the physical act of transferring a copy, and\nyou may at your option offer warranty protection in exchange for a fee.\n\n 2. You may modify your copy or copies of the Program or any portion\nof it, thus forming a work based on the Program, and copy and\ndistribute such modifications or work under the terms of Section 1\nabove, provided that you also meet all of these conditions:\n\n a) You must cause the modified files to carry prominent notices\n stating that you changed the files and the date of any change.\n\n b) You must cause any work that you distribute or publish, that in\n whole or in part contains or is derived from the Program or any\n part thereof, to be licensed as a whole at no charge to all third\n parties under the terms of this License.\n\n c) If the modified program normally reads commands interactively\n when run, you must cause it, when started running for such\n interactive use in the most ordinary way, to print or display an\n announcement including an appropriate copyright notice and a\n notice that there is no warranty (or else, saying that you provide\n a warranty) and that users may redistribute the program under\n these conditions, and telling the user how to view a copy of this\n License. (Exception: if the Program itself is interactive but\n does not normally print such an announcement, your work based on\n the Program is not required to print an announcement.)\n\nThese requirements apply to the modified work as a whole. If\nidentifiable sections of that work are not derived from the Program,\nand can be reasonably considered independent and separate works in\nthemselves, then this License, and its terms, do not apply to those\nsections when you distribute them as separate works. But when you\ndistribute the same sections as part of a whole which is a work based\non the Program, the distribution of the whole must be on the terms of\nthis License, whose permissions for other licensees extend to the\nentire whole, and thus to each and every part regardless of who wrote it.\n\nThus, it is not the intent of this section to claim rights or contest\nyour rights to work written entirely by you; rather, the intent is to\nexercise the right to control the distribution of derivative or\ncollective works based on the Program.\n\nIn addition, mere aggregation of another work not based on the Program\nwith the Program (or with a work based on the Program) on a volume of\na storage or distribution medium does not bring the other work under\nthe scope of this License.\n\n 3. You may copy and distribute the Program (or a work based on it,\nunder Section 2) in object code or executable form under the terms of\nSections 1 and 2 above provided that you also do one of the following:\n\n a) Accompany it with the complete corresponding machine-readable\n source code, which must be distributed under the terms of Sections\n 1 and 2 above on a medium customarily used for software interchange; or,\n\n b) Accompany it with a written offer, valid for at least three\n years, to give any third party, for a charge no more than your\n cost of physically performing source distribution, a complete\n machine-readable copy of the corresponding source code, to be\n distributed under the terms of Sections 1 and 2 above on a medium\n customarily used for software interchange; or,\n\n c) Accompany it with the information you received as to the offer\n to distribute corresponding source code. (This alternative is\n allowed only for noncommercial distribution and only if you\n received the program in object code or executable form with such\n an offer, in accord with Subsection b above.)\n\nThe source code for a work means the preferred form of the work for\nmaking modifications to it. For an executable work, complete source\ncode means all the source code for all modules it contains, plus any\nassociated interface definition files, plus the scripts used to\ncontrol compilation and installation of the executable. However, as a\nspecial exception, the source code distributed need not include\nanything that is normally distributed (in either source or binary\nform) with the major components (compiler, kernel, and so on) of the\noperating system on which the executable runs, unless that component\nitself accompanies the executable.\n\nIf distribution of executable or object code is made by offering\naccess to copy from a designated place, then offering equivalent\naccess to copy the source code from the same place counts as\ndistribution of the source code, even though third parties are not\ncompelled to copy the source along with the object code.\n\n 4. You may not copy, modify, sublicense, or distribute the Program\nexcept as expressly provided under this License. Any attempt\notherwise to copy, modify, sublicense or distribute the Program is\nvoid, and will automatically terminate your rights under this License.\nHowever, parties who have received copies, or rights, from you under\nthis License will not have their licenses terminated so long as such\nparties remain in full compliance.\n\n 5. You are not required to accept this License, since you have not\nsigned it. However, nothing else grants you permission to modify or\ndistribute the Program or its derivative works. These actions are\nprohibited by law if you do not accept this License. Therefore, by\nmodifying or distributing the Program (or any work based on the\nProgram), you indicate your acceptance of this License to do so, and\nall its terms and conditions for copying, distributing or modifying\nthe Program or works based on it.\n\n 6. Each time you redistribute the Program (or any work based on the\nProgram), the recipient automatically receives a license from the\noriginal licensor to copy, distribute or modify the Program subject to\nthese terms and conditions. You may not impose any further\nrestrictions on the recipients' exercise of the rights granted herein.\nYou are not responsible for enforcing compliance by third parties to\nthis License.\n\n 7. If, as a consequence of a court judgment or allegation of patent\ninfringement or for any other reason (not limited to patent issues),\nconditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot\ndistribute so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you\nmay not distribute the Program at all. For example, if a patent\nlicense would not permit royalty-free redistribution of the Program by\nall those who receive copies directly or indirectly through you, then\nthe only way you could satisfy both it and this License would be to\nrefrain entirely from distribution of the Program.\n\nIf any portion of this section is held invalid or unenforceable under\nany particular circumstance, the balance of the section is intended to\napply and the section as a whole is intended to apply in other\ncircumstances.\n\nIt is not the purpose of this section to induce you to infringe any\npatents or other property right claims or to contest validity of any\nsuch claims; this section has the sole purpose of protecting the\nintegrity of the free software distribution system, which is\nimplemented by public license practices. Many people have made\ngenerous contributions to the wide range of software distributed\nthrough that system in reliance on consistent application of that\nsystem; it is up to the author/donor to decide if he or she is willing\nto distribute software through any other system and a licensee cannot\nimpose that choice.\n\nThis section is intended to make thoroughly clear what is believed to\nbe a consequence of the rest of this License.\n\n 8. If the distribution and/or use of the Program is restricted in\ncertain countries either by patents or by copyrighted interfaces, the\noriginal copyright holder who places the Program under this License\nmay add an explicit geographical distribution limitation excluding\nthose countries, so that distribution is permitted only in or among\ncountries not thus excluded. In such case, this License incorporates\nthe limitation as if written in the body of this License.\n\n 9. The Free Software Foundation may publish revised and/or new versions\nof the General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\nEach version is given a distinguishing version number. If the Program\nspecifies a version number of this License which applies to it and \"any\nlater version\", you have the option of following the terms and conditions\neither of that version or of any later version published by the Free\nSoftware Foundation. If the Program does not specify a version number of\nthis License, you may choose any version ever published by the Free Software\nFoundation.\n\n 10. If you wish to incorporate parts of the Program into other free\nprograms whose distribution conditions are different, write to the author\nto ask for permission. For software which is copyrighted by the Free\nSoftware Foundation, write to the Free Software Foundation; we sometimes\nmake exceptions for this. Our decision will be guided by the two goals\nof preserving the free status of all derivatives of our free software and\nof promoting the sharing and reuse of software generally.\n\n NO WARRANTY\n\n 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY\nFOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN\nOTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES\nPROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED\nOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS\nTO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE\nPROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,\nREPAIR OR CORRECTION.\n\n 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR\nREDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,\nINCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING\nOUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED\nTO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY\nYOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER\nPROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE\nPOSSIBILITY OF SUCH DAMAGES.\n\n END OF TERMS AND CONDITIONS\n"
},
{
"path": "README.md",
"content": "# SC Controller [](https://travis-ci.org/kozec/sc-controller)\n\n\nUser-mode driver, mapper and GTK3 based GUI for Steam Controller, DS4 and similar controllers.\n\n[](docs/screenshot1.png?raw=true)\n[](docs/screenshot2.png?raw=true)\n[](docs/screenshot3.png?raw=true)\n[](docs/screenshot4.png?raw=true)\n\n## Features\n- Allows to setup, configure and use Steam Controller(s) without ever launching Steam\n- Supports profiles switchable in GUI or with controller button\n- Stick, Pads and Gyroscope input\n- Haptic Feedback and in-game Rumble support\n- OSD, Menus, On-Screen Keyboard for desktop *and* in games.\n- Automatic profile switching based on active window.\n- Macros, button cycling, rapid fire, modeshift, mouse regions...\n- Emulates Xbox360 controller, mouse, trackball and keyboard.\n\nBased on [Standalone Steam Controller Driver](https://github.com/ynsta/steamcontroller) by [Ynsta](https://github.com/ynsta).\n\n## Like what I'm doing?\n\n[](https://liberapay.com/kozec) or [](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=77DQD3L9K8RPU&lc=SK&item_name=kozec&item_number=scc¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted)\n\n## Packages\n\n - **Ubuntu (deb-based distros):** Found in [openSUSE Build Service](https://software.opensuse.org/download.html?project=home%3Akozec&package=sc-controller).\n - **Fedora, SUSE (rpm-based distros):** Found in [openSUSE Build Service](https://software.opensuse.org/download.html?project=home%3Akozec&package=sc-controller).\n - **Arch, Manjaro (arch-based distros):** Found in [AUR](https://aur.archlinux.org/packages/sc-controller-git/)\n - **Solus:** Search for `sc-controller` in Software Center or run `sudo eopkg it sc-controller` from a terminal.\n - **Exherbo:** Found in [hardware](https://git.exherbo.org/summer/packages/input/sc-controller)\n - **Void Linux:** Run `xbps-install -S sc-controller` in a terminal.\n\n\n## Building the package by yourself\n\n### Dependencies\n - python 3, GTK 3.22 or newer and [PyGObject](https://live.gnome.org/PyGObject)\n - [python-gi-cairo](https://packages.debian.org/sid/python-gi-cairo) and [gir1.2-rsvg-2.0](https://packages.debian.org/sid/gir1.2-rsvg-2.0) on debian based distros (included in PyGObject elsewhere)\n - [setuptools](https://pypi.python.org/pypi/setuptools)\n - [python-pylibacl](http://pylibacl.k1024.org/) is recommended\n - [python-evdev](https://python-evdev.readthedocs.io/en/latest/) is strongly recommended\n - [python-vdf](https://pypi.org/project/vdf/)\n - [gtk-layer-shell](https://github.com/wmww/gtk-layer-shell) (Wayland only)\n\n### Installing\n - Download and extract [latest release](https://github.com/kozec/sc-controller/releases/latest)\n - `python3 setup.py build`\n - `python3 setup.py install`\n\n\n## Running with non distro-specific package \n - Download and extract [latest release](https://github.com/kozec/sc-controller/releases/latest)\n - Navigate to extracted directory and execute `./run.sh`\n"
},
{
"path": "TODO.md",
"content": "List of (possibly) planned features in no particular order:\n\n- Multiple on-screen menus (and possibly keyboards) when using multiple controllers\n- Injecting emulated xbox controller into wine\n\nHard stuff:\n- Injecting emulated xbox controller into PlayOnLinux\n\nVery hard stuff:\n- Visual feedback in binding editor ( [what this guy says](https://www.reddit.com/r/linux_gaming/comments/5pcdmr/sc_controller_use_steam_controller_without_steam/dcqpvf4/) )\n\n**Done** stuff:\n- Multicontroller support\n- Configurable gamepad type (e.g. 4 axes and 16 buttons)\n- Steam Profile import\n- Radial Menu for the Joystick/Trackpad\n- Copy & paste\n- Cycling Buttons\n- Process monitor (or active window monitor) with switch\n- Mouse regions\n- Touch-Menu\n- Menu in OSD\n- OSD\n- double click\n- on-screen keyboard\n- Spining mouse wheel rotation\n- Haptic feedback support\n- Gyroscope input\n- Gamepad button as modifier (modeshift)\n- Macros\n- Turbo\n- Trigger settings\n- DPAD that acts only when clicked\n- 8-way DPAD\n- Selector for media keys"
},
{
"path": "appimage-build.sh",
"content": "#!/bin/bash\nAPP=\"sc-controller\"\nEXEC=\"scc\"\nLIB=\"lib\"\n\nEVDEV_VERSION=0.7.0\n[ x\"$BUILD_APPDIR\" == \"x\" ] && BUILD_APPDIR=$(pwd)/appimage\nPYTHON_VERSION=$(python3 -c 'import sys; version=sys.version_info[:3]; print(\"{0}.{1}\".format(*version))')\nSITE_PACKAGES_PATH=$(python3 -c \"import os,sys; print([p for p in sys.path if p.endswith('site-packages') and sys.prefix in p][0])\")\n\nif [ -z ${SITE_PACKAGES_PATH} ]; then\n echo \"Could not determine global site-packages path. Exiting\";\n exit 1;\nfi\n\nfunction download_dep() {\n\tNAME=$1\n\tURL=$2\n\tif [ -e ../../${NAME}.obstargz ] ; then\n\t\t# Special case for OBS\n\t\tcp ../../${NAME}.obstargz /tmp/${NAME}.tar.gz\n\telif [ -e ${NAME}.tar.gz ] ; then\n\t\tcp ${NAME}.tar.gz /tmp/${NAME}.tar.gz\n\telif [ -e /tmp/${NAME}.tar.gz ] ; then\n\t\techo \"/tmp/${NAME}.tar.gz already downloaded\"\n\telse\n\t\twget -c \"${URL}\" -O /tmp/${NAME}.tar.gz\n\tfi\n}\n\nfunction build_dep() {\n\tNAME=\"$1\"\n\tmkdir -p /tmp/${NAME}\n\tpushd /tmp/${NAME}\n\ttar --extract --strip-components=1 -f /tmp/${NAME}.tar.gz\n\tPYTHONPATH=${BUILD_APPDIR}/usr/lib/python${PYTHON_VERSION}/site-packages python3 \\\n\t\tsetup.py install --optimize=1 \\\n\t\t--prefix=\"/usr/\" --root=\"${BUILD_APPDIR}\"\n\tmkdir -p \"${BUILD_APPDIR}/usr/lib/python${PYTHON_VERSION}/site-packages/\"\n\tpython3 setup.py install --prefix=\"/usr/\" --root=\"${BUILD_APPDIR}\"\n\tpopd\n}\n\nfunction unpack_dep() {\n\tNAME=\"$1\"\n\tpushd ${BUILD_APPDIR}\n\ttar --extract --exclude=\"usr/include**\" --exclude=\"usr/lib/pkgconfig**\" \\\n\t\t\t--exclude=\"usr/lib/python2.7**\" -f /tmp/${NAME}.tar.gz\n\tpopd\n}\n\nset -ex\t\t# display commands, terminate after 1st failure\n\n# Download deps\ndownload_dep \"python-evdev-0.7.0\" \"https://github.com/gvalkov/python-evdev/archive/v0.7.0.tar.gz\"\ndownload_dep \"pylibacl-0.6.0\" \"https://github.com/iustin/pylibacl/releases/download/v0.6.0/pylibacl-0.6.0.tar.gz\"\ndownload_dep \"python-gobject-3.36.1\" \"https://archive.archlinux.org/packages/p/python-gobject/python-gobject-3.36.1-1-x86_64.pkg.tar.zst\"\ndownload_dep \"python-vdf-3.4\" \"https://github.com/ValvePython/vdf/archive/v3.4.tar.gz\"\ndownload_dep \"libpng-1.6.34\" \"https://archive.archlinux.org/packages/l/libpng/libpng-1.6.34-2-x86_64.pkg.tar.xz\"\ndownload_dep \"gdk-pixbuf-2.36.9\" \"https://archive.archlinux.org/packages/g/gdk-pixbuf2/gdk-pixbuf2-2.36.9-1-x86_64.pkg.tar.xz\"\ndownload_dep \"libcroco-0.6.13\" \"https://archive.archlinux.org/packages/l/libcroco/libcroco-0.6.13-1-x86_64.pkg.tar.xz\"\ndownload_dep \"libxml2-2.9.10\" \"https://archive.archlinux.org/packages/l/libxml2/libxml2-2.9.10-2-x86_64.pkg.tar.zst\"\ndownload_dep \"librsvg-2.48.7\" \"https://archive.archlinux.org/packages/l/librsvg/librsvg-2%3A2.48.7-1-x86_64.pkg.tar.zst\"\ndownload_dep \"icu-67.1\" \"https://archive.archlinux.org/packages/i/icu/icu-67.1-1-x86_64.pkg.tar.zst\"\ndownload_dep \"zlib-1:1.2.12\" \"https://archive.archlinux.org/packages/z/zlib/zlib-1%3A1.2.12-2-x86_64.pkg.tar.zst\"\ndownload_dep \"libffi-3.4.3\" \"https://archive.archlinux.org/packages/l/libffi/libffi-3.4.3-1-x86_64.pkg.tar.zst\"\n\n# Prepare & build deps\nexport PYTHONPATH=${BUILD_APPDIR}/usr/lib/python${PYTHON_VERSION}/site-packages/\nmkdir -p \"$PYTHONPATH\"\nif [[ $(grep ID_LIKE /etc/os-release) == *\"suse\"* ]] ; then\n\t# Special handling for OBS\n\tln -s lib64 ${BUILD_APPDIR}/usr/lib\n\texport PYTHONPATH=\"$PYTHONPATH\":${BUILD_APPDIR}/usr/lib64/python${PYTHON_VERSION}/site-packages/\n\tLIB=lib64\nfi\n\nbuild_dep \"python-evdev-0.7.0\"\nbuild_dep \"pylibacl-0.6.0\"\nbuild_dep \"python-vdf-3.4\"\nunpack_dep \"python-gobject-3.36.1\"\nunpack_dep \"libpng-1.6.34\"\nunpack_dep \"gdk-pixbuf-2.36.9\"\nunpack_dep \"libcroco-0.6.13\"\nunpack_dep \"libxml2-2.9.10\"\nunpack_dep \"librsvg-2.48.7\"\nunpack_dep \"icu-67.1\"\nunpack_dep \"zlib-1:1.2.12\"\nunpack_dep \"libffi-3.4.3\"\n\n# Remove uneeded files\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-ani.so\"\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-bmp.so\"\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-gif.so\"\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-icns.so\"\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-ico.so\"\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-jasper.so\"\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-jpeg.so\"\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-qtif.so\"\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-tga.so\"\nrm -f \"${BUILD_APPDIR}/usr/${LIB}/gdk-pixbuf-2.0/2.10.0/loaders/libpixbufloader-tiff.so\"\nrm -R \"${BUILD_APPDIR}/usr/lib/cmake\"\nrm -R \"${BUILD_APPDIR}/usr/share/doc\"\nrm -R \"${BUILD_APPDIR}/usr/share/gtk-doc\"\nrm -R \"${BUILD_APPDIR}/usr/share/locale\"\nrm -R \"${BUILD_APPDIR}/usr/share/man\"\nrm -R \"${BUILD_APPDIR}/usr/share/thumbnailers\"\nrm -R \"${BUILD_APPDIR}/usr/share/vala\"\nrm -R \"${BUILD_APPDIR}/usr/share/icu\"\n\n# Build important part. Need executable flag to place custom interpreter line.\n# Setuptools overrrides original #! line in scripts with /usr/bin/python.\n# Ubuntu 22.04 LTS does not provide an executable at /usr/bin/python\n# by default.\npython3 setup.py build --executable \"/usr/bin/env python3\"\n\n# Need to use single-version-externally-managed due to setuptools behavior\npython3 setup.py install --single-version-externally-managed --prefix ${BUILD_APPDIR}/usr --record /dev/null\n\n# Move udev stuff\nmv ${BUILD_APPDIR}/usr/lib/udev/rules.d/69-${APP}.rules ${BUILD_APPDIR}/\nrmdir ${BUILD_APPDIR}/usr/lib/udev/rules.d/\nrmdir ${BUILD_APPDIR}/usr/lib/udev/\nmkdir -p ${BUILD_APPDIR}/usr/${LIB}/python${PYTHON_VERSION}/site-packages/scc/\ncp \"/usr/include/linux/input-event-codes.h\" ${BUILD_APPDIR}/usr/${LIB}/python${PYTHON_VERSION}/site-packages/scc/\n\n# Move & patch desktop file\nmv ${BUILD_APPDIR}/usr/share/applications/${APP}.desktop ${BUILD_APPDIR}/\nsed -i \"s/Icon=.*/Icon=${APP}/g\" ${BUILD_APPDIR}/${APP}.desktop\nsed -i \"s/Exec=.*/Exec=.\\/usr\\/bin\\/scc gui/g\" ${BUILD_APPDIR}/${APP}.desktop\n\n# Convert icon\nconvert -background none ${BUILD_APPDIR}/usr/share/pixmaps/${APP}.svg ${BUILD_APPDIR}/${APP}.png\n\n# Copy appdata.xml\nmkdir -p ${BUILD_APPDIR}/usr/share/metainfo/\ncp scripts/${APP}.appdata.xml ${BUILD_APPDIR}/usr/share/metainfo/${APP}.appdata.xml\n\n# Make symlinks\nln -sfr ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/libcemuhook.cpython-310-x86_64-linux-gnu.so ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/libcemuhook.so\nln -sfr ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/libhiddrv.cpython-310-x86_64-linux-gnu.so ${BUILD_APPDIR}${SITE_PACKAGES_PATH}//libhiddrv.so\nln -sfr ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/libremotepad.cpython-310-x86_64-linux-gnu.so ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/libremotepad.so\nln -sfr ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/libsc_by_bt.cpython-310-x86_64-linux-gnu.so ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/libsc_by_bt.so\nln -sfr ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/libuinput.cpython-310-x86_64-linux-gnu.so ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/libuinput.so\nln -sfr ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/posix1e.cpython-310-x86_64-linux-gnu.so ${BUILD_APPDIR}${SITE_PACKAGES_PATH}/posix1e.so\n\n# Copy AppRun script\ncp scripts/appimage-AppRun.sh ${BUILD_APPDIR}/AppRun\nchmod +x ${BUILD_APPDIR}/AppRun\n\necho \"Run appimagetool -n ${BUILD_APPDIR} to finish prepared appimage\"\n"
},
{
"path": "daemon.sh",
"content": "#!/bin/bash\n\n# Ensure correct cwd\ncd \"$(dirname \"$0\")\"\n\n# Set PATH\nSCRIPTS=\"$(pwd)/scripts\"\nexport PATH=\"$SCRIPTS\":\"$PATH\"\nexport PYTHONPATH=\".\":\"$PYTHONPATH\"\nexport SCC_SHARED=\"$(pwd)\"\n\nif [ x\"$1\" == x\"lldb\" ] ; then\n\tshift\n\tlldb python3 -- 'scripts/scc-daemon' debug $@\nelse\n\tpython3 'scripts/scc-daemon' $@\nfi\n"
},
{
"path": "default_menus/Default.menu",
"content": "[{\n \"separator\": true,\n \"name\": \"Recent profiles\"\n}, {\n \"generator\": \"recent\",\n \"rows\": 3\n}, {\n \"submenu\": \"Profiles.menu\",\n \"icon\": \"system/profiles\",\n \"name\": \"All Profiles\"\n}, {\n \"separator\": true,\n \"name\": \"Options\"\n}, {\n \"submenu\": \".autoswitch.menu\",\n \"icon\": \"system/autoswitch\",\n \"name\": \"Autoswitch Options\"\n}, {\n \"action\": \"turnoff()\", \n \"id\": \"item4\", \n \"icon\": \"system/turn-off\",\n \"name\": \"Turn Controller OFF\", \n \"osd\": true\n}, {\n \"action\": \"keyboard()\", \n \"id\": \"item5\", \n \"icon\": \"system/keyboard\",\n \"name\": \"Display Keyboard\"\n}]\n"
},
{
"path": "default_menus/Profiles.menu",
"content": "[{\n \"separator\": true,\n \"name\": \"All profiles\"\n}, {\n \"generator\" : \"profiles\"\n}]\n"
},
{
"path": "default_profiles/Desktop.sccprofile",
"content": "{\n \"_\": \"\", \n \"buttons\": {\n \"A\": {\n \"action\": \"button(Keys.KEY_ENTER)\"\n }, \n \"B\": {\n \"action\": \"button(Keys.KEY_ESC)\"\n }, \n \"BACK\": {\n \"action\": \"button(Keys.KEY_BACKSPACE)\"\n }, \n \"C\": {\n \"action\": \"hold(menu('Default.menu'), menu('Default.menu'))\"\n }, \n \"CPADPRESS\": {\n \"action\": \"button(Keys.BTN_LEFT)\"\n }, \n \"LB\": {\n \"action\": \"button(Keys.KEY_LEFTCTRL)\"\n }, \n \"RB\": {\n \"action\": \"button(Keys.KEY_LEFTALT)\"\n }, \n \"RPAD\": {\n \"action\": \"button(Keys.BTN_LEFT)\"\n }, \n \"START\": {\n \"action\": \"button(Keys.KEY_LEFTSHIFT)\"\n }, \n \"X\": {\n \"action\": \"button(Keys.KEY_SPACE)\"\n }, \n \"Y\": {\n \"action\": \"button(Keys.KEY_TAB)\"\n }\n }, \n \"cpad\": {\n \"action\": \"mouse()\"\n }, \n \"gyro\": {},\n \"is_template\": false, \n \"menus\": {}, \n \"pad_left\": {\n \"action\": \"feedback(LEFT, 4096, 16, ball(XY(mouse(Rels.REL_HWHEEL, 1.0), mouse(Rels.REL_WHEEL, 1.0))))\"\n }, \n \"pad_right\": {\n \"action\": \"smooth(8, 0.78, 2.0, feedback(RIGHT, 256, ball(mouse())))\"\n }, \n \"stick\": {\n \"action\": \"dpad(button(Keys.KEY_UP), button(Keys.KEY_DOWN), button(Keys.KEY_LEFT), button(Keys.KEY_RIGHT))\"\n }, \n \"trigger_left\": {\n \"action\": \"button(Keys.BTN_RIGHT)\"\n }, \n \"trigger_right\": {\n \"action\": \"button(Keys.BTN_LEFT)\"\n }, \n \"version\": 1.4\n}\n"
},
{
"path": "default_profiles/XBox Controller with High Precision Camera.sccprofile",
"content": "{\n \"_\": \"\", \n \"buttons\": {\n \"A\": {\n \"action\": \"button(Keys.BTN_GAMEPAD)\"\n }, \n \"B\": {\n \"action\": \"button(Keys.BTN_EAST)\"\n }, \n \"BACK\": {\n \"action\": \"button(Keys.BTN_SELECT)\"\n }, \n \"C\": {\n \"action\": \"hold(menu('Default.menu'), menu('Default.menu'))\"\n }, \n \"LB\": {\n \"action\": \"button(Keys.BTN_TL)\"\n }, \n \"LGRIP\": {\n \"action\": \"button(Keys.BTN_GAMEPAD)\"\n }, \n \"RB\": {\n \"action\": \"button(Keys.BTN_TR)\"\n }, \n \"RGRIP\": {\n \"action\": \"button(Keys.BTN_NORTH)\"\n }, \n \"RPAD\": {\n \"action\": \"button(Keys.BTN_THUMBR)\"\n }, \n \"START\": {\n \"action\": \"button(Keys.BTN_START)\"\n }, \n \"STICKPRESS\": {\n \"action\": \"button(Keys.BTN_THUMBL)\"\n }, \n \"X\": {\n \"action\": \"button(Keys.BTN_NORTH)\"\n }, \n \"Y\": {\n \"action\": \"button(Keys.BTN_WEST)\"\n }\n }, \n \"cpad\": {}, \n \"gyro\": {}, \n \"is_template\": false, \n \"menus\": {}, \n \"pad_left\": {\n \"action\": \"click(dpad(hatup(Axes.ABS_HAT0Y), hatdown(Axes.ABS_HAT0Y), hatleft(Axes.ABS_HAT0X), hatright(Axes.ABS_HAT0X)))\"\n }, \n \"pad_right\": {\n \"action\": \"smooth(8, 0.78, feedback(RIGHT, 256, ball(mouse())))\"\n }, \n \"stick\": {\n \"action\": \"sens(1.2, 1.2, XY(axis(Axes.ABS_X), raxis(Axes.ABS_Y)))\"\n }, \n \"trigger_left\": {\n \"action\": \"axis(Axes.ABS_Z)\"\n }, \n \"trigger_right\": {\n \"action\": \"axis(Axes.ABS_RZ)\"\n }, \n \"version\": 1.4\n}"
},
{
"path": "default_profiles/XBox Controller.sccprofile",
"content": "{\n \"_\": \"\", \n \"buttons\": {\n \"A\": {\n \"action\": \"button(Keys.BTN_GAMEPAD)\"\n }, \n \"B\": {\n \"action\": \"button(Keys.BTN_EAST)\"\n }, \n \"BACK\": {\n \"action\": \"button(Keys.BTN_SELECT)\"\n }, \n \"C\": {\n \"action\": \"hold(menu('Default.menu'), menu('Default.menu'))\"\n }, \n \"LB\": {\n \"action\": \"button(Keys.BTN_TL)\"\n }, \n \"LGRIP\": {\n \"action\": \"button(Keys.BTN_GAMEPAD)\"\n }, \n \"RB\": {\n \"action\": \"button(Keys.BTN_TR)\"\n }, \n \"RGRIP\": {\n \"action\": \"button(Keys.BTN_NORTH)\"\n }, \n \"RPAD\": {\n \"action\": \"button(Keys.BTN_THUMBR)\"\n }, \n \"START\": {\n \"action\": \"button(Keys.BTN_START)\"\n }, \n \"STICKPRESS\": {\n \"action\": \"button(Keys.BTN_THUMBL)\"\n }, \n \"X\": {\n \"action\": \"button(Keys.BTN_NORTH)\"\n }, \n \"Y\": {\n \"action\": \"button(Keys.BTN_WEST)\"\n }\n }, \n \"cpad\": {}, \n \"gyro\": {\n \t\"action\": \"cemuhook\"\n }, \n \"is_template\": false, \n \"menus\": {}, \n \"pad_left\": {\n \"action\": \"click(dpad(hatup(Axes.ABS_HAT0Y), hatdown(Axes.ABS_HAT0Y), hatleft(Axes.ABS_HAT0X), hatright(Axes.ABS_HAT0X)))\"\n }, \n \"pad_right\": {\n \"action\": \"feedback(RIGHT, 256, XY(axis(Axes.ABS_RX), raxis(Axes.ABS_RY)))\"\n }, \n \"stick\": {\n \"action\": \"sens(1.2, 1.2, XY(axis(Axes.ABS_X), raxis(Axes.ABS_Y)))\"\n }, \n \"trigger_left\": {\n \"action\": \"axis(Axes.ABS_Z)\"\n }, \n \"trigger_right\": {\n \"action\": \"axis(Axes.ABS_RZ)\"\n }, \n \"version\": 1.4\n}\n"
},
{
"path": "docs/actions.md",
"content": "### In this document\n- [Custom Action page](#examples1)\n- [List of all known actions](#actions)\n- [Macros and operators](#macros)\n- [Profile file examples](#examples2)\n\n# Custom Action page examples\n\n- To do two or more things at once, type `action() and action()`\n- To do two or more things in sequence, type `action() ; action()`\n- Typing second action on new line is same thing as using `and`\n\n#### Press button repeadedly, rapid fire mode\n`repeat(button(BTN_A))` (see [repeat](#repeat), [button](#button))\n\n#### Press Alt+F4\n`button(KEY_LEFTALT) and button(KEY_F4)`\n\n#### Press multiple buttons in sequence\n`button(BTN_A) ; button(BTN_X); button(BTN_B)`\n\n#### Press button and hold it for set delay\n`press(BTN_A) ; sleep(0.5); release(BTN_B)` (see [press](#press), [sleep](#sleep), [release](#release))\n\n\n# Actions\n\n#### button(button1 [, button2 = None ])\n- For button, simply maps real button to emulated\n- For stick or pad, 'button1' is pressed when stick or finger on pad is moved\n to up or left and 'button2' when to down or right.\n Using [dpad](#dpad) may be better for such situations.\n- For trigger, when trigger is pressed, but until it clicks, 'button2' is\n pressed. When trigger clicks 'button2' is released and replaced by 'button1'.\n If only 'button1' is set, trigger acts as big button.\n \n Note that 'button2' is always optional.\n\n\n#### mouse(axis) \n\n- For stick, lets cursor or mouse wheel to be controlled by stick tilt.\n- For pad, acts as trackpad - sliding finger over pad moves the mouse.\n If set to *REL_WHEEL* or *REL_HWHEEL*, emulates finger scroll.\n You can use `ball(mouse)` to emulate trackball.\n- For gyroscope, controls mouse with changes in controller pitch and roll/yaw.\n Axis parameter should be either YAW or ROLL (constants) and decides which\n gyroscope axis controls X mouse axis.\n- For button, pressing button maps to single movement over mouse axis or\n single step on scroll wheel.\n\n\n#### mouseabs(axis)\n\n- For stick, lets cursor or mouse wheel to be controlled by stick tilt.\n- For pad, distance from center of pad controls speed of mouse movement\n- For gyroscope, please, use gyroabs action.\n\n\n#### trackpad(axis)\nMerged with [mouse](#mouse), does same thing.\n\n\n#### axis(id [, min = -32767, max = 32767 ])\n- For button, pressing button maps to moving axis full way to 'max'.\neleasing button returns emulated axis back to 'min'.\n- For stick or pad, simply maps real axis to emulated\n- For trigger, maps trigger position to to emulated axis. Note that default\n trigger position is not in middle, but in minimal possible value.\n\n\n#### dpad([diagonal_range,] up, down, left, right)\nEmulates dpad. Touchpad is divided into 8 triangular parts. When the user\ntouches the touchpad, action is executed depending on finger position.\n\n'diagonal_range' is specified in degrees (1 to 89). If not set, all parts are\nsized equally, otherwise, diagonal parts are taking specified portion of pad\nand rest is assigned to up/left/right/down portions.\n\nAvailable only for pads and sticks.\n\n\n#### dpad8([diagonal_range,] up, down, left, right, upleft, upright, downleft, downright)\nSame as dpad, with more directions.\n\n\n#### ring([radius=0.5], inner, outer)\nDefines outer and inner ring bindings. When distance of finger from center of\npad is smaller than 'radius', 'inner' action is activated, otherwise, 'outer'\ntakes place.\n\nUnlike [dpad](#dpad), which executes actions as if they were bound to buttons,\nring works more like defining two actions on same pad with non-overlapping\ndeadzones.\n\n\n#### area(x1, y1, x2, y2), winarea(x1, y1, x2, y2)\nCreates 1:1 mapping between finger position on pad and mouse position in\nspecified screen area. Coordinates are in pixels with (0,0) on top,left corner.\nNegative number can be used to count from other side of screen.\n\n`winarea` does same thing but with position relative to current window instead of entire screen.\n\n\n#### relarea(x1, y1, x2, y2), relwinarea(x1, y1, x2, y2)\nCreates 1:1 mapping between finger position on pad and mouse position in\nspecified screen area. Coordinates are fractions of screen width and height,\n(0,0) is top,left and (1,1) bottom,right corner of screen.\n\n`relwinarea` does same thing but with position relative to current window instead of entire screen.\n\n\n#### trigger(press_level, [release_level, ] action)\nMaps action to be executed as by button press when trigger is pressed through\n'press_level'. Level goes from 0 to 255, where 255 is level after physical\ntrigger clicks.\nThen, optionally, if trigger is pressed through 'release_level', action is\n\"released\". If release_level is not set, action will be released only after\ntrigger value moves back beyond press_level.\n\nIt's possible to map multiple actions on different trigger levels using [and](#and).\n\nExamples:\n\nHold right mouse button while trigger is being pressed, press left button when\ntrigger clicks. Right button is released only when trigger is fully released.\n```\ntrigger(64, 255, button(BTN_RIGHT)) and trigger(255, button(BTN_LEFT))\n```\n\nControl left virtual trigger while trigger is being pressed and press left button\njust before trigger clicks. If trigger clicks, press enter key and play feedback.\n```\n\ttrigger(64, 255, axis(ABS_Z))\nand\n\ttrigger(240, 254, button(BTN_LEFT))\nand\n\ttrigger(255, feedback(LEFT, button(KEY_ENTER)))\n```\n\n#### hipfire([partialpress_level, ][fullpress_level, ] partialpress_action, fullpress_action [, mode][, delay])\nMaps two different actions to be executed when trigger is inside a defined range and meet predefined conditions.\nBasically, the \"partialpress_action\" will be activated if the trigger is pressed passed the \"partialpress_level\" and it stays inside the range between this level and the \"fullpress_level\" until the \"delay\" ends, otherwise, the \"fullpress_action\" will be activated ALONE if the \"fullpress_level\" is reached before the \"delay\" ends.\n\nThe partial and full levels goes from 0 to 255, and the values 50 and 254 are used for \"partialpress_level\" and \"fullpress_level\", respectively, if none is passed.\n\nThe \"mode\" can be defined as described below and the \"NORMAL\" one is used if none is passed.\n\nModes available:\n\n - NORMAL - if trigger is pressed beyond the \"partialpress_level\" and the timeout is reached, the \"partialpress_action\" is executed. If the \"partialpress_action\" was pressed it will only be released after the trigger return back beyond the \"partialpress_level\". The \"fullpress_action\" will be executed every time the \"fullpress_level\" is reached, but if this level is reached before the timeout the \"partialpres_action\" will not be triggered until releasing the trigger.\n - EXCLUSIVE - Acts similar to the previous mode, but the \"fullpress_action\" is only triggered if the \"partialpres_action\" was not triggered. Meaning it will only activate if the \"fullpress_level\" is reached before the timeout ends.\n - SENSIBLE - Acts similar to NORMAL, but after the \"partialpress_action\" is activated, releasing the trigger a little, will deactivate the action allowing it to be activated again more faster without needing to release the trigger back beyond the \"partialpress_level\". \n\nThe \"delay\" is time window used to determine if the \"partialpress_action\" should or not be activated. \n\nExamples:\n\nHold right mouse button while trigger is being softly pressed and press left mouse button when trigger click, but will bypass the right mouse button and only press the left mouse button if the trigger is pressed very fast to the click.\n```\nhipfire(50, 254, button(BTN_RIGHT),button(BTN_LEFT), NORMAL, 0.20)\n```\n\nPress A if the trigger is pressed slowly and not reaches the click or press B if the trigger is pressed fast and reached the click, and will execute only one of this two actions.\n\n```\nhipfire(50, 254, button(KEY_A),button(KEY_B), EXCLUSIVE, 0.15)\n```\n\n#### gyro(axis1 [, axis2 [, axis3]])\nMaps *changes* in gyroscope pitch, yaw and roll movement into movements of gamepad stick.\nCan be used to map gyroscope to camera when camera can be controlled only with analog stick.\n\n\n#### gyroabs(axis1 [, axis2 [, axis3]])\nMaps absolute gyroscope pitch, yaw and roll movement into movements of mouse\nor gamepad stick.\nCan be used to map gyroscope to movement stick or to use controller as racing wheel.\n\n\n#### resetgyro()\nResets gyroscope offsets so current orientation is treated as neutral.\n\n\n#### cemuhook()\nWhen set to gyro, outputs gyroscope data in way compatibile with Cemu, Citra and\nother applications using CemuHookUDP motion provider protocol.\n\n\n#### gyro(front_down, front_up, tilt_left, tilt_right)\nMaps tilting of gamepad into actions. When gamepad is tilt to one of for supported\nsides, assigned action is executed as if by button press and then \"released\" after\ngamepad is balanced again.\n\n\n#### trackball()\nSplit to [ball](#ball) modifier and [mouse](#mouse) action.\n\nTyping `trackball` works as alias for `ball(mouse())`\n\n\n#### XY(xaction, yaction)\nProvides way to assign two different actions to two stick or pad axes.\nThis is automatically handled by GUI, so user usually doesn't need\nto write it directly.\n\n\n#### relXY(xaction, yaction)\nWorks same as [XY](#XY), but treats position where pad is touched as \"center\"\nof pad.\n\n\n#### press(button)\nPresses button and leaves it pressed.\n\n\n#### release(button)\nReleases pressed button.\n\n\n#### tap(button, number=1)\nPresses button for a short while, 'number' times.\n\nIf 'number' is greater than 1 (when double-tap is performed), tapped button\nis kept press as long as physical button that started tap is pressed. For single\ntap, virtual button is released right away.\n\nIf virtual button is already pressed before tapping, it is released first and\nrestored after tap, resulting in sequence of \"release - press - release - press\"\n\n\n#### profile(name)\nLoads another profile\n\n\n#### shell(command)\nExecutes command on background\n\n\n#### turnoff()\nTurns controller off\n\n\n#### restart()\nRestarts scc-daemon. Don't use unless you have good reason to.\n\n\n#### led(brightness)\nSets brightness of controller led. 'Brightness' is percent in 0 to 100 range.\n\n\n#### osd([timeout=5, [size=3]], text)\nDisplays message in OSD.\n\n'timeout' sets for how many seconds should message stay visible. Value of 0 has\nspecial meaning and leaves message displayed indefinitely, until profile is\nchanged or [clearosd](#clearosd) action is used.\n\n'size' sets size of font on message. Only three options are supported right now,\n3 for \"default size\", 2 for \"smalller\" and 1 for \"small\".\n\n\n\n#### clearosd()\nClears all windows from OSD layer. Cancels all menus, clears all messages,\nhides on screen keyboard.\n\nDoes _not_ clear OSD windows created using command line tools.\n\n\n#### menu(menu [, confirm_button=A [, cancel_button=B [, show_with_release=False]]]])\nDisplays OSD menu.\n'confirm_button' and 'cancel_button' sets which gamepad button should be used to\nconfirm/cancel menu. Additionaly, 'confirm_button' can be set to SAME (constant),\nin which case menu will be closed and selected item choosen when button used to\ndisplay menu is released.\n\nIf 'show_with_release' is set to true, menu is displayed only after button\nis released.\n\n'menu' can be either id of menu defined in same profile file or filename\nrelative to `~/.config/scc/menus` or `/usr/share/scc/default_menus/`, whichever\nexists, in that order.\n\n\n#### hmenu(menu [, confirm_button=A [, cancel_button=B [, show_with_release=False]]]])\nSame as `menu`, but packed in one row.\n\n\n#### gridmenu(menu [, confirm_button=A [, cancel_button=B [, show_with_release=False]]]])\nSame as `menu`, but displays items in grid.\n\n\n#### radialmenu(menu [, confirm_button=A [, cancel_button=B [, show_with_release=False]]]])\nSame as `menu`, but displays items in radial menu.\n\n\n#### quickmenu(menu)\nSpecial kind of menu controled by buttons instead of stick. Every item has\nassigned button and user selects it by pressing that button.\n\nFast to use, but is limited to 6 items at most.\n\n\n#### dialog([ confirm_button=A [, cancel_button=B ], ] text, action1, [action2... actionN])\nDisplays OSD dialog. Dialog works similary to horizontal menu and displays\ntext message above list of options.\n\n\n#### keyboard()\nDisplays on-screen keyboard\n\n# Modifiers:\n\n#### click(action)\nCreates action action that occurs only if pad or stick is pressed.\nFor example, `click(dpad(...))` set to pad will create dpad that activates\nbuttons only when pressed.\n\n#### pressed(action)\nCreates action that occurs for brief moment when button is pressed.\nFor example, `pressed(button(A))` will press and instantly release virtual\nA button whenever physical button is pressed.\n\n#### released(action)\nCreates action that occurs for brief moment when button is released.\n\n#### pressed(action)\nCreates action that occurs for brief moment when finger touches pad.\n\n#### released(action)\nCreates action that occurs for brief moment when pad is released.\n\n#### mode(button1, action1, [button2, action2... buttonN, actionN] [, default] )\nDefines mode shifting. If physical buttonX is pressed, actionX is executed.\nOptional default action is executed if none from specified buttons is pressed.\n\n\n#### gestures([precision=0,] gesture1, action1, [gesture2, action2... gestureN, actionN] )\nIf set to left or right pad, enables gesture recognition. If GestureX\nis drawn, actionX is executed.\n\nIf 'precision' is set to 1.0, gesture has to be exact. Otherwise,\ngestures resembling input with given precision are compared and\none that matches it most is used. At precision of 0.0, all gestures are considered.\n\nGestures are encoded in string and it's\nrecommended to use GUI to record them. Nevertheless, format is simple:\n- Each stroke in one of four directions is stored as single character.\n- Characters are uppercase `U`, `D`, `L`, `R` for up, down, left, right\n- Default stroke length is 1/3 of pad size.\n- For stroke with twice of that length, characters is repeated twice\n- Three times for stroke through entire pad, or even more for longer.\n- If string starts with lowercase `i`, stroke length is ignored.\n\n\n#### doubleclick(doubleclick_action [, normal_action [, timeout ]])\nExecutes action if user double-clicks button.\nOptional normal_action parameter specifies action that is executed when user\nclick button only once. Optional time arguments modifies maximum delay in \ndoubleclick and in effect sets delay before normal action is executed.\n\n#### hold(hold_action [, normal_action [, timeout ]])\nExecutes action if user holds button for longer time.\nOptional normal_action parameter specifies action that is executed when user\nclick button shortly. Optional time arguments modifies how long \"longer time\" is.\n\nHold and doubleclick can be combined together by writing\n`hold([time,] hold_action, doubleclick(doubleclick_action, normal_action))`\n\n\n#### sens(x_axis [, y_axis [, z_axis]], action)\nModifies sensitivity of physical stick or pad.\n\n\n#### rotate(angle, action)\nRotates input pad or stick input by given angle.\n\n\n#### feedback(side, [amplitude=256 [, frequency=4 [, period=100 [, count=1 ]]]], action)\nEnables haptic feedback for specified action, if action supports it.\nSide has to be one of LEFT, RIGHT or BOTH. All remaining numbers can be anything\nfrom 1 to 32767, but note that setting count to large number will start long\nrunning feedback that you may not be able to stop.\n\n'frequency' is used only when emulating touchpad and describes how many pixels\nshould mouse travel between two feedback ticks.\n\n\n#### ball([friction=10.0, [mass=80.0, ]] action)\nEnables trackball mode. Moving finger over pad will keep repeating same action\nwith decreasing speed, based on set mass and friction, until virtual\n'spinning ball' stops moving.\n\n\n#### circular(action)\nDesigned to controls scroll wheel by scrolling finger around pad.\nCan be used with any axis. For example,\n\n`circular(axis(Axes.ABS_X))`\n\nturns touchpad into small raing wheel.\n\n\n#### circular(action)\nWorks as to `circular`, but instead of counting with finger movements,\ntranslates exact position on dpad to axis value.\n\n\n#### deadzone([mode,] lower, [upper, ] action)\nEnables deadzone on trigger, pad or stick.\nMode defaults to 'CUT' and can be one of:\n\n - CUT - if value is out of deadzone range, output value is zero\n - ROUND - for values bellow deadzone range, output value is zero. For values\nabove range, output value is maximum allowed.\n - LINEAR - input value is scaled, so entire output range is covered by\nrange of deadzone.\n - MINIMUM - any non-zero input value is scaled so entire input range is mapped\nto range of deadzone. Zero on input is mapped to zero on output, so there is\narea over which output \"jumps\" when stick is tilted.\n\n\n#### smooth([buffer=8, [multiplier=0.7, [filter=2, ]]] action)\nEnables input smoothing. Position is computed as weighed average of last X\ninput positions with highest weight given to most recent position. If 'filter'\nis above zero, movements bellow that value are ignored.\n\n\n#### osd([timeout=5], action)\nEnables on screen display for action. In most cases just displays action\ndescription in OSD and executes it normally.\nWorks only if executed by pressing physical button or with `dpad`. Otherwise\njust executes child action.\n\n\n#### position(x, y, action)\nSpecifies menu position on screen. X is position from left, Y from top. To\nspecify position from right or bottom, use negative values.\n\n\n#### name(name, action)\nAllow inline setting of action name\n\n\n# Shortcuts:\n#### raxis(id)\nShortcut for `axis(id, 32767, -32767)`, that is call to axis with min/max values\nreversed. Effectively inverted axis mapping.\n\n\n#### hatup(id)\nShortcut for `axis(id, 0, 32767)`, emulates moving hat up or pressing 'up'\nbutton on dpad.\n\n\n#### hatdown(id)\nShortcut for `axis(id, 0, -32767)`, emulates moving hat down or pressing 'down'\nbutton on dpad.\n\n\n#### hatleft(id), hatright(id)\nSame thing as hatup/hatdown, as vertical hat movement and left/right dpad\nbuttons are same events on another axis\n\n\n# Macros and operators\n\n#### and - executing actions at once\nIt is possible to join two (or more) actions with `and` keyword (or newline) to have them executed together.\n- `button(KEY_LEFTALT) and button(KEY_F4)` presses Alt+F4\n\n\n#### semicolon - sequence (macro)\nWhen `;` is placed between actions, they are executed as sequence.\n- `hatup(ABS_Y); hatup(ABS_Y); button(BTN_B); button(BTN_A)` presses 'UP UP B A' on gamepad, as fast as possible\n- `button(KEY_A); button(KEY_B); button(KEY_C)` types 'abc'.\n\n\n#### type('text')\nSpecial type of macro where keys to press are specified as string.\nBasically, writing `type(\"iddqd\")` is same thing as `button(KEY_I) ; button(KEY_D) ;\nbutton(KEY_D); button(KEY_Q); button(KEY_D)`, just much shorter.\n\n\n#### sleep(x)\nTo insert pause between macro actions, use sleep() action.\n- `button(KEY_A); button(KEY_B); sleep(1.0); button(KEY_C)` types 'ab', waits 1s and types 'c'\n\n\n#### repeat(action)\nTurbo / rapid fire mode. Repeats macro (or even single action) until physical button is released. Macro is always played to end, even if button is released before macro is finished.\n- `repeat(button(BTN_X))` deals with \"mash X to not die\" events in some games.\n\n\n#### cycle(action1, action2...)\nExecutes different action every time when button is pressed (action1 upon first press, action2 with second, etc.)\nWorks only on buttons.\n\n\n# Examples for profile file\nEmulate key presses based on stick position\n```\n\"stick\" : {\n\t\"X\"\t\t: { \"action\" : \"pad(KEY_A, KEY_D)\" },\n\t\"Y\"\t\t: { \"action\" : \"key(KEY_W, KEY_S)\" },\n```\n\n\nEmulate left/right stick movement with X and B buttons\n```\n\"buttons\" : {\n\t\"B\" : { \"action\" : \"axis(ABS_X, 0, 32767)\" },\n\t\"X\" : { \"action\" : \"axis(ABS_X, 0, -32767)\" },\n```\n\nEmulate dpad on left touchpad, but act only when dpad is pressed\n```\n\"left_pad\" : {\n\t\"action\" : \"click( dpad('hatup(ABS_HAT0Y)', 'hatdown(ABS_HAT0Y)', 'hatleft(ABS_HAT0X)', 'hatright(ABS_HAT0X)' ) )\"\n}\n```\n\nEmulate button A when left trigger is half-pressed and button B when\nit is pressed fully\n```\n\"triggers\" : {\n\t\"LEFT\" : { \"action\" : \"pad(BTN_A, BTN_B)\" },\n```\n"
},
{
"path": "docs/menu-file.md",
"content": "SC-Controller menu file specification\r\n----------------------------------------\r\n\r\nMenu file contains json-encoded list with menu items (actions), submenus,\nseparators and menu generators.\r\n\r\n### Menu Items\r\n\nEvery menu item is defined by action, in same way as action would be defined\r\n[in profile file](profile-file.md#Action_definition) with one additional\r\n`id` key. `id` specifies action ID and can be anything, but each menu item\r\nshould have unique ID.\r\n\r\n`name` key is still optional, but highly recommended as used as menu item title\r\ndisplayed on screen. If `name` is not specified, title is auto-generated.\r\n\r\nExample:\r\n\r\n\t[{\r\n\t \"id\": \"item1\", \r\n\t \"action\": \"profile('Desktop')\", \r\n\t \"name\": \"Switch to Desktop profile\", \r\n\t}, {\r\n\t \"id\": \"item2\", \r\n\t \"action\": \"turnoff()\", \r\n\t \"name\": \"Turn controller OFF\", \r\n\t}]\r\n\r\nspecifies menu with two items.\n\r\n### Submenus\r\n\r\nSubmenu is reference to another menu file (submenu cannot be defined in same\r\nfile or profile file). When selected, another menu is loaded and drawn over\r\noriginal menu.\r\nSubmenu is dict with `submenu` key, value of key is filename relative to\r\n`~/.config/scc/menus` or `/usr/share/scc/default_menus/`, whichever exists, in\r\nthat order.\r\n`name` key may be defined.\r\n\r\nExample:\r\n\r\n\t[{\r\n\t \"submenu\": \"profiles.menu\", \r\n\t \"name\": \"All Profiles\"\r\n\t}]\r\n\r\nspecifies menu with sumbmenu called \"All Profiles\" defined in *profiles.menu*\r\n\r\n### Separators\r\n\r\nSeparator is empty space that splits menu into two or more logical blocks.\r\nName, if set, is displayed in different way from menu items. Separator is\r\ndefined by dict with `separator` key set to True.\r\n\r\n### Menu Generators\r\n\r\nGenerator is something that generates menu items automatically. It is defined\r\nby dict with `generator` key, where value is type of generator to use.\r\n\r\nExample:\r\n\r\n\t[{\r\n\t \"generator\": \"profiles\"\r\n\t}, {\r\n\t \"id\": \"item2\", \r\n\t \"action\": \"turnoff()\", \r\n\t \"name\": \"Turn controller OFF\", \r\n\t}]\r\n\r\nspecifies menu with list of all profiles, followed by one normal menu item.\r\n\r\n\r\n### Available generators\r\n\r\n#### `profiles`\r\nGenerates menu item for each available profile. Selecting item will switch to\r\nrepresented profile.\r\n\r\n#### `recent`\r\nGenerates menu item for *X* recently selected profiles. *X* is 5 by default and\r\ncan be set with additional `rows` key.\r\n"
},
{
"path": "docs/profile-file.md",
"content": "SC-Controller profile file specification\n----------------------------------------\n\nProfile file contains json-encoded dictonary with specific keys. Missing keys are substituted with defaults, unknown keys are ignored. See [Desktop.sccprofile](../default_profiles/Desktop.sccprofile) for example.\n\nRoot dictonary has to contain following keys:\n- `buttons`\t\t\t- contains subkey for controller buttons. See [buttons](#buttons).\n- `pad_left`\t\t- sets action executed when finger is moved on left touchpad.\n- `pad_right`\t\t- ... when finger is moved on right touchpad.\n- `stick`\t\t\t- ... when stick angle is changed.\n- `trigger_left`\t- ... when left trigger value is changed.\n- `trigger_right`\t- ... when right trigger value is changed.\n- `gyro`\t\t\t- ... when gyroscope reading changes. Gyroscope in is activated only if this key is set to something else than `NoAction`\n- `menus`\t\t\t- stores menus saved in profile. See [menus](#menus).\n- `version`\t\t\t- profile file version. Current version is _1_. See If not pressent, _0_ is assumed. If profile file version is lower than expected, automatic conversion may happen. This conversion is in-memory only, but changing and saving such profile in GUI will save converted data.\n\nSee [actions.md](actions.md) file for list of possible actions.\n\n\n## Action definition\nAction definition is dictionary containing `action` key and optional `name` key. Value assigned to `action` describes action to be executed.\n\n`action` key can describe entire action, but for better readability, it is also possible to specify additional properties using [additional keys](#Additional_keys).\n\nFor example,\n\n\t{\n\t \"trigger_left\": {\n\t \"action\": \"axis(Axes.ABS_Z)\",\n\t \"name\": \"Aim\",\n\t}}\n\nassigns `axis` action with *Axes.ABS_Z* parameter to left trigger.\n\n## Additional keys in action definition\n\n#### `X` and `Y`\nTurns action into `XYAction`, allowing to specify different action for each pad\nor stick axis. If either of keys is specified, `action` key is ignored.\n\nExample:\n\n\t\"stick\" : {\n\t \"X\": { \"action\": \"axis(Axes.ABS_RX)\" },\n\t \"Y\": { \"action\": \"raxis(Axes.ABS_RY)\" }\n\t},\n\n\nis same as\n`\"stick\" : { \"action\" : \"XY(axis(Axes.ABS_RX), raxis(Axes.ABS_RY))\" }`\n\n\n#### `levels`\nTurns action into `TriggerAction`, allowing to specify lower and upper trigger\nlevels among which is action executed.\n\nExample:\n\n\t\"trigger_left\": {\n\t \"action\": \"button(BTN_LEFT)\", \n\t \"levels\": [127, 255]\n\t}, \n\nSets action that presses left mouse button, but only if trigger\nis roughly half-pressed.\n\n\n#### `dpad`\nTurns action into `DPadAction`, allowing to assign different action for each\nside of pad or stick alignment.\n\nExample:\n\n\t\"dpad\" : [\n\t { \"action\": \"button(Keys.KEY_UP)\" },\n\t { \"action\": \"button(Keys.KEY_DOWN)\" },\n\t { \"action\": \"button(Keys.KEY_LEFT)\" },\n\t { \"action\": \"button(Keys.KEY_RIGHT)\" }\n\t],\n\n\n#### `ring`\nDefines outer and inner ring bindings. Expects keys with 'inner' and 'outer'\nactions and 'radius' as float value, but all keys are optional.\n\nExample:\n\n\t\"pad_left\": {\n\t \"ring\": {\n\t \"inner\": { \"action\": \"XY(axis(Axes.ABS_X), raxis(Axes.ABS_Y))\" },\n\t \"outer\": { \"action\": \"XY(axis(Axes.ABS_RX), raxis(Axes.ABS_RY))\" }, \n\t \"radius\": 0.4\n\t }\n\t}, \n\ndefines inner ring binding controlling left stick and outer ring right stick\nof emulated gamepad.\n\n#### `tilt`\nTurns action into `TiltAction`, allowing to assign different action for tilting\ndpad. Works pretty-much as `dpad` on gyro.\n\nExample:\n\n\t\"tilt\" : [\n\t { \"action\": \"button(Keys.KEY_UP)\" },\n\t { \"action\": \"button(Keys.KEY_DOWN)\" },\n\t { \"action\": \"button(Keys.KEY_LEFT)\" },\n\t { \"action\": \"button(Keys.KEY_RIGHT)\" }\n\t],\n\n#### `deadzone`\nSpecifies deadzone. Allows for `lower` and `upper` subkeys defaulting to\n*0* and *32767* and `mode` subkey defaulting to 'CUT'.\nSee see [deadzone modifier](actions.md#deadzone) for list of modes.\n\nExample:\n\n\t\"trigger_left\": {\n\t\t\"mode\" : \"linear\",\n \t \"action\": \"axis(Axes.ABS_Z)\",\n \t \"deadzone\": {\n\t \"lower\": 100,\n\t \"upper\": 200\n \t}},\n\n\n#### `sensitivity`\nSpecifies input sensitivity. Value is list with one or two values for sensitivity\nover X and Y axis (or one value for sensitivity of trigger.)\nDefault sensitivity is 1.0\n\nExample:\n\n\t\"stick\" : {\n\t \"action\": \"trackball()\",\n\t \"sensitivity\": [2.0, 0.5]\n\t},\n\ndoubles sensitivity over X and halves over Y axis.\n\n\n#### `rotate`\nRotates input pad or stick input by given angle.\n\nExample:\n\n\t\"stick\" : {\n\t \"action\": \"trackball()\",\n\t \"rotate\": 15\n\t},\n\n\n\n#### `feedback`\nEnables haptic feedback for action. Value is list with one to three values\nspecifying feedback position (*'LEFT'*, *'RIGHT'* or *'BOTH'*),\namplitude and frequency.\n\nExample:\n\n\t\"pad_left\": {\n\t \"action\": \"trackball()\",\n\t \"feedback\": [\"LEFT\", 512.0, 5.0]\n\t},\n\nspecifies feedback with amplitude of 512 (default vlaue)\nand frequency of 5 generated by left motor.\n\n\n#### `smooth`\nEnables input smoothing (see [smooth modifier](actions.md#smooth))\n\nExample:\n\n\t\"pad_left\": {\n\t \"action\": \"trackball()\",\n\t \"smooth\": [ 8, 0.7, 2.0 ]\n\t},\n\nenables smoothing with buffer of 8 and modifier set to 0.7.\n\n\n#### `osd`\nIf set to True, enables OSD for action.\n\nExample:\n\n\t\"X\": {\n\t \"action\": \"button(Keys.BTN_EAST)\", \n\t \"osd\": true\n\t}, \n\nenables OSD feedback for X button.\n\n#### `click`\nIf set to True, enables 'click' modifier, making action executed only when\npad or stick is pressed.\n\nExample:\n\n\t\"pad_left\": {\n\t \"action\": \"mouse()\",\n\t \"click\": True\n\t},\n\n\n#### `ball`\nIf set to value, enables trackball mode. Value is list with zero to two values\nspecifying friction and mass of virtual 'spinning ball'.\nSee [ball modifier](actions.md#ball) for more info.\n\nExample:\n\n\t\"pad_left\": {\n\t \"action\": \"mouse()\",\n\t \"ball\": [ 10.0 ]\n\t},\n\n\n#### `circular`\nDesigned to controls scroll wheel by scrolling finger around pad, but can\nbe used with any axis.\n\nExample:\n\n\t\"pad_left\": {\n\t \"action\": \"mouse(Rels.REL_WHEEL)\",\n\t \"circular\": true\n\t},\n\n\n#### `circularabs`\nWorks as to `circular`, but instead of counting with finger movements,\ntranslates exact position on dpad to axis value.\n\nExample:\n\n\t\"pad_left\": {\n\t \"action\": \"circularabs(Rels.REL_WHEEL)\",\n\t \"circular\": true\n\t},\n\n\n#### `modes`\nDefines mode shifting (see [mode modifier](actions.md#mode)).\n\nValue is dict with physical key names (A, B, X, Y...) as keys and actions\nfor each mode as values. Action on same level as `mode` is used as default\naction.\n\nExample:\n\n\t\"modes\": {\n\t \"A\": { \"action\": \"mouse()\" },\n\t \"B\": { \"action\": \"XY( axis(Axes.ABS_X), raxis(Axes.ABS_Y) )\" }\n\t},\n\ndefines pad or stick that controls mouse while button A is pressed\nand left virtual stick while button B is pressed.\n\n\n#### `gestures`\nEnables gesture cognition on pad (see [gestures modifier](actions.md#gestures)).\n\nValue is dict with encoded gestures (see [description in actions.md](actions.md#gesture_format)) and actions\nfor each gesture as values.\n\nExample:\n\n\t\"gestures\": {\n\t \"UD\": { \"action\": \"button(Key.R)\" }\n\t},\n\nenables gesture recognition with single gesture activated when user does short stroke up followed by short stroke down.\n\n#### `doubleclick`\nDefines action that is executed when user double-clicks with button.\nOptional `time` key can be used on same level as `doubleclick` to modify\ndouble-click time.\n\nExample:\n\n\t\"buttons\": {\n\t \"A\": {\n\t \"action\": \"button(KEY_X)\",\n\t \"doubleclick\": { \"action\": \"button(KEY_Z)\" },\n\t\t\"time\": 5\n\t }\n\t}\n\ndefines button that emulates pressing X key when pressed normally and\npressing Z key when doubleclicked.\n\n\n#### `hold`\nDefines action that is executed when user holds button for short time.\nOptional `time` key can be used on same level as `hold` to modify\ndouble-click time.\n\nExample:\n\n\t\"buttons\": {\n\t \"A\": {\n\t \"action\": \"button(KEY_X)\",\n\t \"hold\": { \"action\": \"button(KEY_Z)\" },\n\t\t\"time\": 5\n\t }\n\t}\n\ndefines button that emulates pressing X key when pressed normally and\npressing Z key when held for 5 seconds.\n\n\n## Buttons\n`buttons` is dictionary with keys for each gamepad button.\nPossible keys are:\n\n- `X`, `Y`, `A` and `B` for colored buttons\n- `C` for Steam button in center\n- `SELECT` and `START` for small \"( < )\" and \"( > )\" buttons\n- `LB` and `RB` for left and right bumper\n- `LPAD`, `RPAD` and `STICK` for presing pads or stick.\n\nAll keys are optional. Value for each key is [action definition](#Action_definition)\n\nExample:\n\n\t\"buttons\": {\n\t \"A\": { \"action\": \"button(Keys.BTN_WEST)\", }, \n\t \"B\": { \"action\": \"osd('Hello world!')\" }, \n\t \"BACK\": { \"action\": \"button(Keys.KEY_LEFTCTRL) and button(Keys.KEY_A)\" }, \n\t}\n\n\n## Menus\n`menus` is dictionary with menus stored along with profile. Keys are IDs of\nmenus; Menu ID can contain any characters but dots (\".\") and slashes (\"/\").\n\nValue for each key is same as root list in [menu file](menu-file.md)\n"
},
{
"path": "docs/protocol.md",
"content": "SCCDaemon Protocol specification\n--------------------------------\n\nTo control running daemon instance, unix socket in user directory is used.\nControlling protocol uses case-sensitive messages terminated by newline. Message type and message arguments are delimited by `:`.\n\nWhen new connection is accepted, daemon sends some info:\n\n```\nSCCDaemon\nVersion: 0.2.6\nPID: 123456\nCurrent profile: filename.sccprofile\nReady.\n```\n\nConnection is then held until client side closes it.\n\n### Messages sent by daemon:\n\n#### `Controller Count: n`\nInforms about total number of connected controllers.\nAlways sent after `Controller:` messages\n\n#### `Controller: controller_id type flags config_file`\nProvides info about controller 'n'.\n- `controller_id` is unique string identifier of controller (should stay same at\nleast until daemon exits) and doesn't contains spaces.\n- `type` is string identifier (without spaces) of driver.\n- `flags` describes controller features, such as having central touchpad.\nSee ControllerFlags definition in scc/constants.py for more info.\n- `config_file` is None or file name of json-encoded file that can GUI use\nto get additional data about controller (background image, button images, etc)\nFile name may be absolute path or just name of file in /usr/share/scc\n\nThis message is repeated for every connected controller and followed by\n`Controller Count:` message. It is automatically sent to every client when\nnumber of connected controllers changes. It is also sent automatically to\nevery new client.\n\n#### `Controller profile: controller_id filename.sccprofile`\nSent to every client when profile file for any controller is loaded and used.\nAlso sent automatically to every new client.\n\n#### `Current profile: filename.sccprofile`\nSimilar to `Controller profile:`, sent to every client when profile file for\nfirst controller is loaded and used. Also sent automatically to every new client.\n\nUnlike `Controller profile:`, this message is sent even if there is no\ncontroller connected.\n\n#### `Event: source values`\nSent to client that requested locking of source (that is button, pad or axis).\n\nList of possible events:\n- `Event: B 1` - Sent when button is pressed. *B* is button, is one of *SCButtons.\\** constants.\n- `Event: B 0` - Sent when button is released. *B* is button one of *SCButtons.\\** constants.\n- `Event: STICK x y` - Sent when stick position is changed. *x* and *y* are new values.\n- `Event: LEFT x y` - Sent when finger on left pad is moved. *x* and *y* is new position.\n- `Event: RIGHT x y` - Sent when finger on right pad is moved. *x* and *y* is new position.\n\n#### `Error: message`\nSent to every client when error is detected. May be sent repeatedly to indicate\nmultiple errors.\n\nAfter all error conditions are cleared, `Ready.` is sent to indicate that emulation works again.\n\n#### `Fail: text`\nIndicates error as response to client's request.\n\n#### `Gesture: side gesturestring`\nSent to client that requested gesture to be detected.\n\n#### `OK.`\nIndicates sucess as response to client's request.\n\n### `OSD: tool param1 param2...`\nSend to scc-osd-daemon when osd-related action is requested.\n*tool* can be *'message'*, *'menu'*, *'hmenu'*, *'gridmenu'*,*'radialmenu'* or *'gesture'*\n*params* are same as command-line arguments for scc-osd-* script with that name.\n\n#### `PID: xyz`\nReports PID of *scc-daemon* instance. Automatically sent when connection is accepted.\n\n#### `Ready.`\nAutomatically sent when connection is accepted to indicate that there is no error and daemon is working as expected.\n\n#### `Reconfigured.`\nSent to all clients when daemon receives `Reconfigure.` message.\n\n#### `SCCDaemon`\nJust identification message, automatically sent when connection is accepted.\nCan be either ignored or used to check if remote side really is *scc-daemon*.\n\n#### `State: ....`\nSent to client as response to `State.` message. String after colon describes\ncurrent state of controller (such as pressed buttons and stick position...)\nand is device-specific.\n\n#### `Version: x.y.z`\nIdentifies daemon version. Automatically sent when connection is accepted.\n\n## Commands sent from client\n\n#### `Controller: controller_id`\nBy default, all messages sent from client are related to first connected\ncontroller. This message changes which controller are following messages meant\nfor.\n\nIf controller with specified controller_id is known, daemon responds with `OK.`\nOtherwise, `Fail: no such controller` error message is sent.\n\n#### `Controller.`\nRestores default state after controller is chosen.\nDaemon responds with `OK.`\n\n#### `Gesture: side up_angle`\nRequests gesture to be detected on one of pads. 'side' can be LEFT or RIGHT.\n'up_angle' is angle in radians and sets how much should be gesture input\nrotated.\n\nDaemon always responds with `OK.` unless request cannot be parsed.\nThen, when gesture detection is completed, daemon sends\n`Gesture: side detectedgesture` message. If gesture detection fails for any\nreason, sent gesture is empty.\n\n#### `Led: brightness`\nSets brightness of controller led. 'Brightness' is percent in 0 to 100 range.\nDaemon responds with `OK.`, unless 'brightness' cannot be parsed, in which case\n`Fail: ...` with error message is sent.\n\n#### `Lock: button1 button2...`\nLocks physical button, axis or pad. Events from locked sources are not processed normally, but sent to client that initiated lock.\n\nOnly one client can have one source locked at one time. Second attempt to lock already locked source will fail and `Fail: cannot lock