Roblox API Reference

Generates reference pages for the Roblox API.

Files and folders

• generate

  Contains the generator script and resources.

• generate.lua

  Does all the generating.

• lua

  Contains Lua libraries used by generate.lua.

• resources

  Contains resource files used in the final output.

  • css: CSS files.
  • images: Image files.
  • js: Javascript files.
  • templates: HTML template files. These are parsed by slt2 to generate HTML pages.

• data

  Contains user-generated data about classes. Here, user-generated information may be added. For info on contributing, read CONTRIBUTING.md.

Generating

1. Install Lua.
2. Make sure your Lua installation has LuaFileSystem, LuaSockets and LuaZip.
3. Set your working directory to the generate folder.
4. Run lua generate.lua. Options are the folders to output to. If the first option is -c or --clear, then each folder will be cleared first. Calling no options produces a help message.