Animations and sprites (#25)

Adds more sprites, changed sprites, and animations.

Adds the physics system to the game.

Author: nwesterhausen

.github/workflows/release.yml

@@ -36,7 +36,7 @@ jobs:
   #       with:
   #         egress-policy: audit
   #     - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
-  #     - uses: dtolnay/rust-toolchain@78c6b5541adb5849f5d72d15da722aedb26327ca # stable
+  #     - uses: dtolnay/rust-toolchain@be73d7920c329f220ce78e0234b8f96b7ae60248 # master
   #       with:
   #         targets: wasm32-unknown-unknown
   #         toolchain: ${{ env.nightly_toolchain }}
@@ -89,7 +89,7 @@ jobs:
         with:
           egress-policy: audit
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
-      - uses: dtolnay/rust-toolchain@78c6b5541adb5849f5d72d15da722aedb26327ca # stable
+      - uses: dtolnay/rust-toolchain@be73d7920c329f220ce78e0234b8f96b7ae60248 # master
         with:
           targets: x86_64-unknown-linux-gnu
           toolchain: ${{ env.nightly_toolchain }}
@@ -142,7 +142,7 @@ jobs:
         with:
           egress-policy: audit
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
-      - uses: dtolnay/rust-toolchain@78c6b5541adb5849f5d72d15da722aedb26327ca # stable
+      - uses: dtolnay/rust-toolchain@be73d7920c329f220ce78e0234b8f96b7ae60248 # master
         with:
           targets: x86_64-pc-windows-msvc
           toolchain: ${{ env.nightly_toolchain }}
@@ -179,8 +179,8 @@ jobs:
           tag: ${{ github.ref }}
           overwrite: true
 
-  # Build for MacOS x86_64
-  release-macOS-intel:
+  # Build for MacOS x86_64 and aaarch64
+  release-macOS:
     runs-on: macOS-latest
     # To upload artifacts, contents write permission is required
     permissions:
@@ -191,98 +191,55 @@ jobs:
         with:
           egress-policy: audit
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
-      - uses: dtolnay/rust-toolchain@78c6b5541adb5849f5d72d15da722aedb26327ca # stable
+      - uses: dtolnay/rust-toolchain@be73d7920c329f220ce78e0234b8f96b7ae60248 # master
         with:
-          targets: x86_64-apple-darwin
+          targets: x86_64-apple-darwin, aaarch64-apple-darwin
           toolchain: ${{ env.nightly_toolchain }}
       - name: Environment Setup
         run: |
           export CFLAGS="-fno-stack-check"
           export MACOSX_DEPLOYMENT_TARGET="10.9"
 
-      - name: Build
+      - name: Install Dependencies
         run: |
           brew install llvm
-          cargo build --release --target x86_64-apple-darwin
+          ln -s /opt/homebrew/opt /usr/local/opt
+      - name: Build
+        run: |
+          cargo build --release --target x86_64-apple-darwin # Intel
+          cargo build --release --target aaarch64-apple-darwin # Apple Silicon
 
       - name: Prepare Package
         run: |
           mkdir -p ${{ env.binary }}.app/Contents/MacOS
-          cp target/x86_64-apple-darwin/release/${{ env.binary }} ${{ env.binary }}.app/Contents/MacOS/
-          cp -r game/assets ${{ env.binary }}.app/Contents/MacOS/
-          cp -r game_data ${{ env.binary }}.app/Contents/MacOS/
-          hdiutil create -fs HFS+ -volname "${{ env.binary }}" -srcfolder ${{ env.binary }}.app ${{ env.binary }}-macOS-intel.dmg
+          mkdir -p ${{ env.binary }}.app/Contents/Resources
 
-      - name: Upload binaries to artifacts
-        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4
-        with:
-          path: ${{ env.binary }}-macOS-intel.dmg
-          name: macOS-intel
-          retention-days: 1
+          cp game_assets/Info.plist ${{ env.binary }}.app/Contents/
+          cp game_assets/Icon/icon.icns ${{ env.binary }}.app/Contents/Resources/
 
-      - name: Upload binaries to release
-        if: ${{ env.add_binaries_to_github_release == 'true' }}
-        uses: svenstaro/upload-release-action@1beeb572c19a9242f4361f4cee78f8e0d9aec5df # v2
-        with:
-          repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: ${{ env.binary }}-macOS-intel.dmg
-          asset_name: ${{ env.binary }}-macOS-intel-${{ env.tag_name }}.dmg
-          tag: ${{ github.ref }}
-          overwrite: true
-
-  # Build for MacOS Apple Silicon
-  release-macOS-apple-silicon:
-    runs-on: macOS-latest
-    # To upload artifacts, contents write permission is required
-    permissions:
-      contents: write
-    env:
-      # macOS 11 was the first version to support ARM
-      MACOSX_DEPLOYMENT_TARGET: 11
-    steps:
-      - uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
-        with:
-          egress-policy: audit
-      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
-      - uses: dtolnay/rust-toolchain@78c6b5541adb5849f5d72d15da722aedb26327ca # stable
-        with:
-          targets: aarch64-apple-darwin
-          toolchain: ${{ env.nightly_toolchain }}
-      - name: Setup LLVM
-        run: |
-          # seems to be we need to install LLVM via brew.
-          brew install llvm
-          # Brew suggests a couple other exports during the LLVM install
-          export PATH="/opt/homebrew/opt/llvm/bin:$PATH"
-          export LDFLAGS="-L/opt/homebrew/opt/llvm/lib"
-          export CPPFLAGS="-I/opt/homebrew/opt/llvm/include"
-      - name: Build
-        run: |
-          # This fails the final linking step with error:
-          # "note: clang: error: invalid linker name in argument '-fuse-ld=/opt/homebrew/opt/llvm/bin/ld64.lld'"
-          cargo build --release --target aarch64-apple-darwin
-      - name: Prepare Package
-        run: |
-          mkdir -p ${{ env.binary }}.app/Contents/MacOS
-          cp target/aarch64-apple-darwin/release/${{ env.binary }} ${{ env.binary }}.app/Contents/MacOS/
           cp -r game/assets ${{ env.binary }}.app/Contents/MacOS/
           cp -r game_data ${{ env.binary }}.app/Contents/MacOS/
-          hdiutil create -fs HFS+ -volname "${{ env.binary }}-macOS-apple-silicon" -srcfolder ${{ env.binary }}.app ${{ env.binary }}-macOS-apple-silicon.dmg
+
+          lipo "target/x86_64-apple-darwin/release/${{ env.binary }}" \
+            "target/aaarch64-apple-darwin/release/${{ env.binary }}" \
+            -create -output ${{ env.binary }}.app/Contents/MacOS/${{ env.binary }}
+
+          hdiutil create -fs HFS+ -volname "${{ env.binary }}" -srcfolder ${{ env.binary }}.app ${{ env.binary }}-macOS.dmg
 
       - name: Upload binaries to artifacts
         uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4
         with:
-          path: ${{ env.binary }}-macOS-apple-silicon.dmg
-          name: macOS-apple-silicon
+          path: ${{ env.binary }}-macOS.dmg
+          name: macOS-intel
           retention-days: 1
 
       - name: Upload binaries to release
         if: ${{ env.add_binaries_to_github_release == 'true' }}
         uses: svenstaro/upload-release-action@1beeb572c19a9242f4361f4cee78f8e0d9aec5df # v2
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: ${{ env.binary }}-macOS-apple-silicon.dmg
-          asset_name: ${{ env.binary }}-macOS-apple-silicon-${{ env.tag_name }}.dmg
+          file: ${{ env.binary }}-macOS.dmg
+          asset_name: ${{ env.binary }}-macOS-intel-${{ env.tag_name }}.dmg
           tag: ${{ github.ref }}
           overwrite: true
 
@@ -307,8 +264,7 @@ jobs:
       # - release-wasm
       - release-linux
       - release-windows
-      - release-macOS-intel
-      - release-macOS-apple-silicon
+      - release-macOS
     if: ${{ needs.check-if-upload-to-itch-is-configured.outputs.should-upload == 'yes' }}
 
     steps:

Cargo.lock

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleDisplayName</key>
+	<string>Elementalist</string>
+	<key>CFBundleExecutable</key>
+	<string>elementalist</string>
+	<key>CFBundleIconFile</key>
+	<string>icon.icns</string>
+	<key>CFBundleIdentifier</key>
+	<string>one.nwest.elementalist</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>MyGame</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>0.5.0</string>
+	<key>LSApplicationCategoryType</key>
+	<string>public.app-category.games</string>
+	<key>LSMinimumSystemVersion</key>
+	<string>10.9</string>
+	<key>CFBundleSupportedPlatforms</key>
+	<array>
+		<string>MacOSX</string>
+	</array>
+</dict>
+</plist>

elementalist.app/Contents/Info.plist

@@ -0,0 +1 @@
+app_icon ICON "icon.ico"

elementalist.app/Contents/MacOS/assets/icon.ico

@@ -0,0 +1,93 @@
+Copyright (c) 2011-2012, Ana Sanfelippo ([email protected]), with Reserved Font Name 'Almendra'
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

elementalist.app/Contents/MacOS/assets/icon.png

@@ -0,0 +1,59 @@
+# Data Files for Game Mechanics
+
+Elementalist reads in game data from the `game_data` directory at launch. These files contain details about the spells and tilesets, and supporting data like particle effects. This is to allow easily adding content to the game, and to make adding it accessible to players.
+
+These files can be in any directory that is within the `game_data` directory (they do not be to separated into different data types). So for example, you can put the data for your spells and their particle data in the same directory and it will be loaded.
+
+## Schemas for Validation
+
+There are publicly available schemas that define the different data files you may write. These are in `_schemas` but also hosted online for ease of IDE integration via the schema validation settings.
+
+| Data                   | Schema URL                                                   |
+| ---------------------- | ------------------------------------------------------------ |
+| Particle Effect        | `https://schemas.nwest.one/games/elementalist/particle.json` |
+| Sprite Atlas / Tileset | `https://schemas.nwest.one/games/elementalist/tileset.json`  |
+| Spell                  | `https://schemas.nwest.one/games/elementalist/spell.json`    |
+
+## Loading Order
+
+Data files are loaded in a specific order so that some data files may reference others (and we can validate that reference). This is to embrace the multi-threaded-ness of bevy as much as possible, to make loading the data as fast as possible. The schedules for the data files are part of a graph with the dependencies needed for inter-linking (e.g. linking a particle effect to a spell) are in the previous node. This is defined with a "schedule" which is just a system set loaded to allow those jobs to be run in parallel.
+
+1. Schedule A: no inter-linking with other data files (the roots)
+2. Schedule B: inter-link only with data loaded from Schedule A
+3. (Theoretical) Schedule C: can depend on data in Schedule A and Schedule B or just Schedule B.
+
+The current data loading order:
+
+| Schedule | Data to be loaded       |
+| -------- | ----------------------- |
+| A        | Particle Effects        |
+| A        | Sprite Atlas / Tilesets |
+| B        | Spell                   |
+
+## YAML Validation
+
+The standard way to add validation to a file is to include a comment at the top of the file which points to the schema URL.
+
+### Specifying the Schema (Recommended)
+
+You can add a comment at the top of the yaml file to indicate what schema to use:
+
+```yaml
+# yaml-language-server: $schema=https://schemas.nwest.one/games/elementalist/spell.json
+```
+
+This is probably the recommended way if you plan to have different data files in the same directory.
+
+### Specifying the Schema in VSCode (Alternative)
+
+In vscode, if you are using the redhat yaml validation plugin (which is likely), you can edit your `settings.json`
+file to inform it of the proper schemas for the vanilla `game_data` file directories:
+
+```json
+  "yaml.schemas": {
+    "https://schemas.nwest.one/games/elementalist/spell.json": ["**/game_data/spells/*.y*ml"],
+    "https://schemas.nwest.one/games/elementalist/spell_tag.json": ["**/game_data/spell_tags/*.y*ml"],
+    "https://schemas.nwest.one/games/elementalist/tileset.json": ["**/game_data/tilesets/*.y*ml"],
+    "https://schemas.nwest.one/games/elementalist/particle.json": ["**/game_data/particles/*.y*ml"]
+  }
+```