Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/The-Young-Maker/OpenMenuOS/llms.txt

Use this file to discover all available pages before exploring further.

OpenMenuOS is distributed through the Arduino Library Manager and as a ZIP archive on GitHub. Both methods work with Arduino IDE 1.8.x and 2.x. Choose the approach that fits your workflow below.

​
Prerequisites

Before installing OpenMenuOS, install its only dependency:
LibraryMinimum versionWhere to find it
TFT_eSPI2.5.0Arduino Library Manager — search “TFT_eSPI” by Bodmer
TFT_eSPI also requires you to configure User_Setup.h (or select a setup file) for your specific display and board before uploading any sketch.

​
Installation methods

The Library Manager is the recommended method. It installs the library and keeps it updated automatically.
1

Open the Library Manager

In Arduino IDE, go to Tools → Manage Libraries… (IDE 1.8.x) or click the library icon in the left sidebar (IDE 2.x).
2

Search for OpenMenuOS

Type OpenMenuOS in the search box. The result should show the library by Loic Daigle.
3

Install the library

Select version 3.1.0 (or the latest available) from the version dropdown, then click Install. Accept any prompts to install dependencies.
4

Verify the installation

Navigate to File → Examples → OpenMenuOS → OpenMenuOS_Simple to confirm the library is available and the example loads without errors.

​
Arduino IDE compatibility

IDE versionStatus
Arduino IDE 1.8.xFully supported
Arduino IDE 2.xFully supported (includes IntelliSense/auto-complete)

​
Library structure

After installation, the library lives in your Arduino libraries/ folder with the following layout: 
OpenMenuOS/
├── src/
│   ├── OpenMenuOS.h        # Main header — the only file you need to include
│   └── OpenMenuOS.cpp      # Implementation
├── examples/
│   └── OpenMenuOS_Simple/  # Complete working example sketch
├── docs/                   # Detailed API and examples reference
├── library.properties      # Arduino metadata (name, version, dependencies)
└── README.MD               # Full changelog and API reference
Your sketch only needs one include: 
#include "OpenMenuOS.h"

​
Next step

With OpenMenuOS installed, follow the Quickstart to wire up your display and run your first menu.

Build docs developers (and LLMs) love

Get started for freeTalk to us