Tip
New: I've launched a dedicated Documentation Website and a standalone Installer App to make setup easier!
AlyxLib provides a set of useful Lua libraries for scripting with Half-Life: Alyx, making your development process smoother and more efficient.
Your addon is linked to AlyxLib via symbolic links, ensuring that every addon uses the same source and gets updated automatically whenever AlyxLib is updated. Plus, since your workshop item uses AlyxLib as a requirement, it will also receive any fixes without you having to reupload.
- Full VScript code completion using Lua Language Server.
- Save/Load most data types easily to any entity.
- Custom class implementation for entities, including inheritance and automatic variable saving.
- Player interaction simplification and tracking of items.
- Send data to and from Panorama ←→ Lua.
- Easy controller input tracking with function callbacks.
- Lots of useful debugging functions and console commands.
- A fully customizable in-game debug menu.
See the Documentation Website for component breakdowns, function references, and code examples.
Note
For in-depth or manual setup, see the Getting Started Guide.
-
Download AlyxLib Installer and run the app.
-
Follow the setup instructions within the app to download AlyxLib.
-
Open your addon from the file menu and select the AlyxLib modules you wish to use.
-
Before uploading: Click the
Remove For Uploadbutton in the app. -
Upload your addon to the workshop and set AlyxLib as a required item.
-
Rename the
0000000000.luafile inscripts/vscripts/mods/init/to match the workshop ID of your new workshop item (this is the same process outlined in Scalable Init Support) -
Click
Installin the app to restore the AlyxLib files in your addon.
If you run into issues, feel free to create an issue.
You can also join us on 
Discord for faster responses.
