Add more Lua libraries

[SolarcGit]

We should consider adding the following libraries to the ScriptInterpreter.cpp:

• sol::lib::package
• sol::lib::coroutine
• sol::lib::string
• sol::lib::os
• sol::lib::table

[adriengivry]

Good point. We should also evaluate the consequences of adding these libraries:

• Runtime overhead?
• Loading times?

[SolarcGit]

What these libraries add to the making of a game outweights the consequences In my opinion. (I am pretty new though please keep that in mind) Having these libraries, especially table, coroutine, string and os, would greatly help in developing a game.

[adriengivry]

What these libraries add to the making of a game outweights the consequences In my opinion. (I am pretty new though please keep that in mind) Having these libraries, especially table, coroutine, string and os, would greatly help in developing a game.

That's for sure! But it's important to gather factual data about the consequences of making such a change in order to make a more informed decision.

[SolarcGit]

Yes opinion is not all. Sadly I dont know how to gather the data to find out if it would be detrimental to the performance. Is there any way I can push this?

[adriengivry]

Yes opinion is not all. Sadly I dont know how to gather the data to find out if it would be detrimental to the performance. Is there any way I can push this?

We should look into sol2 and see how they implemented lua libraries. Are these libraries dynamic loaded? Are there any requirements to include these libs? Compatibility issues? Maybe having some profiling data about compilation time and runtime performance with/without these libs would be good to have too. We should document all that in the pull request adding these libraries to Overload.

[SolarcGit]

Is there any way I can help do that?

[adriengivry]

Is there any way I can help do that?

For sure! You can do this investigation process, do the change first (include the libs), and measure the performance impact (compilation and runtime), and document all that 👌

[SolarcGit]

using sol2?

[adriengivry]

Overload is using sol2 for lua scripting yes

[SolarcGit]

ok ok got it but where do I start?

[adriengivry]

ok ok got it but where do I start?

Make the requested change in ScriptInterpreter.cpp, and get some profiling data with VS. Dig into sol2 and investigate the implications of such a change.

[SolarcGit]

can you show me how I can do the change?

[adriengivry]

https://github.com/adriengivry/Overload/blob/a56596b45935660cd5d8e0e61f52f04adf756931/Sources/Overload/OvCore/src/OvCore/Scripting/ScriptInterpreter.cpp#L32

Read the documentation of the open_libraries function in sol2.

[SolarcGit]

will do!