DOCSEARCHbyAlgolia
Submit Docs

NickelMenu Documentation

repository·master·Indexed 19 days ago

https://github.com/pgaskin/nickelmenu

A tool for Kobo eReaders that enables users to launch custom scripts, modify hidden settings, and execute specific actions via a custom menu interface. Includes instructions for installation, uninstallation, troubleshooting, and compilation using NickelTC.

Tokens
465
Snippets
3
Records
4
Agent score
28%

What's inside NickelMenu

  1. Uninstall NickelMenu

    master

    You can uninstall NickelMenu using one of two methods:

    1. File method: Create a new empty file named uninstall in the .adds/nm/ directory on your eReader.
    2. Failsafe method: Immediately power off the Kobo device right after it starts the booting process.

  2. Compile NickelMenu using NickelTC

    master

    NickelMenu is designed to be compiled with NickelTC.

    Using Docker or Podman

    Run the following command to compile using the official NickelTC container:

    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

    Compiling on the host

    If you have NickelTC installed locally, use make and specify the CROSS_COMPILE path:

    make CROSS_COMPILE=/path/to/nickeltc/bin/arm-nickel-linux-gnueabihf-
    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

  3. Install NickelMenu on a Kobo eReader

    master

    To install NickelMenu, download a pre-built package from the releases page or a bleeding-edge build from GitHub Actions.

    1. Download the package.
    2. Copy the KoboRoot.tgz file into the .kobo folder of your eReader.
    3. Eject the eReader safely.

    Once installed, a new menu item named NickelMenu will appear in the main menu.

    Note: Firmware 5.x is not currently supported.

    cp KoboRoot.tgz /path/to/your/kobo/.kobo/

  4. Troubleshoot NickelMenu installation

    master

    If NickelMenu does not appear in the main menu after a reboot:

    1. Try reinstalling NickelMenu.
    2. If the issue persists, connect to the device via telnet or SSH and check the system logs using the logread command to identify errors.
    logread