TtyPack: Single-file Lua apps for the terminal.

Under construction 🏗️

TtyPack lets you create self-contained terminal applications using Lua and C#-provided built-in modules. Think of it as of custom standart library + bundling tool. Package scripts, and other assets into a single .ttypack file that can be run anywhere using TtyPack with built-in sandboxing.

NOTE: TtyPack IS NOT built for dependency management in any way. It can bundle the app, and run the app. It won't add or use any library (pure-Lua* library) until you add it as asset and use it.

*pure-Lua library means that not only it doesn't rely on FFI, but also it's fully compatible with TtyPack's limitations and APIs

Why TtyPack?

Not only TtyPack makes it easier to share your apps, but also it's more safe because of Permissions. Also, using TtyPack you are given a lot of different APIs:

• Assets
• Console
• Events
• Permissions
• Script
• Storage
• System
• Json
• Network (WIP)

So that development experience is way better.

Limitations

Due to Lua CSharp limitations C-based Lua libraries are not supported. Also, Os, Io and Debug libraries are disabled for sandboxing reasons. But TtyPack offers permission-based System module in exchange. There are a lot of different modules (APIs) planned:

• Net (partially implemented)
• ...and more, if you suggest more

How to use it?

First of all, you would need to have .NET 10 installed on your machine. Then, clone the repository:

$ git clone https://github.com/Ict00/TtyPack.git
$ cd TtyPack/TtyPack

Then build it:

$ dotnet publish

That's all. The executable will be located at bin/Release/net10.0/(your platform)/publish/TtyPack

Supported platforms:

• Linux
• Windows (Not tested)
• Mac OS (Not tested)

For developers:

Main documentation

Examples

If you encounter any bugs, report them in Github Issues. It'll help the project to improve <3

Important information for users:

TtyPack (FOR NOW) will create and use .ttystorage directory IN THE SAME DIRECTORY AS EXECUTABLE to store some data like apps' local data and permissions. This will be changed in next updates.