How to separate Awesome's `rc.lua` configuration into multiple files?

Question

I've just moved to Awesome WM from OpenBox. I like that it's very extensible, customizable and I have huge control about window layout. I like structured and organized things and I'd like to separate that huge .config/awesome/rc.lua configuration into multiple files. But I'm still newbie to Awesome and I've never used lua before.

Answer 1

You can simply place code in a separate file and include it with

dofile("somefile.lua")

Note: The working directory is $HOME. To specify a file relative to rc.lua you can use

dofile(awful.util.getdir("config") .. "/" .. "somefile.lua")

If it's more than just some code and it might be used by others as well, it might make sense to create a lua module which can be included with

require("somemodule")

Answer 2

To move code into a different file, you create a module and require the module in the rc.lua.

To create a module, you simply call module (name [, ···]) in the script that has the code you pulled out of the original script. Lua reference - module.

To use the module you created, you just call require (modname). Lua reference - require.

There is an excellent tutorial on the Lua wiki that explains this with examples. And if you want to see how module() really works, there is an article on Play With Lua that starts by writing an implementation of module().