EML Docs

Set up environment

Before building the launcher, you need a working Node.js environment and an Electron project wired up with EML Lib.

Install Node.js

EML Lib requires Node.js v20 or later. Node.js v24 LTS is recommended.

Initialize the project

There are two ways to get started: using EML Template (recommended for beginners) or setting up the environment manually.

Option 1 — EML Template

EML Template is an Electron + Vite boilerplate pre-configured with TypeScript, SCSS, and electron-builder. IPC handlers, preload script, and EML Lib wiring are already in place. It is the fastest way to get a working launcher.

  1. Go to the EML Template repository on GitHub.

  2. Click “Use this template” > “Create a new repository”, or click “Fork”, to create your own copy.

  3. Clone and install:

    git clone https://github.com/YOUR_USERNAME/my-launcher.git
    cd my-launcher
    npm install
  4. Open electron/const.ts and set the ADMINTOOL_URL constant to your EML AdminTool URL (or your self-hosted manifest URL if you are not using AdminTool).

  5. Start the developer mode:

    npm run dev

You can now move on to Frontend architecture.

Option 2 — Manual setup