{* ldoc.body *}
{% elseif (module) then -- we're rendering libary contents %}
{(docs/templates/module.ltp)}
{% end %}
Welcome to the documentation for Helix - the better gamemode framework.
The sidebar shows the entire contents of the documentation. Libraries, functions, etc are all searchable with the search box at the top of the sidebar. Migrating from Clockwork? Check out the conversion guide in the manual.
If you're looking to get your Helix server up and running as soon as possible, check out the Getting Started guide in the manual.
Questions? Want to show off your work? Maybe drop a new plugin release? Come join our community Discord server.
Helix is a large project and there are still a few things missing here and there. Contributions to the documentation - from function references, to simple typo fixes - are welcomed! Check out the ix.storage library's source code for a good example on how to write documentation. You'll need a basic understanding of Markdown, since it's used extensively to generate the markup.
If you'd like to contribute code, you can visit the GitHub repository and make a pull request.
Getting started on developing with the Helix framework requires an intermediate level of Garry's Mod Lua knowledge. You'll want to learn the basics before you get starting making a schema. The Garry's Mod Wiki is a good place to start.
{* ldoc.markup(mod.description) *}
{% for kind, items in mod.kinds() do %}This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Documentation for this section is incomplete and needs expanding.
{* ldoc.markup(ldoc.descript(item)) *}
{% end %}{* ldoc.markup(item.params.map[argumentName]) *}
{* ldoc.markup(returnValue.text) *}
{* usage *}