bar

.github/workflows/cross-compile.yml

@@ -0,0 +1,53 @@
+# inspired by https://github.com/Timmmm/rust_cross_compile_demo/blob/master/.github/workflows/build.yaml
+name: Cross-Compile
+
+on: [push]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    if: github.actor == 'topheman' && contains(github.event.head_commit.message, 'cross-compile-all')
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Set up MacOS Cross Compiler
+      uses: Timmmm/setup-osxcross@v2
+      with:
+        osx-version: "12.3"
+
+    - name: Install Rustup targets
+      run: rustup target add x86_64-unknown-linux-gnu x86_64-apple-darwin aarch64-apple-darwin
+
+    - name: Check out source code
+      uses: actions/checkout@v3
+
+    - name: Check
+      run: cargo check
+
+    - name: Build
+      run: cargo build --release --target x86_64-unknown-linux-gnu --target x86_64-apple-darwin --target aarch64-apple-darwin
+
+    - name: Compress
+      run: |
+        (cd target/x86_64-unknown-linux-gnu/release && tar -cvf snakepipe-x86_64-unknown-linux-gnu.tar.gz snakepipe && mv snakepipe-x86_64-unknown-linux-gnu.tar.gz ../../..)
+        (cd target/x86_64-apple-darwin/release && tar -cvf snakepipe-x86_64-apple-darwin.tar.gz snakepipe && mv snakepipe-x86_64-apple-darwin.tar.gz ../../..)
+        (cd target/aarch64-apple-darwin/release && tar -cvf snakepipe-aarch64-apple-darwin.tar.gz snakepipe && mv snakepipe-aarch64-apple-darwin.tar.gz ../../..)
+
+    - name: Calculate sha256
+      run: |
+        shasum -a 256 snakepipe-x86_64-unknown-linux-gnu.tar.gz >> sha256.txt
+        shasum -a 256 snakepipe-x86_64-apple-darwin.tar.gz >> sha256.txt
+        shasum -a 256 snakepipe-aarch64-apple-darwin.tar.gz >> sha256.txt
+
+    - name: Upload Binaries
+      uses: actions/upload-artifact@v3
+      with:
+        name: binaries
+        path: |
+          snakepipe-x86_64-unknown-linux-gnu.tar.gz
+          snakepipe-x86_64-apple-darwin.tar.gz
+          snakepipe-aarch64-apple-darwin.tar.gz
+          sha256.txt

.github/workflows/rust.yml

@@ -0,0 +1,18 @@
+name: CI
+
+on: [push, pull_request]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Build
+      run: cargo build --verbose
+    - name: Run tests
+      run: cargo test --verbose

.gitignore

@@ -1 +1,7 @@
+# rust
 /target
+render.out
+
+# nodejs
+node_modules
+dist

.nvmrc

@@ -0,0 +1 @@
+20

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "rust-lang.rust-analyzer",
+    "skellock.just"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.formatOnSave": true
+}

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing
+
+This is a rust project, but you can contribute as a rust developer as much as a JavaScript developer.
+
+## Rust
+
+You will find your way in the the source code: [`./src`](./src/).
+
+To build the project:
+
+```sh
+cargo build
+```
+
+To run:
+
+```sh
+./target/debug/snakepipe # will show the help - you can use it is explained in the README
+```
+
+## JavaScript
+
+The [`snakepipe render-browser`](./README.md#-you-can-mirror-your-playing-terminal-into-another-one-through-http) command launches a rust http server that serves some JavaScript code that connects to server-sent events and renders the game inside the browser.
+
+The source code for the renderers is available at [`static/renderers`](static/renderers).
+
+**You don't need rust to work on this part**. I made a nodejs development server that acts as the `snakepipe render-browser` command (that way, you also don't have to re-build the rust part each time you modify the frontend).
+
+### Install
+
+```sh
+npm install
+```
+
+### Setup
+
+Build the packages and retrieve a recorded party.
+
+```sh
+npm run build && npm run setup
+```
+
+### Run
+
+```sh
+npm run dev-server-sse
+```
+
+Go to [http://localhost:8080](http://localhost:8080).