From 7328ebdda3d312edbafac94be4369342396fa5d7 Mon Sep 17 00:00:00 2001 From: "Luke D. Jones" Date: Mon, 3 Jul 2023 15:51:26 +1200 Subject: [PATCH] gex: cleanup and rename --- desktop-extensions/gnome/README.md | 121 ++---------------- desktop-extensions/gnome/package-lock.json | 4 +- desktop-extensions/gnome/package.json | 6 +- ...e.shell.extensions.asusctl-gex.gschema.xml | 2 +- desktop-extensions/gnome/src/metadata.json | 10 +- 5 files changed, 23 insertions(+), 120 deletions(-) diff --git a/desktop-extensions/gnome/README.md b/desktop-extensions/gnome/README.md index 6d8687ca..b565c743 100644 --- a/desktop-extensions/gnome/README.md +++ b/desktop-extensions/gnome/README.md @@ -1,118 +1,21 @@ -# asusctl ([-gex]: Gnome extension) -inactive(until v5.0.0)- +# asusctl -## inactive (kind of - update) +Requires `asusd` to be installed and running. -~~This project is currently inactive until a new maintainer wants to put some love into it and make it compatible with the newest asusctl versions.~~ +## build and install -ROG Control Center will also have it's own appindicator. - -This extension is currently marked as inactive also on extensions.gnome.org and for users not visible anymore. - -*UPDATE:* - -The origin maintainer (ZaPpPeL) is back from his rabbit-hole! (I'll take care of getting this into a working-state again within the next weeks - stay tuned!) - ---- - -Extension for visualizing [asusctl](https://gitlab.com/asus-linux/asusctl)(`asusd`) settings and status. - -*hint:* supergfxctl GPU mode switching moved to another extension to make it platform independent: [supergfxctl-gex](https://gitlab.com/asus-linux/supergfxctl-gex)(`supergfxctl-gex`) - ---- - -## Table of contents - -[[_TOC_]] - ---- - -## Extension Features - -* Notifications: - * Battery Charge Limit -* Popup Menu with options to: - * if supported by laptop model: - * change the battery charging limit - * change AniMe Matrix brightness - * enable / disable AniMe Matrix -* Extension Settings: - * Enable / disable notifications - * Enable debug message logging - -### Waiting for implementation: - -* Configuration interface (prefs) - * bind ROG-Button to open prefs (if not `rog-control-center` is used) - * create canvas based fan-curve editing - ---- - -## Icons/Screenshots - -_The screenshots below are just examples and might not represent the current used icons._ - -### Screenshot - -![screenshot.png](https://gitlab.com/asus-linux/asusctl-gex/-/raw/main/screenshots/screenshot.png) - -**battery charge limit notification:** - -![notification.png](https://gitlab.com/asus-linux/asusctl-gex/-/raw/main/screenshots/notification.png) - ---- - -## Requirements - -* gnome >= 3.36.0 -* [asusctl](https://gitlab.com/asus-linux/asusctl) >= 4.0 - ---- - -## Build Instructions - -### Dependencies - -* nodejs >= 14.0.0 -* npm >= 6.14.0 - -### Building (production) - -In a terminal enter the following commands as a user (**do NOT run as root or sudo**): - -```bash -git clone https://gitlab.com/asus-linux/asusctl-gex.git /tmp/asusctl-gex && cd /tmp/asusctl-gex +``` npm install -npm run build && npm run install-user +npm run build && gnome-extensions install asusctl-gnome@asus-linux.org.zip --force +npm run build && gnome-extensions enable asusctl-gnome@asus-linux.org.zip ``` -_HINT: You will need to reload the GNOME Shell afterwards. (`Alt + F2` -> `r` on X11, `logout` on Wayland)_ +You will need to restart Gnome after installing or updating -### Building (development) +## development -Instead of the -`npm run build && npm run install-user` -above, use this line instead: -`npm run build && npm run install-dev` - -This will remove any production versions and installs the development version instead. - -_HINT: You will need to reload the GNOME Shell afterwards. (`Alt + F2` -> `r` on X11, `logout` on Wayland)_ and probably manually enable the extension again. - -### Source debugging - -`cd` into the directory where you've downloaded the `asusctl-gex` source code and enter the following commands: - -```bash -npm install -npm run debug ``` - ---- - -## License & Trademarks - -**License:** Mozilla Public License Version 2.0 (MPL-2) - -**Trademarks:** ASUS and ROG Trademark is either a US registered trademark or trademark of ASUSTeK Computer Inc. in the United States and/or other countries. -Reference to any ASUS products, services, processes, or other information and/or use of ASUS Trademarks does not constitute or imply endorsement, sponsorship, or recommendation thereof by ASUS. -The use of ROG and ASUS trademarks within this website and associated tools and libraries is only to provide a recognisable identifier to users to enable them to associate that these tools will work with ASUS ROG laptops. +npm run build +gnome-extensions install asusctl-gnome@asus-linux.org.zip --force +MUTTER_DEBUG_DUMMY_MODE_SPECS=1366x768 dbus-run-session -- gnome-shell --nested --wayland +``` \ No newline at end of file diff --git a/desktop-extensions/gnome/package-lock.json b/desktop-extensions/gnome/package-lock.json index 7c32480e..0e125e6b 100644 --- a/desktop-extensions/gnome/package-lock.json +++ b/desktop-extensions/gnome/package-lock.json @@ -1,11 +1,11 @@ { - "name": "asusctl-gex", + "name": "asusctl-gnome", "version": "4.7.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "asusctl-gex", + "name": "asusctl-gnome", "version": "4.7.0", "license": "MPL-2", "devDependencies": { diff --git a/desktop-extensions/gnome/package.json b/desktop-extensions/gnome/package.json index 1d055fae..cdb76f60 100644 --- a/desktop-extensions/gnome/package.json +++ b/desktop-extensions/gnome/package.json @@ -1,7 +1,7 @@ { - "name": "asusctl-gex", + "name": "asusctl-gnome", "version": "4.7.0", - "description": "asusctl-gex is a frontend for some functionalities of asusctl and supergfxctl that were born inside the asus-linux.org community.\n\nasusctl is required.\n\nTo learn more about it, please have a look at:\nhttps://gitlab.com/asus-linux/asusctl\nhttps://gitlab.com/asus-linux/asusctl-gex\n\nhttps://asus-linux.org/", + "description": "asusctl-gnome a gnome extension exposing some of the base features of asusd in a helpful and easy to use way", "main": "dist/extension.js", "scripts": { "clear": "rm -rf dist", @@ -19,7 +19,7 @@ }, "repository": { "type": "git", - "url": "git+ssh://git@gitlab.com/asus-linux/asusctl-gex.git" + "url": "git+ssh://git@gitlab.com/asus-linux/asusctl.git" }, "keywords": [ "gnome-shell", diff --git a/desktop-extensions/gnome/schemas/org.gnome.shell.extensions.asusctl-gex.gschema.xml b/desktop-extensions/gnome/schemas/org.gnome.shell.extensions.asusctl-gex.gschema.xml index e35ed352..002253a2 100644 --- a/desktop-extensions/gnome/schemas/org.gnome.shell.extensions.asusctl-gex.gschema.xml +++ b/desktop-extensions/gnome/schemas/org.gnome.shell.extensions.asusctl-gex.gschema.xml @@ -1,6 +1,6 @@ - + false diff --git a/desktop-extensions/gnome/src/metadata.json b/desktop-extensions/gnome/src/metadata.json index c6635294..cd4d37e6 100644 --- a/desktop-extensions/gnome/src/metadata.json +++ b/desktop-extensions/gnome/src/metadata.json @@ -1,9 +1,9 @@ { - "name": "asusctl-gex", - "description": "asusctl-gex is a frontend for some functionalities of asusctl and supergfxctl that were born inside the asus-linux.org community.\n\nasusctl is required.\n\nTo learn more about it, please have a look at:\nhttps://gitlab.com/asus-linux/asusctl\nhttps://gitlab.com/asus-linux/asusctl-gex\n\nhttps://asus-linux.org/", - "uuid": "asusctl-gex@asus-linux.org", - "uuid-dev": "asusctl-gex-dev@asus-linux.org", - "settings-schema": "org.gnome.shell.extensions.asusctl-gex", + "name": "asusctl-gnome", + "description": "asusctl-gnome a gnome extension exposing some of the base features of asusd in a helpful and easy to use way", + "uuid": "asusctl-gnome@asus-linux.org", + "uuid-dev": "asusctl-gnome-dev@asus-linux.org", + "settings-schema": "org.gnome.shell.extensions.asusctl-gnome", "version": "4.3.2", "shell-version": [ "43", "44"