Release instructions

.editorconfig

@@ -0,0 +1,6 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.github/workflows/build.yml

@@ -0,0 +1,30 @@
+name: Build
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest,  windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Checkout submodules
+        shell: bash
+        run: |
+          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+          git submodule sync --recursive
+          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+      - name: Install Raylib deps
+        if: runner.os == 'Linux'
+        run: sudo apt-get install libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev -y
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+      - uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --release --all-features

.vscode/extensions.json

@@ -0,0 +1,13 @@
+{
+    "recommendations": [
+        "editorconfig.editorconfig",
+        "matklad.rust-analyzer",
+        "serayuzgur.crates",
+        "bungcip.better-toml",
+        "aaron-bond.better-comments",
+        "streetsidesoftware.code-spell-checker",
+        "codezombiech.gitignore",
+        "ionutvmi.path-autocomplete",
+        "ms-vsliveshare.vsliveshare"
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,23 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "cargo",
+			"command": "build",
+			"problemMatcher": [
+				"$rustc"
+			],
+			"group": "build",
+			"label": "Rust: Build Code"
+		},
+		{
+			"type": "cargo",
+			"command": "run",
+			"problemMatcher": [
+				"$rustc"
+			],
+			"group": "build",
+			"label": "Rust: Run Game"
+		}
+	]
+}

Cross.toml

@@ -0,0 +1,2 @@
+[target.x86_64-unknown-linux-gnu]
+image = "ldjam_49_x86_64_unknown_linux_gnu_build_env"

README.md

@@ -4,7 +4,26 @@
 
 - `game`: Contains the game code and assets
   - `src`: Rust code
-    - `lib.rs`: The game's main file
+    - [`lib.rs`](game/src/lib.rs): The game's main file
   - `assets`: Any files to be embedded directly into the final game executable (managed by [`game::utilities::datastore::StaticGameData`](game/src/utilities/datastore.rs) using the [`rust-embed`](https://github.com/pyros2097/rust-embed) library)
   - `Cargo.toml`: The game's dependencies
-- `wrapper`: This is just a small hack to improve the compile times of the game. Don't mess with anything in here
+- `wrapper`: This is just a small hack to improve the compile times of the game. Don't mess with anything in here
+
+## Building for release
+
+These steps should only be followed by whoever is building the final game executables for release. This is *not needed* for development.
+
+Firstly, ensure the docker images are built:
+
+```sh
+docker build -t ldjam_49_x86_64_unknown_linux_gnu_build_env -f ./bundle/docker/x86_64-unknown-linux-gnu.dockerfile .
+```
+
+Then, build in release mode for targeted platforms:
+
+```sh
+cross build --release --target x86_64-unknown-linux-gnu
+cross build --release --target x86_64-pc-windows-gnu
+```
+
+The resulting binaries will be in the `target` directory. Make sure to rename the executables before release.

bundle/docker/x86_64-unknown-linux-gnu.dockerfile

@@ -0,0 +1,4 @@
+FROM rustembedded/cross:x86_64-unknown-linux-gnu-0.2.1
+
+RUN apt-get update -y
+RUN apt-get install libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev -y

game/Cargo.toml

@@ -7,7 +7,7 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [dependencies]
 cgmath = "0.18"
-discord-sdk = "0.1"
+discord-sdk = { version = "0.1.4", git = "https://github.com/EmbarkStudios/discord-sdk", branch = "main", commit = "3ed27a06c71d88269c7ac29cf5151cfb7f24f0ef" }
 tokio = { version = "1.0", features = ["macros"] }
 tracing = { version = "0.1", features = ["log"] }
 serde = { version = "1.0.126", features = ["derive"] }
@@ -19,6 +19,9 @@ raylib = "3.5"
 puffin = "0.9"
 puffin_http = "0.6"
 
+[dev-dependencies]
+puffin_viewer = "0.6"
+
 [profile.release]
 lto = true
 codegen-units = 1

rust-toolchain.toml

@@ -5,4 +5,6 @@
 # to the user in the error, instead of "error: invalid channel name '[toolchain]'".
 
 [toolchain]
-channel = "beta"
+# Make sure to check the build status before changing this
+# https://rust-lang.github.io/rustup-components-history/
+channel = "nightly-2021-09-25"