sync from null0 0.0.16

Author: null0 templates

.github/workflows/publish.yml

@@ -6,6 +6,7 @@ on:
   workflow_dispatch:
 
 permissions:
+  contents: read
   pages: write
   id-token: write
 
@@ -14,23 +15,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Install WASI SDK
-        uses: konsumer/install-wasi-sdk@v1
-        with:
-          version: "25"
-      - name: Install Nelua
-        run:
-          |
-          git clone https://github.com/edubart/nelua-lang.git
-          cd nelua-lang
-          make
-          sudo make install
-      - name: Configure CMake
-        run: cmake -B build -DCMAKE_TOOLCHAIN_FILE=$WASI_SDK_PATH/share/cmake/wasi-sdk.cmake -DCMAKE_BUILD_TYPE=Release
-      - name: Build CMake
-        run: cmake --build build
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+      - name: Build cart
+        run: |
+          mkdir -p webroot
+          rm -f webroot/mygame.null0 && docker run --rm -v ./cart:/src -v ./webroot:/out ghcr.io/notnullgames/null0-cart-nelua:latest mygame
+      - uses: actions/upload-pages-artifact@v3
         with:
           path: ./webroot
 

.github/workflows/release.yml

@@ -12,21 +12,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Install WASI SDK
-        uses: konsumer/install-wasi-sdk@v1
-        with:
-          version: "25"
-      - name: Install Nelua
-        run:
-          |
-          git clone https://github.com/edubart/nelua-lang.git
-          cd nelua-lang
-          make
-          sudo make install
-      - name: Configure CMake
-        run: cmake -B build -DCMAKE_TOOLCHAIN_FILE=$WASI_SDK_PATH/share/cmake/wasi-sdk.cmake -DCMAKE_BUILD_TYPE=Release
-      - name: Build CMake
-        run: cmake --build build
-      - run: gh release upload ${{github.event.release.tag_name}} *.null0
+      - name: Build cart
+        run: |
+          mkdir -p webroot
+          rm -f webroot/mygame.null0 && docker run --rm -v ./cart:/src -v ./webroot:/out ghcr.io/notnullgames/null0-cart-nelua:latest mygame
+      - name: Attach cart to release
+        run: gh release upload ${{ github.event.release.tag_name }} webroot/mygame.null0
         env:
           GH_TOKEN: ${{ github.token }}

.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
 .vscode
-build
+
+# the cart is a build artifact
+webroot/*.null0

CMakeLists.txt

@@ -1,44 +1,55 @@
-This is a basic example cart in Nelua for the [null0](https://notnull.games/null0) game-engine.
+# mygame
 
-## usage
+A starter [null0](https://notnull.games/null0) cart, in Nelua.
 
-Carts run natively, and on the web. This repo will auto-publish to github-pages on push, so users can check out your cart without installing anything.
+Press **Use this template** to make your own, then search the project for `mygame` and rename it to whatever your game is called.
 
-They can also install [the native runtime](https://github.com/notnullgames/null0/releases) and use it to run your cart.
+## building
 
-## github
+Everything is built inside docker, so you never install nelua + wasi-sdk clang yourself. All you need is [docker](https://docs.docker.com/get-started/get-docker/), plus [node](https://nodejs.org/) for the shortcuts below.
 
-There are 2 actions:
-
-- Publish demo to github-pages - this happens on any push
-- Attach current version of your cart to any releases that are created (like [here](https://github.com/notnullgames/cart_nelua/releases/))
-
-## developing
-
-Make sure you have [wasi-sdk](https://github.com/WebAssembly/wasi-sdk/releases) installed and `WASI_SDK_PATH` set to it's location (eg `/opt/wasi-sdk`.)
+```sh
+npm start
+```
 
-Then you can do this:
+That builds `webroot/mygame.null0`, serves `webroot/`, and rebuilds whenever you edit something in `cart/`. To build once, without the server:
 
 ```sh
-nelua --cflags="-I ." -L . "src/main.nelua" -r --cc "$WASI_SDK_PATH/bin/clang" -o src/main.wasm
-cd src
-zip -r ../webroot/mygame.null0 . -x '*.nelua' '.DS_Store'
+npm run build
 ```
 
-You can also use cmake (recommended) to build a complete cart:
+Or call docker yourself:
 
 ```sh
-cmake -B build -DCMAKE_TOOLCHAIN_FILE="${WASI_SDK_PATH}/share/cmake/wasi-sdk.cmake" -DCMAKE_BUILD_TYPE=Release
-cmake --build build
+rm -f webroot/mygame.null0
+docker run --rm --user $(id -u):$(id -g) -v ./cart:/src -v ./webroot:/out ghcr.io/notnullgames/null0-cart-nelua:latest mygame
 ```
 
-You will find your cart in `webroot/mygame.null0`
+## writing your game
 
-If you have node installed, you can also get a nice watching-webseerver, locally:
+Your code is in `cart/main.nelua`. A cart implements the callbacks it cares about and the host skips the rest:
 
+```lua
+local function load() <cexport'load'> end
 ```
-npm start
-```
 
-After this, create a github-release, and your cart will show up on releases (like [here](https://github.com/notnullgames/cart_nelua/releases/)).
+### Nelua notes
+
+- `require 'null0'`. Nelua compiles to C, so it needs null0.h alongside null0.nelua.
+
+You do not need to copy any null0 bindings into this project - the docker image bakes the current [`carts/nelua/null0.nelua`](https://raw.githubusercontent.com/notnullgames/null0/main/carts/nelua/null0.nelua) in for you.
+
+## docs
+
+- [Nelua carts](https://notnull.games/null0/languages/nelua) - the whole API, in Nelua
+- [Anatomy of a cart](https://notnull.games/null0/cart) - callbacks, input, distribution
+- [API reference](https://notnull.games/null0/api)
+
+## publishing
+
+Two workflows come with this template:
+
+- **Publish** builds the cart and deploys `webroot/` to github-pages on every push to `main`, so anyone can play your game in a browser without installing anything.
+- **Release** attaches `mygame.null0` to any github release you create.
 
+Players who want it natively can grab [the runtime](https://github.com/notnullgames/null0/releases) and run `null0 mygame.null0`.

README.md

@@ -0,0 +1,18 @@
+require 'null0'
+
+local function load() <cexport'load'>
+  clear(BLUE)
+  draw_circle(100, 100, 50, RED)
+end
+
+-- callbacks (optional - implement as needed)
+
+-- local function update() <cexport'update'> end
+-- local function unload() <cexport'unload'> end
+-- local function buttonUp(button: GamepadButton, player: uint32) <cexport'buttonUp'> end
+-- local function buttonDown(button: GamepadButton, player: uint32) <cexport'buttonDown'> end
+-- local function keyUp(key: Key) <cexport'keyUp'> end
+-- local function keyDown(key: Key) <cexport'keyDown'> end
+-- local function mouseDown(button: MouseButton) <cexport'mouseDown'> end
+-- local function mouseUp(button: MouseButton) <cexport'mouseUp'> end
+-- local function mouseMoved(x: float32, y: float32) <cexport'mouseMoved'> end