Merge pull request #29 from Pika-Software/dev

1.36.0

Author: unknown-gd

README.md

@@ -27,43 +27,46 @@ Also, you can run an existing addon via gpm, just add the code below to `package
 ```lua
 -- lua/packages/example-package/package.lua
 name = "example-package"
-main = "init.lua"
-version = 1
+version = 000100
 
--- allowed sides to run package, if client is false then the server will not send anything
-client = true
-server = true
+-- Files to be used as an entry point into the package, supports relative paths and global relative to "lua/"
+init = {
+    ["client"] = "cl_init.lua",
+    ["server"] = "init.lua",
+    ["menu"] = "init.lua"
+}
 
--- if there is no autorun, the package will wait for import from another package
+-- 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
+-- Don't touch it if you don't know what you're doing
 environment = true
 
--- client files
+-- Client files ( supports relative paths and global paths by "lua/" )
 send = {
-    "my/client/file.lua",
-    "my/client/file2.lua"
+    "file.lua",
+    "my_addon/file2.lua"
 }
 
--- if false, the logger will not be created by default
+-- If false, the logger will not be created by default and logs color
 logger = false
 color = Color( 255, 255, 0 )
 
--- if nil, all gamemodes are allowed
+-- Allowed gamemodes list, if nil then all gamemodes are allowed
 gamemodes = {
     "sandbox",
     "darkrp"
 }
 
--- if nil, all maps are allowed
+-- Allowed maps list, if nil then all maps are allowed
 maps = {
     "gm_construct"
 }
 
--- if true, then the package is allowed to run only in a singleplayer game
+-- If true, then the package is allowed to run only in a singleplayer game
 singleplayer = false
 
+-- Enables automatic naming for listed libraries, e.g. all hooks with hook = true will have a package identifier in the hook name, if the hook name is a string of course...
 autonames = {
     ["properties"] = true,
     ["timer"] = true,
@@ -81,14 +84,16 @@ autonames = {
 - ### Package version (`version`) (def. `nil`)
     By default, the version is a number whose format is { 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.
+- ### Package init (`init`)
+    This is a universal parameter, which can be either a string or a table, in case it is a string, the package will run on both server and client and menu using the same initialization point, but if it is a table, it must contain parameters like ["realm"] = "path/to/init. lua", if any side is not specified then it won't be launched/sent, i.e. if we specify this value to {["server"] = "init.lua"} the package will only run on server and won't be sent to clients and also will not support menu realm.
 
-- ### 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.
+    #### Example
+    ```lua
+        init = {
+            ["server"] = "init.lua",
+            ["client"] = "cl_init.lua"
+        }
+    ```
 
 - ### 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.
@@ -100,7 +105,7 @@ autonames = {
     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`).
+    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.CreateLogger( name, color )` (`name` is `string`, `color` is `Color`).
 
     #### Example usage
     ```lua

lua/gpm/commands.lua

@@ -1,6 +1,7 @@
 local logger = gpm.Logger
 local SERVER = SERVER
 local ipairs = ipairs
+local table = table
 local gpm = gpm
 local net = net
 
@@ -51,12 +52,25 @@ do
     local colors = gpm.Colors
     local pairs = pairs
     local MsgC = MsgC
+    local type = type
 
     function gpm.PrintPackageList( packages )
         MsgC( colors.Realm, gpm.Realm, colors.PrimaryText, " packages:\n" )
 
+        if type( packages ) ~= "table" then
+            packages = {}
+
+            for _, pkg in pairs( gpm.Packages ) do
+                packages[ #packages + 1 ] = pkg
+            end
+        end
+
+        table.sort( packages, function( a, b )
+            return a:GetIdentifier() < b:GetIdentifier()
+        end )
+
         local total = 0
-        for _, pkg in pairs( packages or gpm.Packages ) do
+        for _, pkg in pairs( packages ) do
             MsgC( colors.Realm, "\t* ", colors.PrimaryText, pkg:GetIdentifier() .. "\n" )
             total = total + 1
         end
@@ -66,6 +80,10 @@ do
 
 end
 
+local function catch( message )
+    logger:Error( message )
+end
+
 function gpm.Reload( ... )
     local arguments = { ... }
     if #arguments == 0 then
@@ -83,7 +101,7 @@ function gpm.Reload( ... )
     local packages, count = {}, 0
     for _, searchable in ipairs( arguments ) do
         if #searchable == 0 then continue end
-        for _, pkg in ipairs( gpm.package.Find( searchable, false, false ) ) do
+        for _, pkg in ipairs( gpm.Find( searchable, false, false ) ) do
             packages[ pkg ] = true
             count = count + 1
         end
@@ -97,7 +115,7 @@ function gpm.Reload( ... )
     logger:Info( "Found %d candidates to reload, reloading...", count )
 
     for pkg in pairs( packages ) do
-        pkg:Reload( true )
+        pkg:Reload( true ):Catch( catch )
     end
 end
 
@@ -111,7 +129,7 @@ function gpm.Uninstall( force, ... )
     local packages, count = {}, 0
     for _, searchable in ipairs( arguments ) do
         if #searchable == 0 then continue end
-        for _, pkg in ipairs( gpm.package.Find( searchable, false, false ) ) do
+        for _, pkg in ipairs( gpm.Find( searchable, false, false ) ) do
             packages[ pkg ] = true
             count = count + 1
         end
@@ -245,7 +263,8 @@ if CLIENT then
 
             local pkg = gpm.Packages[ importPath ]
             if not pkg then return end
-            pkg:Reload()
+
+            pkg:Reload():Catch( catch )
         end
     }
 

lua/gpm/environment.lua

@@ -5,7 +5,6 @@ local debug = debug
 -- Variables
 local setmetatable = setmetatable
 local rawget = rawget
-local ipairs = ipairs
 local type = type
 
 module( "gpm.environment" )
@@ -45,13 +44,7 @@ do
 
     function UnLink( environment1, environment2 )
         local links = GetLinks( environment1 )
-        for index, environment in ipairs( links ) do
-            if environment == environment2 then
-                table.remove( links, index )
-                break
-            end
-        end
-
+        table.RemoveByIValue( links, environment2 )
         return environment1
     end