/gmod-jet

A plugin & dependency system for Garry's Mod addons.

Primary LanguageLuaMIT LicenseMIT

Jet

A plugin & dependency system for Garry's Mod addons.

Documentation

All functions/hooks/classes are well documented. You can find the documentation here. Please keep in mind that the documentation software is still a work in progress and does not work completely, however the basics should be working.

Features

  • Command Line Interface
    Interact with the Jet installation through our CLI.
    Type jet help for a list of available commands.

  • Utilities
    A lot of Lua utilities are being added to reduce boilerplate
    code for all addons and make developing easier.

  • Test Suites
    Ensure your plugins are all working as they should
    by running test suites: jet test.

Pre-Installed Plugins

  • Jet/CLI
    The Jet command line interface.

  • Jet/Config
    Provides an interface for getting & setting configuration values, globally and plugin-specific.

  • Jet/Database
    Goal of this plugin is to allow for global database connections, instead of each addon using their own.

  • Jet/Generic
    Boilerplate for a bunch of addons. Made to make developing easier.

  • Jet/Stack
    Adds a nice stack with a couple of features.

  • Jet/StringUtility
    Adds a bunch of new features for strings.

  • Jet/Updater
    Allows for semi-automatic updating.

Console Commands

  • jet benchmark <iterations> <expression>
    Benchmark an expression.

  • jet help
    Shows this help.

  • jet license
    Shows the license.

  • jet map
    Change map.

  • jet restart
    Soft-Restarts the server.

  • jet test <plugin/all/*>
    Run test suites.

  • jet version
    Shows the current version.

More commands may be added by installing plugins.