Entropy

新着

Omarchy を触る上で知っておきたい最低限の Lua の知識

Properties2
descriptionOmarchy の Lua の設定ファイルを読むために必要な、値、table、関数、require、条件分岐などの Lua の文法をまとめた
tagsblog, lua, omarchy

TL;DR

  • Omarchy の設定ファイルを読み書きするのに必要な、最低限の Lua の文法をまとめた。
  • hl は Hyprland の API の table、o は Omarchy が用意しているヘルパーの table である。

検証

値と変数

基本的な値には、文字列、数値、真偽値、値がないことを表す nil がある。

"chromium"      -- string
10              -- number
1.5             -- number
true            -- boolean
false           -- boolean
nil             -- 値がない

ローカル変数は local で宣言する。

local terminal = "kitty"

コメント

単一行のコメントは --、複数行のコメントは --[[ ~ ]] で書く。

table

table は、JavaScript の Object や Array に当たるデータ構造である。Object のようにも Array のようにも使える。

{ launch = "chromium" }
{ "foo", "bar", "baz" }

ネストもできる。

hl.config({
    general = {
        gaps_in = 5,
        gaps_out = 20,
        border_size = 2,
    },
 
    decoration = {
        rounding = 10,
 
        shadow = {
            enabled = true,
            range = 4,
        },
    },
})
points = { { 0.23, 1 }, { 0.32, 1 } }

関数呼び出し

. で table の中にアクセスする。次の例では、hl という table に入っている env 関数を呼び出している。

hl.env("XCURSOR_SIZE", "24")

require 関数

require はモジュールを読み込む関数である。

require("hypr.bindings")

or

A or B は、A が使えれば A を、そうでなければ B を使う。たとえば os.getenv("OMARCHY_PATH") or "/usr/share/omarchy" は、環境変数 OMARCHY_PATH があればその値を、なければ /usr/share/omarchy を使う。

文字列の連結

文字列は .. で連結する。"foo" .. "bar" は foobar になる。

dofile 関数

dofile は、Lua のファイルを読み込んで実行する関数である。

dofile("foo.lua")

条件分岐と否定演算子

条件分岐は if ~ then ~ end で書く。「等しくない」は ~= で書く（a ~= b）。

if _G.omarchy_default_bindings ~= false then
    require("default.hypr.bindings.media")
    require("default.hypr.bindings.clipboard")
    require("default.hypr.bindings.tiling")
    require("default.hypr.bindings.utilities")
end

関数定義

関数は function ~ end で定義する。無名関数も同じ書き方である。

l.on("hyprland.start", function ()
    hl.exec_cmd(terminal)
    hl.exec_cmd("nm-applet")
end)

hl と o

Omarchy のドキュメントによると、hl と o は次のものである。

キーワード

参考

グラフビュー

バックリンク