mirror of
https://github.com/pinnacle-comp/pinnacle.git
synced 2024-12-27 21:58:18 +01:00
52 lines
2.6 KiB
TOML
52 lines
2.6 KiB
TOML
# This metaconfig.toml file dictates what config Pinnacle will run.
|
|
#
|
|
# When running Pinnacle, the compositor will look in the following directories for a metaconfig.toml file,
|
|
# in order from top to bottom:
|
|
# $PINNACLE_CONFIG_DIR
|
|
# $XDG_CONFIG_HOME/pinnacle/
|
|
# ~/.config/pinnacle/
|
|
#
|
|
# When Pinnacle finds a metaconfig.toml file, it will execute the command provided to `command`.
|
|
# For now, the only thing that should be here is `lua` with a path to the main config file.
|
|
# In the future, there will be a Rust API that can be run using `cargo run`.
|
|
#
|
|
# Because configuration is done using an external process, if it ever crashes, you lose all of your keybinds.
|
|
# In order prevent you from getting stuck in the compositor, you must define keybinds to reload your config
|
|
# and kill Pinnacle.
|
|
#
|
|
# More details on each setting can be found below.
|
|
|
|
# The command Pinnacle will run on startup and when you reload your config.
|
|
# Paths are relative to the directory the metaconfig.toml file is in.
|
|
# This must be an array.
|
|
command = ["cargo", "run", "--example", "example_config"]
|
|
|
|
### Keybinds ###
|
|
# Each keybind takes in a table with two fields: `modifiers` and `key`.
|
|
# - `modifiers` can be one of "Ctrl", "Alt", "Shift", or "Super".
|
|
# - `key` can be a string of any lowercase letter, number,
|
|
# "numN" where N is a number for numpad keys, or "esc"/"escape".
|
|
# Support for any xkbcommon key is planned for a future update.
|
|
|
|
# The keybind that will reload your config.
|
|
reload_keybind = { modifiers = ["Ctrl", "Alt"], key = "r" }
|
|
# The keybind that will kill Pinnacle.
|
|
kill_keybind = { modifiers = ["Ctrl", "Alt", "Shift"], key = "escape" }
|
|
|
|
### Socket directory ###
|
|
# Pinnacle will open a Unix socket at `$XDG_RUNTIME_DIR` by default, falling back to `/tmp` if it doesn't exist.
|
|
# If you want/need to change this, use the `socket_dir` setting set to the directory of your choosing.
|
|
#
|
|
# socket_dir = "/your/dir/here/"
|
|
|
|
### Environment Variables ###
|
|
# You may need to specify to Lua where Pinnacle's Lua API library is.
|
|
# This is currently done using the `envs` table, with keys as the name of the environment variable and
|
|
# the value as the variable value. This supports $var expansion, and paths are relative to this metaconfig.toml file.
|
|
#
|
|
# Pinnacle will run your config with the additional PINNACLE_DIR environment variable.
|
|
#
|
|
# Here, LUA_PATH and LUA_CPATH are used to tell Lua the path to the library.
|
|
[envs]
|
|
# LUA_PATH = "$PINNACLE_LIB_DIR/lua/?.lua;$PINNACLE_LIB_DIR/lua/?/init.lua;$PINNACLE_LIB_DIR/lua/lib/?.lua;$PINNACLE_LIB_DIR/lua/lib/?/init.lua;$LUA_PATH"
|
|
# LUA_CPATH = "$PINNACLE_LIB_DIR/lua/lib/?.so;$LUA_CPATH"
|