FrSky ETHOS Lua Script Installation Guide

This guide explains the basics of FrSky ETHOS Lua script installation, including what Lua scripts are, why GitHub is commonly used, how script packages are typically structured, and how to avoid the most common installation mistakes.

What This Guide Covers
• What GitHub is and why ETHOS projects use it
• What Lua scripts are in ETHOS
• Typical ETHOS Lua installation workflow
• Common SD card folder layout examples
• ZIP extraction and file placement basics
• Common mistakes that cause scripts to not appear
New to ETHOS Lua scripts?
Start with this page first. Other ETHOS setup guides in the Knowledge Base assume you understand the basic concepts explained here.

Beginner Guide: GitHub, Lua Scripts, and ETHOS Add-Ons

Many ETHOS tools, extensions, and utilities are distributed through GitHub. If you are new to open-source projects or radio scripting, this section explains how these pieces fit together.

What Is GitHub?

GitHub is an online platform where developers store and share software projects. It is commonly used by open-source communities to distribute firmware updates, utilities, documentation, examples, and bug fixes.

FrSky and many community developers use GitHub for ETHOS-related resources such as:

  • ETHOS-related Lua tools and utilities
  • project downloads and release packages
  • documentation and install notes
  • bug tracking and user feedback

Example repository:

https://github.com/FrSkyRC/ETHOS-Feedback-Community

When you download files from GitHub, they are often packaged as a ZIP archive. That ZIP file usually needs to be extracted first before copying files to the radio.


What Is a Lua Script?

A Lua script is a small program written in the Lua language that runs on the radio. Lua scripts allow developers to add features to ETHOS without changing the main radio firmware itself.

Simple way to think about it:
ETHOS = the radio operating system
Lua scripts = small apps or plugins that add features

Lua scripts can be used for:

  • radio tools and utilities
  • telemetry widgets
  • receiver programming tools
  • multiprotocol module support
  • special project-specific functions

Typical ETHOS Lua Installation Workflow

Most ETHOS Lua scripts follow a similar installation process. The exact file paths may vary by project, but the overall workflow is usually the same.

Typical Installation Process

1. Download the Lua script package from GitHub or the project website.
2. Extract the ZIP archive on your computer.
3. Connect the radio to your computer using a USB cable.
4. Select ETHOS Suite when the radio prompts for USB mode.
5. Copy the extracted files to the correct location on the radio SD card.
6. Safely eject the radio from the computer.
7. Reboot the radio so ETHOS can load the new files.
8. Verify the script appears in the correct ETHOS menu area.
Important:
Most Lua downloads are ZIP files. The ZIP must usually be extracted first so the actual folders and Lua files can be copied to the radio.

If a Lua script does not appear on the radio after installation, the most common causes are an incorrect folder path, a ZIP file that was not extracted, or an extra nested folder created during extraction.


ETHOS Lua Script Folder Layout

Lua scripts are typically stored somewhere inside the radio’s SD card /scripts directory. Each project usually creates its own folder that contains the Lua files required for that tool or widget.

Below is a simplified example of how Lua scripts may appear on the SD card:

SD Card
└── scripts
    ├── multi
    │    └── main.lua
    ├── dsm-tools
    │    ├── main.lua
    │    ├── images
    │    └── sounds
    └── example-script
        └── main.lua
Key idea:
Each Lua project normally has its own folder inside /scripts, and that folder often contains a main.lua file that ETHOS loads.
Common mistake:
Users sometimes accidentally create an extra folder level during extraction, like this:

/scripts/example-script/example-script/main.lua

If that happens, ETHOS usually will not detect the script.

Common Types of ETHOS Lua Scripts

Not every ETHOS Lua project behaves the same way. The most common types users run into are:

  • Tools — launched from the system or tools area
  • Widgets — placed on telemetry or display screens
  • Project-specific script packages — used for features such as multiprotocol support, telemetry systems, or receiver programming
Important:
There is no single folder rule that applies to every ETHOS Lua project. Many use the standard /scripts folder structure, but some projects still require their own exact layout. Always follow the instructions included with the specific project.

Step 1 — Connect the Radio by USB

Power on the radio and connect it to your computer using a USB cable.

When the radio prompts for USB mode, choose:

ETHOS Suite

This allows the radio to mount as USB storage drives so you can access the SD card and copy files.

Typical result:
Your computer will show the radio as USB drives, including the SD card.

Step 2 — Extract the ZIP File First

Most ETHOS Lua downloads are distributed as ZIP archives. A ZIP file is a compressed package, not the final installed folder structure.

Do not just drag the ZIP file into the SD card and assume it will work.

In most cases, the ZIP file must be extracted on your computer first so the actual folders and Lua files can be copied to the radio.

If you only see a ZIP file sitting inside the radio’s scripts folder, the install was usually done wrong.


Step 3 — Copy the Extracted Files to the Correct Location

For many ETHOS Lua projects, the base SD card location is:

/scripts

A typical script package might end up looking like:

/scripts/example-script/main.lua

Some projects also include images, sounds, maps, or additional subfolders. Those should usually remain exactly where the package puts them.

Do not reorganize the package yourself.
If the script author included a folder structure, keep it intact unless the project instructions clearly tell you otherwise.

How to Verify the Script Installed Correctly

The exact verification method depends on what type of script you installed.

If It Is a Tool

Press the SYS button and look for the script in the available tools or system pages.

If It Is a Widget

Go to the telemetry or display screen setup area and look for the widget in the list of available widgets.

If It Is a Project-Specific Script

Check wherever that project is supposed to appear. Some add model configuration options, some add tools, and some add screen widgets.

Simple rule:
If the script does not appear where the project says it should appear, the folder path or extracted file layout is usually wrong.

Common ETHOS Lua Installation Mistakes

  • Copying the ZIP file directly to the SD card instead of extracting it first
  • Putting the script in the wrong folder
  • Creating an extra nested folder during extraction
  • Renaming files or folders that the project expects to stay unchanged
  • Ignoring the project’s own install instructions
  • Not rebooting the radio after copying the files

Generic ETHOS Lua Installation Checklist

  • Download the correct ETHOS version of the script package
  • Extract the ZIP file on your computer
  • Copy the extracted folders and files to the correct SD card location
  • Do not add extra subfolders
  • Do not rename required files
  • Safely disconnect the radio and reboot it
  • Check the correct ETHOS menu area to confirm the script appears


Copyright © 2026 New England RC LLC. All rights reserved.
This guide is provided for educational and informational purposes only for customers and hobbyists using FrSky ETHOS radios and related RC equipment.

This content may not be copied, republished, redistributed, or reproduced in whole or in part without written permission from New England RC LLC.

FrSky, ETHOS, and other product names are trademarks of their respective owners and are used only for compatibility and identification purposes.