[NAK_CVR_Mods] Update mod list in README

.github/scripts/update-modlist.js

@@ -15,6 +15,37 @@ function getModFolders(baseDir) {
     .filter(dir => fs.existsSync(path.join(dir, 'README.md')));
 }
 
+function extractDescription(readmePath) {
+  try {
+    const content = fs.readFileSync(readmePath, 'utf8');
+    const lines = content.split('\n');
+    
+    // Find the first header (# something)
+    let headerIndex = -1;
+    for (let i = 0; i < lines.length; i++) {
+      if (lines[i].trim().startsWith('# ')) {
+        headerIndex = i;
+        break;
+      }
+    }
+    
+    // If we found a header, look for the first non-empty line after it
+    if (headerIndex !== -1) {
+      for (let i = headerIndex + 1; i < lines.length; i++) {
+        const line = lines[i].trim();
+        if (line && !line.startsWith('#')) {
+          return line;
+        }
+      }
+    }
+    
+    return 'No description available';
+  } catch (error) {
+    console.error(`Error reading ${readmePath}:`, error);
+    return 'No description available';
+  }
+}
+
 function formatTable(mods, baseDir) {
   if (mods.length === 0) return '';
 
@@ -22,14 +53,17 @@ function formatTable(mods, baseDir) {
     const modName = path.basename(modPath);
     const readmeLink = path.join(modPath, 'README.md');
     const zipLink = path.join(modPath, `${modName}.zip`);
-    return `| [${modName}](${readmeLink}) | [Download](${zipLink}) |`;
+    const readmePath = path.join(modPath, 'README.md');
+    const description = extractDescription(readmePath);
+    
+    return `| [${modName}](${readmeLink}) | ${description} | [Download](${zipLink}) |`;
   });
 
   return [
     `### ${baseDir === EXPERIMENTAL ? 'Experimental Mods' : 'Released Mods'}`,
     '',
-    '| Name | Download |',
-    '|------|----------|',
+    '| Name | Description | Download |',
+    '|------|-------------|----------|',
     ...rows,
     ''
   ].join('\n');

.github/workflows/update-modlist.yml

@@ -3,7 +3,7 @@ name: Update Mod List
 on:
   push:
     paths:
-      - 'update-modlist.js'
+      - '.github/scripts/update-modlist.js'
       - '.github/workflows/update-modlist.yml'
       - 'README.md'
       - '**/README.md'
@@ -23,7 +23,7 @@ jobs:
           node-version: '20'
 
       - name: Run mod list updater
-        run: node update-modlist.js
+        run: node .github/scripts/update-modlist.js
 
       - name: Commit and push changes
         run: |
@@ -32,4 +32,4 @@ jobs:
           git remote set-url origin https://x-access-token:${{ secrets.GH_TOKEN }}@github.com/${{ github.repository }}
           git add README.md
           git commit -m "[NAK_CVR_Mods] Update mod list in README" || echo "No changes to commit"
-          git push
+          git push

README.md

@@ -2,42 +2,34 @@
 
 <!-- BEGIN MOD LIST -->
 
-## Released Mods
+### Released Mods
 
-| Mod Name                     | README                                                 | Download                                                                                            | Description                                                        |
-|------------------------------|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
-| AASDefaultProfileFix         | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/AASDefaultProfileFix) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/AASDefaultProfileFix.dll)               | Fixes the Default AAS profile not being applied.                   |
-| ASTExtension                 | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/ASTExtension) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/ASTExtension.dll)                         | Avatar scaling gesture & persistance on existing avatars.          |
-| AvatarQueueSystemTweaks       | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/AvatarQueueSystemTweaks) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/AvatarQueueSystemTweaks.dll)             | Tweaks to improve the avatar queuing system.                       |
-| ChatBoxExtensions            | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/ChatBoxExtensions) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/ChatBoxExtensions.dll)                    | Adds some chat commands to the ChatBox mod.                        |
-| CustomSpawnPoint             | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/CustomSpawnPoint) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/CustomSpawnPoint.dll)                     | Allows setting custom spawn points in worlds.                      |
-| CVRGizmos                    | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/CVRGizmos) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/CVRGizmos.dll)                           | Adds runtime gizmos to common CCK components.                      |
-| DropPropTweak                | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/DropPropTweak) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/DropPropTweak.dll)                       | Allows you to drop props in the air.                               |
-| FOVAdjustment                | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/FOVAdjustment) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/FOVAdjustment.dll)                    | Makes CVR_DesktopCameraController default FOV configurable.        |
-| HeadLookLockingInputFix       | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/HeadLookLockingInputFix) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/HeadLookLockingInputFix.dll)             | Fixes head look locking input issues.                              |
-| IKAdjustments                | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/IKAdjustments) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/IKAdjustments.dll)                       | Allows grabbing IK points for manual adjustment.                   |
-| IKSimulatedRootAngleFix      | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/IKSimulatedRootAngleFix) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/IKSimulatedRootAngleFix.dll)            | Fixes Desktop & HalfBody root angle issues.                        |
-| KeepVelocityOnExitFlight     | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/KeepVelocityOnExitFlight) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/KeepVelocityOnExitFlight.dll)           | Keeps the player's velocity when exiting flight mode.              |
-| LazyPrune                    | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/LazyPrune) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/LazyPrune.dll)                           | Prevents loaded objects from immediately unloading.                |
-| LuaTTS                       | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/LuaTTS) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/LuaTTS.dll)                              | Adds Text-to-Speech (TTS) functionality through Lua.               |
-| MoreMenuOptions              | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/MoreMenuOptions) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/MoreMenuOptions.dll)                    | Exposes some menu placement configuration options.                 |
-| MuteSFX                      | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/MuteSFX) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/MuteSFX.dll)                             | Adds an audio cue for muting and unmuting.                         |
-| OriginShift                  | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/OriginShift) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/OriginShift.dll)                         | Shifts the world origin to avoid precision issues.                 |
-| PathCamDisabler              | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/PathCamDisabler) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/PathCamDisabler.dll)               | Adds option to disable the Path Camera Controller keybinds.        |
-| PortableCameraAdditions      | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/PortableCameraAdditions) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/PortableCameraAdditions.dll) | Adds a few basic settings to the Portable Camera.                  |
-| PropLoadingHexagon           | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/PropLoadingHexagon) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/PropLoadingHexagon.dll)                 | Adds a hexagon indicator to downloading props.                     |
-| PropUndoButton               | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/PropUndoButton) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/PropUndoButton.dll)                 | CTRL+Z to undo latest spawned prop.                                |
-| ReconnectionSystemFix        | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/ReconnectionSystemFix) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/ReconnectionSystemFix.dll)              | Prevents recreating and reloading all remote players.              |
-| RelativeSync                 | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/RelativeSync) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/RelativeSync.dll)                       | Relative sync for Movement Parent & Chairs.                        |
-| ScrollFlight                 | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/ScrollFlight) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/ScrollFlight.dll)                        | Scroll-wheel to adjust flight speed in Desktop.                    |
-| ShadowCloneFallback          | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/ShadowCloneFallback) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/ShadowCloneFallback.dll)               | Exposes a toggle for the Fallback Shadow Clone.                    |
-| SmartReticle                 | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/SmartReticle) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/SmartReticle.dll)                         | Makes the reticle only appear when hovering interactables.         |
-| Stickers                     | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/Stickers) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/Stickers.dll)                             | Allows you to place small images on any surface.                   |
-| StopClosingMyMenuOnWorldLoad | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/StopClosingMyMenuOnWorldLoad)| [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/StopClosingMyMenuOnWorldLoad.dll)   | Prevents your menu from being closed when a world is loaded.       |
-| SwitchToDesktopOnSteamVRExit | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/SwitchToDesktopOnSteamVRExit)| [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/SwitchToDesktopOnSteamVRExit.dll)   | Initiates a VR Switch to Desktop when SteamVR is exited.           |
-| ThirdPerson                  | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/ThirdPerson) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/ThirdPerson.dll)                       | Allows you to go into third person view.                           |
-| VisualCloneFix               | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/VisualCloneFix) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/VisualCloneFix.dll)                      | Fixes the Visual Clone system.                                     |
-| WhereAmIPointing              | [README](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/tree/main/WhereAmIPointing) | [Download](https://github.com/NotAKidOnSteam/NAK_CVR_Mods/releases/latest/download/WhereAmIPointing.dll)                    | Makes your controller rays always visible when the menus are open. |
+| Name | Description | Download |
+|------|-------------|----------|
+| [ASTExtension](ASTExtension/README.md) | Extension mod for [Avatar Scale Tool](https://github.com/NotAKidoS/AvatarScaleTool): | [Download](ASTExtension/ASTExtension.zip) |
+| [AvatarQueueSystemTweaks](AvatarQueueSystemTweaks/README.md) | Small tweaks to the Avatar Queue System. | [Download](AvatarQueueSystemTweaks/AvatarQueueSystemTweaks.zip) |
+| [CustomRichPresence](CustomRichPresence/README.md) | Gives the Drop Prop button more utility by allowing you to drop props in the air. | [Download](CustomRichPresence/CustomRichPresence.zip) |
+| [CustomSpawnPoint](CustomSpawnPoint/README.md) | Replaces the unused Images button in the World Details page with a button to set a custom spawn point. | [Download](CustomSpawnPoint/CustomSpawnPoint.zip) |
+| [FuckToes](FuckToes/README.md) | Prevents VRIK from autodetecting toes in HalfbodyIK. | [Download](FuckToes/FuckToes.zip) |
+| [KeepVelocityOnExitFlight](KeepVelocityOnExitFlight/README.md) | Keeps the player's velocity when exiting flight mode. Makes it possible to fling yourself like in Garry's Mod. | [Download](KeepVelocityOnExitFlight/KeepVelocityOnExitFlight.zip) |
+| [LazyPrune](LazyPrune/README.md) | Prevents loaded objects from immediately unloading on destruction. Should prevent needlessly unloading & reloading all avatars/props on world rejoin or GS reconnection. | [Download](LazyPrune/LazyPrune.zip) |
+| [PropLoadingHexagon](PropLoadingHexagon/README.md) | https://github.com/NotAKidoS/NAK_CVR_Mods/assets/37721153/a892c765-71c1-47f3-a781-bdb9b60ba117 | [Download](PropLoadingHexagon/PropLoadingHexagon.zip) |
+| [RCCVirtualSteeringWheel](RCCVirtualSteeringWheel/README.md) | Allows you to physically grab rigged RCC steering wheels in VR to provide steering input. No explicit setup required other than defining the Steering Wheel transform within the RCC component. | [Download](RCCVirtualSteeringWheel/RCCVirtualSteeringWheel.zip) |
+| [RelativeSync](RelativeSync/README.md) | Relative sync for Movement Parent & Chairs. Requires both users to have the mod installed. Synced over Mod Network. | [Download](RelativeSync/RelativeSync.zip) |
+| [ShareBubbles](ShareBubbles/README.md) | Share Bubbles! Allows you to drop down bubbles containing Avatars & Props. Requires both users to have the mod installed. Synced over Mod Network. | [Download](ShareBubbles/ShareBubbles.zip) |
+| [SmootherRay](SmootherRay/README.md) | Smoothes your controller while the raycast lines are visible. | [Download](SmootherRay/SmootherRay.zip) |
+| [Stickers](Stickers/README.md) | Stickers! Allows you to place small images on any surface. Requires both users to have the mod installed. Synced over Mod Network. | [Download](Stickers/Stickers.zip) |
+| [ThirdPerson](ThirdPerson/README.md) | Original repo: https://github.com/oestradiol/CVR-Mods | [Download](ThirdPerson/ThirdPerson.zip) |
+
+### Experimental Mods
+
+| Name | Description | Download |
+|------|-------------|----------|
+| [CVRLuaToolsExtension](.Experimental/CVRLuaToolsExtension/README.md) | Extension mod for [CVRLuaTools](https://github.com/NotAKidoS/CVRLuaTools) Hot Reload functionality. | [Download](.Experimental/CVRLuaToolsExtension/CVRLuaToolsExtension.zip) |
+| [LuaNetworkVariables](.Experimental/LuaNetworkVariables/README.md) | Simple mod that makes your controller rays always visible when the menus are open. Useful for when you're trying to aim at something in the distance. Also visualizes which ray is being used for menu interaction. | [Download](.Experimental/LuaNetworkVariables/LuaNetworkVariables.zip) |
+| [LuaTTS](.Experimental/LuaTTS/README.md) | Provides access to the built-in text-to-speech (TTS) functionality to lua scripts. Allows you to make the local player speak. | [Download](.Experimental/LuaTTS/LuaTTS.zip) |
+| [OriginShift](.Experimental/OriginShift/README.md) | Experimental mod that allows world origin to be shifted to prevent floating point precision issues. | [Download](.Experimental/OriginShift/OriginShift.zip) |
+| [ScriptingSpoofer](.Experimental/ScriptingSpoofer/README.md) | Prevents **local** scripts from accessing your Username or UserID by spoofing them with random values each session. | [Download](.Experimental/ScriptingSpoofer/ScriptingSpoofer.zip) |
 
 <!-- END MOD LIST -->