Heyter / glua-package-manager

Package Manager for Garry's Mod

GLua Package Manager

Package manager supporting isolation, synchronous import, package dependency building and more.

Features

• Package information structure like package.json
• Synchronous import of packages from different sources

Console commands

• gpm_clear_cache - Clears the cache of externally downloaded packages.
• gpm_reload - Restarts the package manager by refreshing its own code as well as reloading all packages.
• gpm_list - Prints a list of loaded packages in the console.

Console variables

• gpm_cache_lifetime - Packages cache lifetime, in hours, sets after how many hours the downloaded gpm packages will not be relevant.
• gpm_http_timeout - Default http timeout for gpm http library.

How to create your own package?

1. Create package.lua and init.lua files in directory lua/packages/<your-package-name>/.
2. Enter information about your package in package.lua, below is an example.
3. Write your code in init.lua, if you want the script to be only on the client or server, write in your package.lua additional lines server or client, an example below.

Also, you can run an existing addon via gpm, just add the code below to package.lua, and you don’t even need to add init.lua.

package.lua example

-- lua/packages/example-package/package.lua
name = "example-package"
main = "init.lua"
version = 1

-- allowed sides to run package, if client is false then the server will not send anything
client = true
server = true

-- if there is no autorun, the package will wait for import from another package
autorun = true

-- don't touch it if you don't know what you're doing
isolation = true

-- client files
send = {
    "my/client/file.lua",
    "my/client/file2.lua"
}

-- if false, the logger will not be created by default
logger = false

-- if nil, all gamemodes are allowed
gamemodes = {
    "sandbox",
    "darkrp"
}

-- if nil, all maps are allowed
maps = {
    "gm_construct"
}

-- if true, then the package is allowed to run only in a singleplayer game
singleplayer = false

Available package file parameters

• Package name (name) (def. nil)

  The name of the package is just text that will be displayed in the format name@version, for example My Awesome Package@0.0.1.

• Package version (version) (def. nil)

  By default, the version is a number whose format is { 00 } { 00 } { 00 } { 00 } = 0.0.0, you can also use your own version format, just put your version here as a string.

• Package entry point (main) (def. init.lua)

  The main in this case is the entry point to the package (where the code execution will start from), you can use either the full lua/ path, for example 'lua/packages/example-package/init.lua' or a local path relative to your package folder.

• Package client entry point (cl_main) ( def. nil)

  An optional parameter that substitutes main with another file for the client, helps to easily separate the client and server sides.

• Client and server (client, server, menu) (def. true, true, false)

  You can change the permissions to run a package, for example if you set client to false the client will not be able to run it, moreover it will not even know that such a package exists and therefore will not see its files. menu is works only in menu realm.

• Package autorun (autorun) (def. false)

  The default setting is false, if this parameter is set to true and the package is in a valid lua/ directory, the package will automatically start and will not wait to be run externally.

• Package isolation (isolation) (def. true)

  This is the parameter responsible for isolation, by default it is true, if it is set to false then the package will run in _G and all global values created in it will go to _G, as well as you will no longer have access to gpm environment features. I recommend to use this only if you really need it.

• Package send list (send) (def. nil)

  The list of files to send to the client, can be useful if the package runs exclusively on the client and has more than one file. (must be a table with indexes from 1 to infinity)

• Package logger (logger) (def. false)

  If set to true then a personal logger object will be created in the package environment, to easily send logs to the console. If necessary, you can create a logger object yourself, just call gpm.logger.Create( name, color ) (name is string, color is Color).

  Example usage

  local logger = gpm.Logger
  
  logger:Info( "My info message, this supports lua formatting like %s %f and other", "this", 0.025 )
  logger:Warn( "Warns!")
  logger:Error( "Errors!" )
  
  -- by default, they are only sent if the developer convar > 0
  logger:Debug( "Debug prings" )
  
  -- you can also set your own condition for debugging information
  logger:SetDebugFilter( function( str, ... )
      return true
  end )

  Result

  

• Package active gamemode (gamemodes) (def. nil)

  A string with a one gamemode or a list table with allowed gamemodes, if the current gamemode does not match any of the ones listed here the package will not run.

• Package current map (maps) (def. nil)

  A string with a map name or a list table with many map names, if the current map does not match any of the ones listed here the package will not run.

• Package singleplayer only (singleplayer) (def. false)

  The boolean value that allows the package to be executed only in a singleplayer game.

• Others

  This file can also contain any other additional information such as package author, license or description.

Simple import function usage example

Here is an example of the use of import in the init.lua file of the package.

-- pkg1 init.lua
import "packages/pkg2"

print( package2.feature() )

Look for more examples in our code ;)

How to improve?

For better speed and reliability, the following binary modules can be installed in the game:

• gm_asyncio ⭐
• gm_chttp
• async_write
• gmsv_reqwest

In the near future we will release our own, better implemented binary modules to improve performance.

License

MIT © Pika Software