asusctl

(β˜… 537)

Daemon and tools to control your ASUS ROG laptop. Supersedes rog-core.

  • .editorconfig
  • .gitignore
  • book.toml
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • clippy.toml
  • CONTRIBUTING.md
  • Cranky.toml
  • deny.toml
  • design-patterns.md
  • GPU_MODE_SWITCHING_SUMMARY.md
  • LICENSE
  • Makefile
  • MANUAL.md
  • PACKAGING.md
  • README.md
  • rust-toolchain.toml
  • rustfmt.toml

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/OpenGamingCollective/asusctl

Downloads the entire project code from GitHub to your computer.

cd asusctl

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
sudo apt install libclang-dev libudev-dev libfontconfig-dev build-essential cmake libxkbcommon-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

sudo apt install make cargo gcc pkg-config openssl libasound2-dev cmake build-essential python3 libfreetype6-dev libexpat1-dev libxcb-composite0-dev libssl-dev libx11-dev libfontconfig1-dev curl libclang-dev libudev-dev checkinstall libseat-dev libinput-dev libxkbcommon-dev libgbm-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
sudo dnf install git make cmake clang-devel libxkbcommon-devel systemd-devel expat-devel pcre2-devel libzstd-devel gtk3-devel rust cargo

Type this command into your terminal and run it.

sudo apt install make cargo gcc pkg-config openssl libasound2-dev cmake build-essential python3 libfreetype6-dev libexpat1-dev libxcb-composite0-dev libssl-dev libx11-dev libfontconfig1-dev curl libclang-dev libudev-dev checkinstall libseat-dev libinput-dev libxkbcommon-dev libgbm-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

cargo build --package rog_simulators

Compiles the Rust project.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation