Lua 👀

.github/workflows/lua-build.yml

@@ -0,0 +1,133 @@
+name: lua-build
+
+on:
+  workflow_dispatch:
+    inputs:
+      push:
+        default: true
+        type: boolean
+        description: "Push built dynamic libraries"
+  workflow_call:
+    inputs:
+      push:
+        default: true
+        type: boolean
+        description: "Push built dynamic libraries"
+permissions:
+  contents: write
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  LUA_SOURCE_DIR: ${{ github.workspace }}/src/kOS/Lua/lua
+  LUA_BUILD_DIR: ${{ github.workspace }}/src/kOS/Lua/lua/_build
+  LUA_OUTPUT_DIR: ${{ github.workspace }}/src/kOS/Lua/include
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: 'true'
+
+      - name: Set vars
+        id: vars
+        run: |
+          if [ "$RUNNER_OS" == "Linux" ]; then
+            echo 'LUA_LIB_NAME=liblua54.so" >> "$GITHUB_OUTPUT'
+            echo 'LUA_LIB_PATH=$LUA_BUILD_DIR/lib64/liblua54.so' >> "$GITHUB_OUTPUT"
+            echo 'LUA_LUAROCKS_LIB_PATH=/usr/local/lib/lua/5.4' >> "$GITHUB_OUTPUT"
+          elif [ "$RUNNER_OS" == "Windows" ]; then
+            echo 'LUA_LIB_NAME=lua54.dll" >> "$GITHUB_OUTPUT'
+            echo 'LUA_LIB_PATH=$LUA_BUILD_DIR/bin/lua54.dll' >> "$GITHUB_OUTPUT"
+            echo 'LUA_LUAROCKS_LIB_PATH=~/.luarocks/lib/lua/5.4' >> "$GITHUB_OUTPUT"
+          elif [ "$RUNNER_OS" == "macOS" ]; then
+            echo 'LUA_LIB_NAME=liblua54.dylib" >> "$GITHUB_OUTPUT'
+            echo 'LUA_LIB_PATH=$LUA_BUILD_DIR/lib64/liblua54.dylib' >> "$GITHUB_OUTPUT"
+            echo 'LUA_LUAROCKS_LIB_PATH=/usr/local/lib/lua/5.4' >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Configure CMake
+        run: cmake -S $LUA_SOURCE_DIR -B $LUA_BUILD_DIR
+
+      - name: Build
+        run: cmake --build $LUA_BUILD_DIR --config Release
+
+      - name: Test
+        working-directory: ${{ env.LUA_BUILD_DIR }}
+        run: ctest --build-config Release
+
+      - name: Install LuaRocks
+        run: |
+          mv $LUA_BUILD_DIR/bin64 $LUA_BUILD_DIR/bin # luarocks gets lost if lua binary is not in "bin" directory
+          if [ "$RUNNER_OS" == "Windows" ]; then
+            curl http://luarocks.github.io/luarocks/releases/luarocks-3.11.1-windows-64.zip --output luarocks.zip
+            unzip luarocks.zip -d ~/luarocks
+            mv ~/luarocks/luarocks-3.11.1-windows-64/* ~/luarocks
+            rm -rf ~/luarocks/luarocks-3.11.1-windows-64
+          else
+            wget https://luarocks.org/releases/luarocks-3.11.1.tar.gz
+            tar zxpf luarocks-3.11.1.tar.gz
+            cd luarocks-3.11.1
+            ./configure --with-lua-bin="$LUA_BUILD_DIR/bin"
+            make && sudo make install
+          fi
+
+      - name: Install modules
+        run: |
+          if [ "$RUNNER_OS" == "Windows" ]; then
+            PATH=~/luarocks:$LUA_BUILD_DIR/bin:$PATH
+            luarocks install lua-cjson 2.1.0.10-1
+          else
+            sudo luarocks install lua-cjson 2.1.0.10-1
+          fi
+
+      - name: Create artifact
+        run: |
+          rm -rf artifact
+          mkdir artifact
+          cp ${{ steps.vars.outputs.LUA_LIB_PATH }} artifact/${{ steps.vars.outputs.LUA_LIB_NAME }}
+          mkdir artifact/LuaModules artifact/LuaModules/${{ runner.os }}
+          cp -r ${{ steps.vars.outputs.LUA_LUAROCKS_LIB_PATH }}/. artifact/LuaModules/${{ runner.os }}
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ runner.os }}
+          if-no-files-found: error
+          retention-days: 7
+          path: ${{ github.workspace }}/artifact
+
+  push:
+    runs-on: ubuntu-latest
+    needs: build
+    if: inputs.push
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: 'true'
+
+      - name: Clear output directory
+        run: rm -rf $LUA_OUTPUT_DIR
+
+      - uses: actions/download-artifact@v4
+        with:
+          merge-multiple: 'true'
+          path: ${{ env.LUA_OUTPUT_DIR }}
+
+      - name: Push
+        env:
+          GIT_COMMITTER_NAME: lua-build automation
+          GIT_AUTHOR_NAME: lua-build automation
+          GIT_COMMITTER_EMAIL: noreply@github.com
+          GIT_AUTHOR_EMAIL: noreply@github.com
+        run: |
+          git add $LUA_OUTPUT_DIR
+          git commit -am "Build lua"
+          git push

.gitignore

@@ -22,6 +22,9 @@ packages/
 # VisualStudio Code
 .vscode/
 
+# Rider
+.idea/
+
 # Vim
 *.swp
 
@@ -35,10 +38,13 @@ packages/
 [Rr]esources/GameData/kOS/Plugins/
 [Rr]esources/*.dll
 [Rr]esources/GameData/*.dll
+[Rr]esources/GameData/kOS/Parts/@thumbs/
+[Rr]esources/GameData/kOS/PluginData/LuaModules/
 !Resources/GameData/kOS/ICSharpCode.SharpZipLib.dll
 
 # Symlink to KSP directory
 KSPdirlink
+KSP
 
 # OS Specific
 .DS_STORE*
@@ -53,3 +59,5 @@ netkan.exe
 
 # .swp files from vim (temporary files that vim creates when editing a file)
 *.swp
+
+!Resources/GameData/kOS/PluginData/LuaLSAddon/library/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "src/kOS/Lua/lua"]
+	path = src/kOS/Lua/lua
+	url = git@github.com:sug44/lua.git

Resources/GameData/kOS/PluginData/LuaLSAddon/.luarc.json

@@ -0,0 +1,9 @@
+{
+    "diagnostics.disable": ["lowercase-global"],
+    "workspace.library": [
+        "../../GameData/kOS/PluginData/LuaLSAddon/library",
+        "../../GameData/kOS/PluginData/LuaModules"
+    ],
+    "runtime.plugin": "../../GameData/kOS/PluginData/LuaLSAddon/plugin/patcher.lua",
+    "runtime.special": { "_G": "_G" }
+}

Resources/GameData/kOS/PluginData/LuaLSAddon/README.md

@@ -0,0 +1,13 @@
+This is an addon for [lua language server](https://github.com/luals/lua-language-server).
+It includes:
+- Patcher plugin that adds support for the arrow function syntax
+- Annotations for kOS structures, functions and bound variables
+
+### Setup for VSCode
+1. Install the lua language server extension made by sumneko.
+2. Copy the `.luarc.json` file to the archive at `*KSP_Folder*/Ships/Script/.luarc.json`.
+3. Open the folder with VSCode and you will be asked by the patcher plugin to patch lua language server.
+4. Read the message and press "Ok".
+5. Restart VSCode.
+
+After setup you should have the syntax support and annotations available.

Resources/GameData/kOS/PluginData/LuaLSAddon/library/base.lua

@@ -0,0 +1,14 @@
+---Function that gets called by kOS each physics tick.
+---@type function | nil
+fixedupdate = nil
+
+---Function that gets called by kOS each frame.
+---@type function | nil
+update = nil
+
+---Function that gets called by kOS when `Ctrl+C` is pressed.
+---If `Ctrl+C` was pressed 3 times while the command code was deprived of instructions by the `fixedupdate` function
+---it will be set to `nil` to prevent the core from geting stuck.
+---To prevent it from happening this function must ensure the terminal is not deprived of instructions.
+---@type function | nil
+breakexecution = nil