Skip to content

Commit 3ec15df

Browse files
committed
Promote cross platform now that we have linux working, excepted out shared libraries with a better description on how to get it set up for custom shared libraries
1 parent 8f4251f commit 3ec15df

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,11 @@ C# .NET Core 8.0
55
Lua.NET contains full bindings to Lua5.1.5, Lua5.2.4, Lua5.3.6, Lua.5.4.6 and LuaJIT
66

77
https://github.com/tilkinsc/Lua.NET
8-
Copyright © Cody Tilkins 2023 MIT License
8+
Copyright © Cody Tilkins 2024 MIT License
99

1010
Supports Lua5.4 Lua5.3 Lua5.2 Lua5.1 and LuaJIT
1111

1212
Hardcoded to only use doubles and 64-bit integers.
13-
No DLL has to be built for this library as its included for you.
14-
Windows only. Linux is not supported, yet.
15-
Custom DLLs are supported when building from source; they must retain backwards compatibility with Lua.
1613

1714
# Design Considerations / Usage
1815

@@ -21,6 +18,12 @@ Otherwise, the lifetime of your functions should exceed the lifetime of the lua_
2118
Do not use lambdas, as C# is liable to GC them.
2219
A system to support lambdas may be added in the future, but it requires tracking lambda references.
2320

21+
# Shared Libraries
22+
23+
No shared library has to be built for this library, as its included for you.
24+
Custom DLLs are supported when building from source; they must retain ABI compatibility with Lua.
25+
If using custom shared libraries, you will need to replace the repsective shared library Nuget gives you locally in your project in `bin/{configuration}/{target}/runtimes/{platform-rid}/native`. The name must be the same as the one you are replacing. The ideal way to handle this is by rolling your own nuget package clone of this repository. The reason for this is a shortcoming of runtime dlls not being copied over in project references (as opposed to package reference from nuget). All of this can be avoided if you change the DllName inside the respective source, however, that solution adds complexity to your project. Nuget packages are easy.
26+
2427
# Examples
2528

2629
Example Usage Lua5.4.6:

0 commit comments

Comments
 (0)