v3.0.0

.gitignore

@@ -1,9 +1,16 @@
 
+# Source Engine
 /_bakeresourcecache/
 *bakeresourcecache.vpk
+
+# Tooling
 __pycache__
 /release/
 /test_release/
 __test*
 *.bak
+
+# MkDocs
+.cache/
 check_lua_versions.sh
+serve_mobile.bat

.vscode/alyxlib.code-snippets

@@ -10,7 +10,7 @@
 			"if thisEntity then",
 			"\t-- Inherit this script if attached to entity",
 			"\t-- Will also load the script at the same time if needed",
-			"\tinherit(GetScriptFile())",
+			"\tinherit(\"${1:EntityName}\")",
 			"\treturn",
 			"end",
 			"",
@@ -45,8 +45,8 @@
 		"scope": "lua",
 		"prefix": ["Game Event"],
 		"body": [
-			"---@param params GAME_EVENT_$2",
-			"base:GameEvent(${1:\"event\"}, function(self, params)",
+			"---@param event GAME_EVENT_$2",
+			"base:GameEvent(${1:\"event\"}, function(self, event)",
 			"\t---@cast self ${3:ClassName}",
 			"",
 			"\t$0",
@@ -59,8 +59,8 @@
 		"scope": "lua",
 		"prefix": ["Player Event"],
 		"body": [
-			"---@param params PLAYER_EVENT_$2",
-			"base:PlayerEvent(${1:\"event\"}, function(self, params)",
+			"---@param event PLAYER_EVENT_$2",
+			"base:PlayerEvent(${1:\"event\"}, function(self, event)",
 			"\t---@cast self ${3:ClassName}",
 			"",
 			"\t$0",

.vscode/alyxlib_tooling.code-snippets

@@ -47,7 +47,6 @@
 		"scope": "lua",
 		"prefix": ["snippet", "tool", "footer initialized"],
 		"body": [
-			"print(\"${1:name}.lua \".. ${2:version} ..\" initialized...\")",
 			"",
 			"return ${2:version}",
 		],

.vscode/vlua_snippets.code-snippets

@@ -48,7 +48,7 @@
 
 	"Hook: OnTakeDamage":{
 		"scope": "lua",
-		"prefix": ["Hook", "OnTakeDamage", "Snippet"],
+		"prefix": ["Hook", "OnTakeDamageTable", "Snippet"],
 		"body": [
 			"---@param damageTable TypeDamageTable",
 			"function OnTakeDamage(damageTable)",

README.md

@@ -1,77 +1,81 @@
-
 <p align="center">
 <picture>
     <img alt="AlyxLib Logo" src="./assets/alyxlib_logo_256x256.png" width="128">
 </picture>
 </p>
 
+> [!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!
+
 <div align="center">
 
 [![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)
 
-[![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")
-[![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")
+<br />
+
+[![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/)
 
-[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://github.com/FrostSource/alyxlib/wiki "Go to project documentation")
+<br />
+
+[![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")
 
 </div>
 
 ---
 
-> [!CAUTION]\
-> This repository has been made public to create the wiki and may not work as intended until this message is removed!
-
-AlyxLib provides a set of useful Lua libraries for scripting with Half-Life: Alyx, making your development process smoother and more efficient.
+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
+## 📚 Library overview
 
-* Full VScript code completion using [Lua Language Server](https://luals.github.io/)
+* 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 inheritence and automatic variable saving.
+* Custom class implementation for entities, including inheritance and automatic variable saving.
 * Player interaction simplification and tracking of items.
-* Panorama panel interaction, allowing sending and receiving data with Lua.
+* 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 extensive wiki for full function reference and code examples.
+See the [Documentation Website](https://frostsource.github.io/alyxlib/) for component breakdowns, function references, and code examples.
 
-## 🚀Quick setup guide
+## 🚀 Quick setup guide
 
-> [!NOTE]\
-> For in-depth setup, see the [Installing AlyxLib](https://github.com/FrostSource/alyxlib/wiki/Installing-AlyxLib) wiki page
+> [!NOTE]
+> For in-depth or manual setup, see the [Getting Started Guide](https://frostsource.github.io/alyxlib/getting_started/app_installation.html).
 
-1. Download or clone this GitHub repository to your hlvr_addons content folder
+1. **[Download AlyxLib Installer](https://frostsource.github.io/AlyxLibInstaller/)** and run the app.
 
-2. Run `alyxlib.py` from the root folder
+2. Follow the setup instructions within the app to download AlyxLib.
 
-3. Select your addon from the list of addons shown
+3. Open your addon from the file menu and select the AlyxLib modules you wish to use.
 
-4. Select the type of installation you want for your addon (can be changed later)
+4. **Before uploading:** Click the `Remove For Upload` button in the app.
 
-5. Before uploading to the workshop, run the `on_upload.bat` that was created in your addon content folder to temporarily remove symlinks, **but do not -exit the program**
+5. Upload your addon to the workshop and set [AlyxLib](https://steamcommunity.com/sharedfiles/filedetails/?id=3329679071) as a required item.
 
-6. 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. Rename the `0000000000.lua` file in `scripts/vscripts/mods/init/` to have the same number as 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.
 
-8. Finish the instructions shown in the running `on_upload.bat` program to restore the symlinks for further development
+## ❓ Need help?
 
-## ❓Need help?
+If you run into issues, feel free to [create an issue](https://github.com/FrostSource/alyxlib/issues).
 
-Please feel free to create an issue with your problem, question or suggestion.
+You can also join us on <img src="https://github.com/user-attachments/assets/347c331b-4105-4d13-ba90-d4dec3952c75" width="16"> [Discord](https://discord.gg/42SC3Wyjv4) for faster responses.
 
-You can also join us on our <img src="https://github.com/user-attachments/assets/347c331b-4105-4d13-ba90-d4dec3952c75" width="16"> [Discord server](https://discord.gg/42SC3Wyjv4) to get faster responses.
-
-## 🌟Projects using AlyxLib
+## 🌟 Projects using AlyxLib
 
 <p align="center">
-<a title="Body Holsters" href="https://steamcommunity.com/sharedfiles/filedetails/?id=3144612716"><img src="https://images.steamusercontent.com/ugc/2318858611175367914/A9DF9C6F4BDAD028C899210A34ECB1573674D6B7/" width="23%"></img></a>
-<a title="Resin Watch (Item Tracker)" href="https://steamcommunity.com/sharedfiles/filedetails/?id=3145397582"><img src="https://images.steamusercontent.com/ugc/44575774847459108/06988C83A5882E4D8FA70D047A2A1501D8E7AD87/" width="23%"></img></a>
-<a title="Partial Clip Storage" href="https://steamcommunity.com/sharedfiles/filedetails/?id=3329684800"><img src="https://images.steamusercontent.com/ugc/2397692528303495590/700AD9E3DD1C2984BCD4F2D588ACDD8BE2EB6EAD/" width="23%"></img></a>
-<a title="Alyx Wears Glasses" href="https://steamcommunity.com/sharedfiles/filedetails/?id=2703180455"><img src="https://images.steamusercontent.com/ugc/2397692528303482230/73852A6226202BAA79D1D7E3C88083D71F356D87/" width="23%"></img></a>
-<a title="Combine Shoot and Scoot" href="https://steamcommunity.com/sharedfiles/filedetails/?id=3426415080"><img src="https://images.steamusercontent.com/ugc/6295179234055719/14236C86CACFA0CCEF2A506B1EC6C07E980819CC/" width="23%"></img></a>
-</p>
+<a title="Body Holsters" href="https://steamcommunity.com/sharedfiles/filedetails/?id=3144612716"><img src="assets/addon-preview-body_holsters.jpg" width="23%"></a>
+<a title="Resin Watch (Item Tracker)" href="https://steamcommunity.com/sharedfiles/filedetails/?id=3145397582"><img src="assets/addon-preview-resin_watch.jpg" width="23%"></a>
+<a title="Partial Clip Storage" href="https://steamcommunity.com/sharedfiles/filedetails/?id=3329684800"><img src="assets/addon-preview-partial_clip_storage.jpg" width="23%"></a>
+<a title="Alyx Wears Glasses" href="https://steamcommunity.com/sharedfiles/filedetails/?id=2703180455"><img src="assets/addon-preview-alyx_wears_glasses.jpg" width="23%"></a>
+<a title="Combine Shoot and Scoot" href="https://steamcommunity.com/sharedfiles/filedetails/?id=3426415080"><img src="assets/addon-preview-combine_shoot_and_scoot.jpg" width="23%"></a>
+<a title="Removable Health Vials" href="https://steamcommunity.com/sharedfiles/filedetails/?id=3527754624"><img src="assets/addon-preview-removable_health_vials.jpg" width="23%"></a>
+</p>

deployment_manifest.json

@@ -82,16 +82,62 @@
 
     "panorama": [
       {
-        "type": "symlink",
-        "description": "Panorama Lua integration symlink",
+        "type": "hardlink",
+        "description": "Panorama Lua integration hardlink",
         "source": "{AlyxLib}/panorama/scripts/custom_game/panorama_lua.js",
         "destination": "{AddonContent}/panorama/scripts/custom_game/panorama_lua.js"
       },
       {
-        "type": "symlink",
-        "description": "Panorama code completion symlink",
+        "type": "hardlink",
+        "description": "Panorama code completion hardlink",
         "source": "{AlyxLib}/panorama/scripts/custom_game/panoramadoc.js",
         "destination": "{AddonContent}/panorama/scripts/custom_game/panoramadoc.js"
+      },
+      {
+        "type": "hardlink",
+        "description": "DebugMenu layout hardlink",
+        "source": "{AlyxLib}/panorama/layout/custom_game/alyxlib_debug_menu.xml",
+        "destination": "{AddonContent}/panorama/layout/custom_game/alyxlib_debug_menu.xml"
+      },
+      {
+        "type": "hardlink",
+        "description": "DebugMenu script hardlink",
+        "source": "{AlyxLib}/panorama/scripts/custom_game/alyxlib_debug_menu.js",
+        "destination": "{AddonContent}/panorama/scripts/custom_game/alyxlib_debug_menu.js"
+      },
+      {
+        "type": "hardlink",
+        "description": "DebugMenu styles hardlink",
+        "source": "{AlyxLib}/panorama/styles/custom_game/alyxlib_debug_menu.css",
+        "destination": "{AddonContent}/panorama/styles/custom_game/alyxlib_debug_menu.css"
+      }
+    ],
+
+    "upload_removal": [
+      {
+        "type": "delete",
+        "description": "Delete compiled panorama_lua.js",
+        "source": "{AddonGame}/panorama/scripts/custom_game/panorama_lua.vjs_c"
+      },
+      {
+        "type": "delete",
+        "description": "Delete compiled panoramadoc.js",
+        "source": "{AddonGame}/panorama/scripts/custom_game/panoramadoc.vjs_c"
+      },
+      {
+        "type": "delete",
+        "description": "Delete compiled alyxlib_debug_menu.xml",
+        "source": "{AddonGame}/panorama/layout/custom_game/alyxlib_debug_menu.vxml_c"
+      },
+      {
+        "type": "delete",
+        "description": "Delete compiled alyxlib_debug_menu.js",
+        "source": "{AddonGame}/panorama/scripts/custom_game/alyxlib_debug_menu.vjs_c"
+      },
+      {
+        "type": "delete",
+        "description": "Delete compiled alyxlib_debug_menu.css",
+        "source": "{AddonGame}/panorama/styles/custom_game/alyxlib_debug_menu.vcss_c"
       }
     ],