Home

Welcome to the Xenon wiki!

Here you will find documentation on the specifics about Xenon's layout system, as well as in-depth explanations of config options.

Getting Started

Detailed install instructions are available here.

Installing Xenon is as easy as grabbing the latest release from the releases tab, all required libraries are bundled together in the release for your convenience. Alternatively use the updater script: pastebin run R9YdyMAM startup.lua

To start using Xenon, you'll need 3 things, a config.lua file, a layout.html, and a styles.css file. You can get the example config here. And you can start by grabbing a layout.html and styles.css from any one of the examples.

If you wish to quickly edit the layout without any of the shop functionality being initialized (especially useful for environments such as CCEmuX), try using layout mode, to enter layout mode, launch xenon with argument --layout or just -l. To exit layout mode, just click anywhere, and Xenon will terminate gracefully.

You can check out some of the high quality premade layouts in the examples section.

And of course, it is highly encouraged for you to poke around the examples and create your own layouts and styles. Additionally, all of the information regarding available style rules and elements should be available here in this wiki.

Building Xenon

Suppose you want to add some fancy new feature to Xenon, that's awesome! Make your changes in any of the source files, and then to build Xenon, all you have to do is run the build script, to do so run lua build.lua in the root directory of the repository.