Table of contents

  1. Table of contents
  2. Introduction
  3. Compiling your firmware with userspace
    1. Requirements
    2. Adding the submodule to your userspace
  4. Themes

Introduction

The Dilemma V3 and Dilemma MAX V3 can accommodate an LCD module. It has default behavior, like showing the layer, mods, scrolling DPI and sniping toggles.

It requires custom code, that is stored in a module.

Compiling your firmware with userspace

This is the recommended way of adding the screen code. At this moment, using a local QMK installation is not documented.

Requirements

Make sure you have your local qmk userspace set up to work with the Dilemma V3 / Dilemma MAX V3.

Adding the submodule to your userspace

Make a copy of the module into your userspace:

cd /path/to/your/external/userspace
mkdir -p modules
git submodule add https://github.com/Bastardkb/qmk_modules.git modules/bastardkb
git submodule update --init --recursive

Add the following to your keymap.json. You may need to merge it with your existing json.

{
    "modules": [
        "bastardkb/lcd"
    ]
}

Themes

The LCD screen supports multiple themes.

The module comes with a custom keycode to change the theme: LCD_THEME. Triggering it will change the theme, and store the current theme in memory.