StarMirror/sol2
1
0
Fork 0
mirror of https://github.com/ThePhD/sol2.git synced 2024-03-22 13:10:44 +08:00
Code Issues Projects Releases Wiki Activity
Sol3 (sol2 v3.0) - a C++ <-> Lua API wrapper with advanced features and top notch performance - is here, and it's great! Documentation:
112 Commits 3 Branches 96 Tags 29 MiB
C++ 90.1%
CMake 6.1%
C 2.1%
Shell 0.9%
Python 0.6%
Other 0.1%
afe435910f
Go to file
Rapptz afe435910f Add basic examples directory
2013-12-16 11:17:33 -05:00
Catch@a6d74bd55a CATCH for tests. 2013-12-11 06:38:25 -05:00
examples Add basic examples directory 2013-12-16 11:17:33 -05:00
sol Remove support for operator[] on tables 2013-12-16 11:07:10 -05:00
.gitignore Have I mentioned I hate GCC? I hate GCC. 2013-12-11 11:56:34 -05:00
.gitmodules CATCH for tests. 2013-12-11 06:38:25 -05:00
build.ninja Renamed sol.scratch.cpp to tests.cpp 2013-12-12 05:40:05 -05:00
CONTRIBUTING.md Add contributing guidelines 2013-12-14 05:26:43 -05:00
LICENSE.txt Initial commit 2013-11-25 04:56:27 -05:00
README.md Add basic examples directory 2013-12-16 11:17:33 -05:00
sol.hpp function header with addition to sol.hpp so that a person can do function invocations on lua functions without explicitly adding sol/functions.hpp 2013-12-01 18:15:26 -05:00
tests.cpp Remove support for operator[] on tables 2013-12-16 11:07:10 -05:00

README.md

Sol

Sol is a C++ library binding to Lua. It currently supports Lua 5.2. Sol aims to be easy to use and easy to add to a project. At this time, the library is header-only for easy integration with projects.

Caveats

Due to how this library is used compared to the C API, the Lua Stack is completely abstracted away. Not only that, but all Lua errors are thrown as exceptions instead. This allows you to handle the errors gracefully without being forced to exit.

It should be noted that the library itself depends on lua.hpp to be found by your compiler. It uses angle brackets, e.g. #include <lua.hpp>.

Contributing

If you want to contribute, please check CONTRIBUTING.md for details. Thank you!

Examples

Examples are provided in the examples directory.

License

Sol is distributed with an MIT License. You can see LICENSE.txt for more info.

Supported Compilers

Sol makes use of C++11 features. GCC 4.7 and Clang 3.3 or higher should be able to compile without problems. Visual Studio 2013 with the November CTP should be able to support this as well.

TODO

  • Possibly document functions and classes via doxygen.
  • Provide more examples to showcase uses.