https://github.com/pgaskin/NickelMenu

The easiest way to launch scripts, change settings, and run actions on Kobo e-readers.
https://github.com/pgaskin/NickelMenu

kobo launcher menu qt

Last synced: 12 days ago
JSON representation

The easiest way to launch scripts, change settings, and run actions on Kobo e-readers.

• Host: GitHub
• URL: https://github.com/pgaskin/NickelMenu
• Owner: pgaskin
• License: mit
• Created: 2020-04-22T04:12:36.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-21T18:39:03.000Z (6 months ago)
• Last Synced: 2024-03-06T19:35:15.355Z (4 months ago)
• Topics: kobo, launcher, menu, qt
• Language: C++
• Homepage: https://pgaskin.net/NickelMenu
• Size: 2.78 MB
• Stars: 446
• Watchers: 16
• Forks: 23
• Open Issues: 40
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Lists

• awesome-stars - NickelMenu - readers. | pgaskin | 281 | (C++)
• awesome-kobo - NickelMenu - Adds a new menu to Kobo's native app. Used by many apps to provide UI controls (Kobo Apps)

README

        
NickelMenu


The easiest way to launch custom scripts, change hidden settings, and run actions on Kobo eReaders.

See the [website](https://pgaskin.net/NickelMenu) and [thread on MobileRead](https://mobileread.com/forums/showthread.php?t=329525) for screenshots and more details.

## Installation

You can download pre-built packages of the latest stable release from the [releases](https://github.com/pgaskin/NickelMenu/releases) page, or you can find bleeding-edge builds of each commit from [here](https://github.com/pgaskin/NickelMenu/actions).

After you download the package, copy `KoboRoot.tgz` into the `.kobo` folder of your eReader, then eject it.

After it installs, you will find a new menu item named `NickelMenu` with further instructions which you can also read [here](./res/doc).

To uninstall NickelMenu, just create a new file named `uninstall` in `.adds/nm/`, or trigger the failsafe mechanism by immediately powering off the Kobo after it starts booting.

Most errors, if any, will be displayed as a menu item in the main menu. If no new menu entries appear here after a reboot, try reinstalling NickelMenu. If that still doesn't work, connect over telnet or SSH and check the output of `logread`.

## Compiling

NickelMenu is designed to be compiled with [NickelTC](https://github.com/pgaskin/NickelTC). To compile it with Docker/Podman, use `docker run --volume="$PWD:$PWD" --user="$(id --user):$(id --group)" --workdir="$PWD" --env=HOME --entrypoint=make --rm -it ghcr.io/pgaskin/nickeltc:1.0 all koboroot`. To compile it on the host, use `make CROSS_COMPILE=/path/to/nickeltc/bin/arm-nickel-linux-gnueabihf-`.