Skip to content

Initial release

Pre-release
Pre-release
Compare
Choose a tag to compare
@Eeems Eeems released this 30 Aug 23:49
· 359 commits to master since this release
3ae3188

Screenshots

Features

  • Configuration files are easy to port from draft.
  • Hold right button to create screenshot.
  • Hold left button to exit running application if term is configured.
  • Automatic sleep.
  • Grid view to launch applications.
  • Configurable grid.
    • Number of columns.
    • Font size.
  • Displays battery level.
  • Button long presses are captured and not passed to the running application.

Installation

  1. Copy oxide.tar.xz to your remarkable
  2. Decompress files into one of the following locations
    a. Root filesystem: /
    b. Entware: /opt
  3. If you haven't installed to the root filesystem, copy the oxide.service file to /etc/systemd/system
  4. Edit oxide.service to point it at the correct location of oxide
  5. Reload systemd unit files: systemctl daemon-reload
  6. Disable xochitl: systemctl disable --now xochitl
  7. Enable and start oxide systemctl enable --now oxide

Configuration

Configuration files can be in one of the following locations:

  1. /etc/draft
  2. /opt/etc/draft
  3. /home/root/.config/draft

The configuration folder contains the following:

  • icons/ Folder containing .png files that are used by applications.
  • conf Application configuration file. The launcher will automatically maintain this file.
  • Any other file will be used to define an application.

Oxide will search through all three locations when building a list of applications. So be careful not to duplicate files between all the locations as they will show up multiple times in the applications list in oxide.

Configuration files for an application use the following format:

name=xochitl
desc=The standard environment for reMarkable.
imgFile=xochitl
call=/usr/bin/xochitl
term=killall xochitl

Options:

  • name: Name of the application
  • desc: Description of the application, will show on long press.
  • imgFile: Name of the icon to use.
  • call: Command to run when launching the application
  • term: Command to run when button-capture is used to kill the application

Since this format is based off of the configuration format used by the draft launcher, you can leave entries blank by either omitting them from the file, or setting them to :, or leaving them blank.

Usage

oxide

After you have configured and launched oxide you can access the power menu from the image button on the top right of the screen. This will allow you to put the device to sleep, or to power off the device.
The image button on the top left side of the screen will open up the tools menu. This allows you to either refresh the grid, or to open up the options dialog.

The options dialog will allow you to configure various settings in the application. You have the option to reload the settings from the conf file on disk, or to close the options dialog and save the current settings to disk.

button-capture

Press and hold the left button for 1 second or longer to execute the contents of /tmp/.terminate. Oxide will automatically populate this file when launching an application with the term setting.

Press and hold the right button for 1 second or longer to create a screenshot at /tmp/fb.png. It will then execute /tmp/.screenshot if it exists. Due to how the reMarkable preserves colour information in the framebuffer used to generate the screenshot, there may be colour in the screenshots that are not visible on the reMarkable itself.