Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 4.56 KB

README.md

File metadata and controls

101 lines (65 loc) · 4.56 KB
Raw

AlienFX is a Linux utility to control the lighting effects of your Alienware computer.

At present there is a CLI version (alienfx) and a gtk GUI version (alienfx-gtk). And has been tested on Debian/Ubuntu/Kali/Mint, Fedora and Arch Linux.

Version GitHub license Python3 GitHub issues GitHub stars GitHub forks

PRs Welcome Contributers needed! Please read CONTRIBUTING.md for further details.

AlienFX

Table of Contents

Dependencies

AlienFX is written in python and has been tested on python 3.12. It requires the following python packages to run:

On Arch Linux:

      $ sudo pacman -S python-pyusb python-setuptools python-gobject python-cairo python-future

On Debian/Ubuntu/Mint/Kali:

      $ sudo apt install libcairo2-dev python3-gi python3-gi-cairo python3-setuptools python3-usb python3-future

On Fedora:

      $ sudo dnf install cairo-devel python3-gobject cairo-gobject python3-setuptools python3-pyusb python3-future

Installation

On Arch Linux you can install package from AUR: alienfx

For manual installation of AlienFX, use the following commands:

    $ sudo python setup.py install
    $ sudo python setup.py install_data

Note that the second invocation is required to ensure that icon files etc. are properly installed.

The installation includes a udev rules file that allows AlienFX to access the AlienFX USB controller on your computer without needing root permissions. If you run the install commands without sudo, then the udev rules file will not be installed.

Usage

Lighting configurations are stored in "theme files", which are simple json files stored in $XDG_CONFIG_HOME/alienfx. If XDG_CONFIG_HOME is not set, then ~/.config/alienfx is used. Both the CLI and GUI programs use these theme files, and the GUI program allows you to create new themes as well.

See the man page of alienfx $ man alienfx for the cli options supported.

If you run the CLI-version of alienfx on a currently unsupported device, the program will ask you if you wish to perform a zonescan. Please consider using this feature to determine the correct zone-codes for your device. If you found the correct codes, please contribute to the project. - You'll find more information in Section Contributing

Supported models and adding support for new models:

Please have a look at devicelist

Contributing

Please read CONTRIBUTING.md for further details.

Further Informatin

If you're looking for further information, have a look in docs/Knowledgebase

Disclaimer and License

If you use this software, you use it AT YOUR OWN RISK. I and the contributing developers DO NOT accept responsibility for frying your AlienFX controller chip with this code. Haven't fried any yet, but this is just so we can sleep at night. ;)

This software is licenced under the GPLv3

This is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU GPL for more detail.