facepunch / gmod-module-base

The base interface to create binary modules for Garry's Mod

gmod-module-base

Technically everything you need is in include.

Example contains an example project. Running BuildProjects.bat requires premake4 (http://industriousone.com/premake).

The generated dlls should be placed in

garrysmod/lua/bin/

They should also be named appropriately:

gmsv_example_win32.dll	serverside on windows	require( 'example' )
gmsv_example_linux.dll	serverside on linux	require( 'example' )
gmsv_example_osx.dll	serverside on osx	require( 'example' )
gmcl_nutsack_win32.dll	clientside on windows	require( 'nutsack' )
gmcl_example_osx.dll	clientside on osx	require( 'example' )

gmod-module-base's Issues

coroutines cause the generated modules to break

The modules either crash or return incorrect values.

http://facepunch.com/showthread.php?t=1260809&p=42916561#post42916561

Example:

require'example' -- [url]https://github.com/garrynewman/gmod-module-base/blob/master/example/src/gm_example.cpp[/url]
local var
local thread = coroutine.create(function() 
   var = TestFunction(123,321)
   ErrorNoHalt(TestFunction())
   coroutine.yield()
   var = TestFunction()
end)
print("thread",thread) --thread thread: 0xd713a598
print("before",var) --before nil
--  321
print("resume",coroutine.resume(thread),coroutine.status(thread)) --  resume true suspended
print("now",var) -- now 321
print("should be",TestFunction(321)) -- should be Thanks for the number - I love 321.000000!!
print("resume",coroutine.resume(thread),coroutine.status(thread)) -- resume true dead
print("now",var) --  now -2.9528447354403e+111
print("should be",TestFunction()) -- should be This string is returned```

Wrap additional methods from Lua 5.1 API

It's still not really feasible to stick with just ILuaBase for modules since it's missing some core Lua functionality. Specifically:

• lua_callk
• lua_concat
• lua_createtable arguments
• lua_error (erroring from the stack instead of a C-string)
• lua_gc
• lua_getfenv
• lua_getinfo
• lua_getlocal
• lua_getstack
• lua_getupvalue
• lua_lessthan
• lua_newthread
• lua_push(v)fstring
• lua_pushinteger
• lua_replace
• lua_resume
• lua_setfenv
• lua_setglobal
• lua_topointer
• lua_upvalueindex
• lua_yield
• luaL_loadfile
• luaL_loadstring
• luaL_where

expose ILuaInterface->Msg?

"Unable to write file to..."

When using the development branch, if you try to run "premake5.exe vs2019" this error is printed:

C:\Users\Richa\Documents\GitHub\gmod-module-base-development\example>premake5.exe vs2019
** Warning: os.get() is deprecated, use 'os.target()' or 'os.host()'.
   @...GitHub\gmod-module-base-development\example\premake5.lua(3)

** Warning: os.is() is deprecated, use 'os.istarget()' or 'os.ishost()'.
   @...GitHub\gmod-module-base-development\example\premake5.lua(13)

** Warning: os.is() is deprecated, use 'os.istarget()' or 'os.ishost()'.
   @...GitHub\gmod-module-base-development\example\premake5.lua(14)

** Warning: os.is() is deprecated, use 'os.istarget()' or 'os.ishost()'.
   @...GitHub\gmod-module-base-development\example\premake5.lua(15)

** Warning: the flags value StaticRuntime has been deprecated and will be removed.
   Use `staticruntime "On"` instead
   @C function

Building configurations...
Running action 'vs2019'...
Error: unable to write file to 'C:/Users/Richa/Documents/GitHub/gmod-module-base-development/example/projects/windows/gmsv_example.sln'

Unknown CMake command "set_gmod_suffix_prefix".

On the dev branch

CMake Error at CMakeLists.txt:14 (add_subdirectory):
  The source directory

    C:/Users/user/Desktop/gmod-modules/include

  does not contain a CMakeLists.txt file.


CMake Error at natsunet/CMakeLists.txt:7 (set_gmod_suffix_prefix):
  Unknown CMake command "set_gmod_suffix_prefix".


-- Configuring incomplete, errors occurred!
See also "C:/Users/user/Desktop/gmod-modules/CMakeFiles/CMakeOutput.log"

Loading example module broken on linux

Silly that you even have to rename the .so to a .dll for it to even find the module which is a bug of its own. It finds the module but then presents me with this error:

Module name: gmcl_example_linux.dll

[ERROR] addons/mca/lua/autorun/client/cl_test.lua:4: Couldn't load module library!
  1. require - [C]:-1
   2. unknown - addons/mca/lua/autorun/client/cl_test.lua:4

The file is not found using gmcl_example_linux.so
Same with development branch.