Skip to content

Installation

Four ways to add glyph to your Love2D project.

Feather is a curated package installer for LÖVE libraries. It verifies every install with a SHA-256 checksum and records exact versions in a lockfile.

feather package install glyph

Feather places the files inside your project and adds an entry to feather.lock.json so the install is reproducible. To restore dependencies on a fresh clone:

feather package install

Option 2 — Release zip

Download the latest zip from the GitHub Releases page.

  1. Unzip the archive.
  2. Copy the two items into your project root (or a lib/ subfolder):
your-game/
├── glyph.lua
└── glyph/
    ├── components.lua
    ├── runtime.lua
    └── ...
  1. Add the location to package.path if you placed them in a subfolder:
package.path = "lib/?.lua;lib/?/init.lua;" .. package.path

local ui = require("glyph")

If you copied them straight to the project root no path change is needed.

Option 3 — Clone the repository

Clone and copy the two items that make up glyph:

git clone https://github.com/Kyonru/glyph.lua.git

Then copy glyph.lua and the glyph/ folder into your project:

cp glyph.lua/glyph.lua   your-game/
cp -r glyph.lua/glyph/   your-game/glyph/

If you prefer to keep glyph as a submodule instead:

cd your-game
git submodule add https://github.com/Kyonru/glyph.lua.git lib/glyph

Then point package.path at the submodule:

package.path = "lib/glyph/?.lua;lib/glyph/?/init.lua;" .. package.path

local ui = require("glyph")

Option 4 — LuaRocks

Install the rock directly from the terminal:

luarocks install glyph

LuaRocks places glyph on the global Lua path, so no package.path adjustment is needed. Just require it:

local ui = require("glyph")

Note

Love2D uses its own bundled Lua rather than the system one, so the LuaRocks tree is not on package.path by default. Add the snippet below to the top of main.lua to bridge them.

local rock = io.popen("luarocks path --lr-path 2>/dev/null"):read("*l")
if rock then package.path = rock .. ";" .. package.path end

Verify the install

Paste this into main.lua and run with love . — a white label should appear:

local ui = require("glyph")

local function App()
  return ui.text("glyph is working!")
end

function love.load()
  ui.load({ app = App })
end

function love.update(dt) ui.update(dt) end
function love.draw()     ui.render(App) end