Skip to content

TeamMeadows/bundler

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Meadows Bundler

Why should your players download the full source code of addons on the production branch, when you can send them just minimized code, which will be 40% smaller? That's an average of 10 MB of traffic per player.

Meadows Bundler is a universal Lua minifier for your Garry's Mod addons and Atomic Framework packages.

Usage

Meadows Bundler is a GitHub Action, so your just needed to create Workflow in your GitHub repository.

Lua side usage

Meadows Bundler adds a new comment-based directive - ---@include, that “pastes” the specified file into the current.

Important

@include directive doesn't support dynamic strings (like concatination)

---@include
include("somefile.lua")
include("otherfile.lua")
otherIncludeFunction("someotherfile.lua")

-- including will be ended on an empty line

GitHub Workflow usage

steps:
  - uses: TeamMeadows/bundler@v0.1.0
    with:
      name: foldername # Required!

      # optional parameters
      type: package # also could be "addon"
      generate-docs: true # should bundler create file for LuaLS with classes, types for your addon/package?
  - uses: @actions/

Real usecase

See how Atomic Framework builds.

To Do

  • LuaLS documentation generation
  • Mono-repository support
  • Also make CLI tool for this

About

Bundler for Atomic Framework based packages and Garry's Mod Lua addons

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published