https://github.com/frostsource/alyxlib

Scripting API for Half-Life Alyx addons
https://github.com/frostsource/alyxlib

half-life halflifealyx lua source2

Last synced: about 6 hours ago
JSON representation

Scripting API for Half-Life Alyx addons

• Host: GitHub
• URL: https://github.com/frostsource/alyxlib
• Owner: FrostSource
• License: mit
• Created: 2024-06-02T11:55:18.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2026-03-27T01:48:29.000Z (7 days ago)
• Last Synced: 2026-03-27T03:54:15.491Z (7 days ago)
• Topics: half-life, halflifealyx, lua, source2
• Language: Lua
• Homepage:
• Size: 5.63 MB
• Stars: 13
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    



> [!TIP]

> **New:** I've launched a dedicated [Documentation Website](https://frostsource.github.io/alyxlib/) and a standalone [Installer App](https://frostsource.github.io/AlyxLibInstaller/) to make setup easier!



[![License](https://img.shields.io/badge/License-MIT-04663E)](#license)

[![issues](https://img.shields.io/github/issues/FrostSource/alyxlib?color=04663E)](https://github.com/FrostSource/alyxlib/issues)

![GitHub commit activity](https://img.shields.io/github/commit-activity/w/FrostSource/alyxlib?color=04663E)




[![Documentation](https://img.shields.io/badge/📖_Read_The_Docs-blue?style=for-the-badge)](https://frostsource.github.io/alyxlib/)

[![Installer](https://img.shields.io/badge/📥_Download_Installer-orange?style=for-the-badge)](https://frostsource.github.io/AlyxLibInstaller/)




[![Steam](https://img.shields.io/steam/downloads/3329679071?style=for-the-badge&logo=steam&label=steam&logoSize=auto&labelColor=black&color=2ea44f)](https://steamcommunity.com/sharedfiles/filedetails/?id=3329679071 "AlyxLib workshop")

[![Discord](https://img.shields.io/discord/825047476146012261?style=for-the-badge&logo=discord&logoColor=white&label=discord&logoSize=auto&labelColor=5865F2&color=2ea44f)](https://discord.gg/42SC3Wyjv4 "Join the Discord")



---

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.

## 📚 Library overview

* Full VScript code completion using [Lua Language Server](https://luals.github.io/).

* 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](https://frostsource.github.io/alyxlib/) for component breakdowns, function references, and code examples.

## 🚀 Quick setup guide

> [!NOTE]

> For in-depth or manual setup, see the [Getting Started Guide](https://frostsource.github.io/alyxlib/getting_started/app_installation.html).

1. **[Download AlyxLib Installer](https://frostsource.github.io/AlyxLibInstaller/)** and run the app.

2. Follow the setup instructions within the app to download AlyxLib.

3. Open your addon from the file menu and select the AlyxLib modules you wish to use.

4. **Before uploading:** Click the `Remove For Upload` button in the app.

5. Upload your addon to the workshop and set [AlyxLib](https://steamcommunity.com/sharedfiles/filedetails/?id=3329679071) as a required item.

6. Rename the `0000000000.lua` file in `scripts/vscripts/mods/init/` to match the workshop ID of your new workshop item [(this is the same process outlined in Scalable Init Support)](https://github.com/PeterSHollander/scalable_init_support?tab=readme-ov-file#for-workshop-release)

7. Click `Install` in the app to restore the AlyxLib files in your addon.

## ❓ Need help?

If you run into issues, feel free to [create an issue](https://github.com/FrostSource/alyxlib/issues).

You can also join us on  [Discord](https://discord.gg/42SC3Wyjv4) for faster responses.

## 🌟 Projects using AlyxLib