BREAKING CHANGE: support Lua scripting (#307)

* lua

* lua types

* lua types

* lua types

* lua types

* organize files

* create files

* lua types

* more lua types and an actual bug fix

* files

* finish lua types? (for now)

* metadata

* license

* nil dir

* doc

* user agent

* run examples

* user agent

* files

* bindings

* clippy

* flags

* rename fn

* lua state

* commands

* reuse `is_script`

* avoid clone

* fix eval regex

* stdout

* heterogeneous try blocks

* cheat_get_players

* cheat_get_player

* links

* `NIL_DIR` env var

* chat history

* limit size

* devtools

* rename database crate

* deps

* scripts scene

* fonts

* deps

* if let guard is now stable

* world id

* separator

* deps

* radius

* settings footer

* remove stdout

* fonts

* readme

* stdio messages

* remove helper

* terminal

* `Round::started_at`

* change order

* don't disable

* rename

* splice

* chat input

* queue chat messages

* spinner

* line class

* settings

* strum

* update tauri-store

* reactive and spinner

* spinner

* load scripts

* sort by name

* useScripts

* table

* wrap-anywhere

* https

* scripts scenes

* path

* return round

* preserve order

* tap

Author: ferreira-tb

.cargo/config.toml

@@ -4,3 +4,6 @@ rustflags = []
 
 [env]
 CARGO_TARGET_DIR = "target"
+
+# Relative to the home dir.
+NIL_DIR = ".tsukilabs/nil"

.github/CONTRIBUTING.md

@@ -13,13 +13,47 @@ To install Diesel, run:
 cargo install diesel_cli --no-default-features --features "sqlite-bundled"
 ```
 
+> [!NOTE]
+> The truth is you don’t really need to install Diesel unless you want to work with the [server database](/crates/nil-server-database).
+
 If you also want to work on the Android version, you’ll need to go through some additional steps. The [official Tauri guide](https://v2.tauri.app/start/prerequisites/#android) should help you with that.
 
+## Creating a server endpoint
+
+When you add a new endpoint, there are a few places you need to update. Right now this is entirely manual, but we might be able to automate at least part of it in the future ~~(I hope)~~. Use what already exists as a reference for how the new one should look.
+
+Here’s a simplified list of the steps you’ll need to take. In some cases, you can skip a few of them, for example, most of them won't need a response struct at all.
+
+- [`nil-payload`](/crates/nil-payload)
+  - [Create request and response structs](/crates/nil-payload/src/lib.rs)
+
+- [`nil-server`](/crates/nil-server)
+  - [Create a handler](/crates/nil-server/src/router/mod.rs)
+  - [Register it as a new route](/crates/nil-server/src/router/mod.rs)
+
+- [`nil-client`](/crates/nil-client)
+  - [Update the client](/crates/nil-client/src/client/mod.rs)
+
+- [`nil`](/app)
+  - [Create a new command (Rust)](/app/src-tauri/src/command/mod.rs)
+  - [Expose it to the frontend](/app/src-tauri/src/lib.rs)
+  - [Create a new command (TypeScript)](/app/src/commands/index.ts)
+  - [Declare an interface for the request struct](/app/src/lib/request)
+  - [Declare an interface for the response struct](/app/src/lib/response)
+
+- [`nil-lua`](/crates/nil-lua)
+  - [Expose it to Lua](/crates/nil-lua/src/client/mod.rs)
+  - [Declare Lua types](/crates/nil-lua/types)
+    - [Client](/crates/nil-lua/types/script/client/index.d.lua)
+    - [Request](/crates/nil-lua/types/request)
+    - [Response](/crates/nil-lua/types/response)
+
 ## Environment variables
 
-- `NIL_DATABASE_URL`
-- `NIL_JWT_SECRET`
-- `NIL_LOG_DIR`
-- `NIL_LOG_TOWER_HTTP`
-- `NIL_MINIFY_SOURCE`
-- `NIL_REMOTE_SERVER_ADDR`
+- [`NIL_DATABASE_URL`](/crates/nil-server/src/main.rs)
+- [`NIL_DIR`](/app/src-tauri/src/manager.rs)
+- [`NIL_JWT_SECRET`](/crates/nil-server/src/middleware/authorization.rs)
+- [`NIL_LOG_DIR`](/crates/nil-log/src/lib.rs)
+- [`NIL_LOG_TOWER_HTTP`](/crates/nil-log/src/lib.rs)
+- [`NIL_MINIFY_SOURCE`](/app/vite.config.ts)
+- [`NIL_REMOTE_SERVER_ADDR`](/crates/nil-client/src/server.rs)

.github/workflows/release.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: true
       matrix:
         include:
-          - platform: ubuntu-22.04
+          - platform: ubuntu-24.04
             args: ""
           - platform: windows-latest
             args: ""
@@ -31,7 +31,7 @@ jobs:
         uses: dtolnay/rust-toolchain@nightly
 
       - name: Install dependencies (Ubuntu)
-        if: matrix.platform == 'ubuntu-22.04'
+        if: matrix.platform == 'ubuntu-24.04'
         run: |
           sudo apt-get update
           sudo apt-get install -y libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf
@@ -62,7 +62,7 @@ jobs:
 
   release-server:
     needs: release-client
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     permissions:
       contents: write
     steps:

.taurignore

@@ -1 +1,3 @@
 **/android
+**/nil-lua/examples
+**/nil-lua/types

.vscode/settings.json

@@ -1,4 +1,7 @@
 {
+  "[lua]": {
+    "editor.defaultFormatter": "sumneko.lua"
+  },
   "[rust]": {
     "editor.defaultFormatter": "rust-lang.rust-analyzer"
   },
@@ -23,6 +26,7 @@
   },
   "files.eol": "\n",
   "githubPullRequests.defaultMergeMethod": "squash",
+  "Lua.workspace.library": ["crates/nil-lua/types"],
   "rust-analyzer.cargo.targetDir": true,
   "rust-analyzer.linkedProjects": [
     "./Cargo.toml",
@@ -31,6 +35,7 @@
     "./scripts/build-server.rs",
     "./scripts/clean.rs",
     "./scripts/run-clippy.rs",
+    "./scripts/run-example.rs",
     "./scripts/sort-namegen.rs",
     "./scripts/start-dev.rs",
     "./scripts/start-server.rs",

.zed/settings.json

@@ -14,6 +14,7 @@
           "./scripts/build-wasm.rs",
           "./scripts/clean.rs",
           "./scripts/run-clippy.rs",
+          "./scripts/run-example.rs",
           "./scripts/sort-namegen.rs",
           "./scripts/start-dev.rs",
           "./scripts/start-server.rs",