Compare commits

...

72 Commits

Author SHA1 Message Date
Ryan Walters
36e9de1a1f chore: bump to v0.80.0, update ROADMAP.md 2025-09-11 02:26:39 -05:00
Ryan Walters
9ad1704806 feat(audio): setup intro jingle, use fruit & ghost sounds, improve AudioEvent 2025-09-11 02:24:15 -05:00
Ryan Walters
86331afd52 refactor(audio): rename eat() to waka(), use play(Sound) for death() instead 2025-09-11 02:11:57 -05:00
Ryan Walters
cca205fe95 chore: compress .ogg audio files 2025-09-11 02:01:44 -05:00
Ryan Walters
00a65954e6 refactor: unify cross-platform asset loading, avoid hard-coding with folder-based asset embedding for desktop 2025-09-11 01:11:00 -05:00
Ryan Walters
43532dac56 feat(audio): centralize sound management with proper enum, improved iterator protocols, introduce new sound files 2025-09-11 00:40:09 -05:00
Ryan Walters
08c964c32e feat: re-implement pausing mechanism with tick-perfect audio & state pauses 2025-09-11 00:03:14 -05:00
Ryan Walters
8b2d18b3da chore: add 'fix' just recipe, remove temp ignore lines 2025-09-10 23:10:27 -05:00
Ryan Walters
46a73c5ace fix: solve audio glitch/crackling on Emscripten via use higher buffer and AUDIO_S16LSB 2025-09-10 23:08:46 -05:00
Ryan Walters
a2783ae62d refactor: refine asset enum, move around audio files, use OGG for death sound 2025-09-10 22:53:19 -05:00
Ryan Walters
83e0d1d737 fix: FruitSprites resource for common tests, disable Exit command bindings on Emscripten, update ROADMAP.md 2025-09-10 22:08:32 -05:00
Ryan Walters
d86864b6a3 feat: fruit display hud 2025-09-10 22:00:11 -05:00
Ryan Walters
d7a6ee7684 fix: flush world after switching to observer-based item collection 2025-09-10 21:45:10 -05:00
Ryan Walters
d84f0c831e feat: proper scheduling via SystemSet, non-conditional game systems, better collision handling 2025-09-10 21:36:51 -05:00
Ryan Walters
ae19ca1795 feat: rewrite ghost/item collision eventing into trigger-based observer 2025-09-10 17:15:15 -05:00
Ryan Walters
abf341d753 fix: avoid constant recalculation of max character height in TtfAtlas 2025-09-10 14:09:07 -05:00
Ryan Walters
7b6dad0c74 refactor: remove unused component, simplify visibility check defaulting behavior, reformat STORY.md 2025-09-10 11:17:12 -05:00
Ryan Walters
5563b64044 refactor: replace immutable Hidden component with mutable Visibility component 2025-09-10 00:45:16 -05:00
Ryan Walters
cb691b0907 refactor: move animation components into new systems/animation submodule 2025-09-10 00:26:49 -05:00
Ryan Walters
ce8ea347e1 refactor: reorganize hud-related elements into systems/hud submodule 2025-09-09 17:00:32 -05:00
Ryan Walters
afae3c5e7b fix: restore target_os for linux linker arg, add documentation detail 2025-09-09 16:49:01 -05:00
Ryan Walters
4f7902fc50 fix: cfg on ConsoleInit for windows/emscripten, use simplified cfg for windows/linux 2025-09-09 16:41:59 -05:00
Ryan Walters
2a2cca675a fix: cfg limit tracing_buffer to windows only 2025-09-09 16:27:35 -05:00
Ryan Walters
f3a6b72931 chore: remove unused tests, fixup README & disable bad markdown lints 2025-09-09 14:22:06 -05:00
Ryan Walters
ca006b5073 refactor: remove dead code, tune lints, remove useless tests 2025-09-09 14:22:06 -05:00
Ryan Walters
139afb2d40 chore: update ROADMAP.md with latest progress, detail core feature targets & mechanics 2025-09-09 11:42:26 -05:00
Ryan Walters
5d56b31353 feat: fruit spawning mechanism, sprites, pellet counting, fruit trigger observer 2025-09-09 11:26:05 -05:00
Ryan Walters
b4990af109 chore: fix clippy lints part 972 2025-09-08 23:53:30 -05:00
Ryan Walters
088c496ad9 refactor: store common components & bundles in 'common' submodule, move others directly into relevant files, create 'animation' submodule 2025-09-08 23:53:30 -05:00
Ryan Walters
5bdf11dfb6 feat: enhance slow frame timing warning 2025-09-08 19:19:23 -05:00
Ryan Walters
c163171304 refactor: use Single<> for player queries 2025-09-08 16:50:28 -05:00
Ryan Walters
63e1059df8 feat: implement entity-based sprite system for HUD display (lives)
- Spawn HUD elements as Renderables with simple change-based entity updates
- Updated rendering systems to accommodate new precise pixel positioning for life sprites.
2025-09-08 16:22:40 -05:00
Ryan Walters
11af44c469 feat: add bottom row HUD, proper life display sprites 2025-09-08 14:30:33 -05:00
Ryan Walters
7675608391 chore(version): bump to v0.78.0 2025-09-08 14:07:34 -05:00
Ryan Walters
7d5b8e11dd chore: bump dependencies, spin-sleep & windows/windows-sys 2025-09-08 14:06:53 -05:00
Ryan Walters
5aba1862c9 feat: improve tracing logs application-wide 2025-09-08 13:50:38 -05:00
Ryan Walters
e46d39a938 chore: split tests & checks into separate workflows 2025-09-08 13:22:58 -05:00
Ryan Walters
49a6a5cc39 feat: implement stage transition for ghost eaten pause and add TimeToLive component
- `StageTransition` enum allows for collision system to apply state transition for ghost pausing.
- Added `TimeToLive` component & `time_to_live_system` to provide temporary sprite rendering of bonus sprites.
- Updated `stage_system` to handle the new ghost eaten pause state, including freezing entities and spawning bonus points.
2025-09-08 13:01:40 -05:00
Ryan Walters
ca50d0f3d8 chore: reformat README, move ideas into ROADMAP, add screenshots & image banner 2025-09-08 12:21:59 -05:00
Ryan Walters
774dc010bf chore: add justforfunnoreally.dev badge, improve README.md, fixup STORY.md 2025-09-08 11:36:38 -05:00
Ryan Walters
e87d458121 fix: set PlayerLives default to 3, use resource for HUD lives count in top left
yes I am fully aware that the UP is not the player lives, I'm just
wanting the indicator to be somewhere and I'll make the proper indicator
tomorrow probably
2025-09-08 01:23:26 -05:00
Ryan Walters
44f0b5d373 fix: use coveralls in README, use proper 'coverage' recipe, remove codecov.yml 2025-09-08 01:18:55 -05:00
Ryan Walters
c828034d18 chore(version): bump version to v0.77.0 2025-09-08 01:15:40 -05:00
Ryan Walters
823f480916 feat: setup pacman collision, level restart, game over, death sequence, switch to Vec for TileSequence 2025-09-08 01:14:32 -05:00
Ryan Walters
53306de155 chore: add precommit bacon job 2025-09-07 16:41:43 -05:00
Ryan Walters
6ddc6d1181 chore: setup auto tag & bump scripts with pre-commit 2025-09-07 15:12:19 -05:00
Ryan Walters
fff44faa05 fix: use serial single-thread testing for game integration tests 2025-09-07 00:10:49 -05:00
Ryan Walters
ca17984d98 feat: use cfg-based coverage exclusion to replace 'ignore-filename-regex' option, setup coveralls & nightly-based coverage 2025-09-06 14:51:23 -05:00
Ryan Walters
c8f389b163 feat: add pacman death sound 2025-09-06 12:15:08 -05:00
Ryan Walters
9c274de901 feat: setup dying sprites with sprite validation tests 2025-09-06 12:15:08 -05:00
Ryan Walters
9633611ae8 fix: downgrade to codecov-action v4, update escapes pattern, ignore codecov.json, slim codecov config 2025-09-06 12:15:07 -05:00
Ryan Walters
897b9b8621 fix: switch from lcov to codecov.json for Codecov reporting 2025-09-06 12:15:07 -05:00
Ryan Walters
ee2569b70c ci: drop coveralls, add codecov config, change badge 2025-09-06 12:15:07 -05:00
Ryan Walters
84caa6c25f ci: setup codecov coverage 2025-09-06 12:15:06 -05:00
Ryan Walters
f92c9175b9 test: add ttf renderer tests 2025-09-06 12:15:06 -05:00
Ryan Walters
d561b446c5 test: remove useless/redundant tests 2025-09-06 12:15:05 -05:00
Ryan Walters
9219c771d7 test: improve input & map_builder test coverage 2025-09-06 12:15:05 -05:00
Ryan Walters
cd501aafc4 test: general game testing 2025-09-06 12:15:05 -05:00
Ryan Walters
feae1ee191 test: add asset tests, file exists & has min size 2025-09-06 12:15:04 -05:00
Ryan Walters
2f0b9825c6 test: blinking system tests 2025-09-06 12:15:04 -05:00
Ryan Walters
cac490565e refactor: use speculoos for all test assertions 2025-09-06 12:15:04 -05:00
Ryan Walters
b60888219b fix: remove unused BlinkingTexture 2025-09-06 12:15:03 -05:00
Ryan Walters
3c50bfeab6 refactor: add ticks to DeltaTime, rewrite Blinking system for tick-based calculations with absolute calculations, rewrite Blinking/Direction tests 2025-09-06 12:15:03 -05:00
Ryan Walters
132067c573 feat: re-implement CustomFormatter to clone Full formatterr 2025-09-06 12:15:03 -05:00
Ryan Walters
42e309a46b feat: enhance profiling with tick-based timing management and zero-padding for skipped frames 2025-09-06 12:15:02 -05:00
Ryan Walters
a38423f006 refactor: use welford's algorithm for one-pass avg/std dev. calculations, input logging tweaks 2025-09-06 12:15:02 -05:00
Ryan Walters
07bd127596 chore: move ttf context out of game.rs, remove unnecessary window event logging 2025-09-06 12:15:01 -05:00
Ryan Walters
da42d017e7 refactor: reorganize game.rs new() into separate functions 2025-09-06 12:15:01 -05:00
Ryan Walters
8b623ffabe feat: sprite enums for avoiding hardcoded string paths 2025-09-06 12:15:01 -05:00
Ryan Walters
af81390e30 fix: use LARGE_SCALE for BatchedLineResource calculations 2025-09-06 12:15:00 -05:00
Ryan Walters
2fabd5d7a2 feat: measure total system timings using threading indifferent method, padded formatting 2025-09-06 12:15:00 -05:00
Ryan Walters
bcd9865430 chore: move BufferedWriter into tracing_buffer.rs 2025-09-06 12:15:00 -05:00
109 changed files with 5153 additions and 2778 deletions

View File

@@ -7,6 +7,8 @@ rustflags = [
]
runner = "node"
# despite being semantically identical to `target_os = "linux"`, the `cfg(linux)` syntax is not supported here. Who knows why...
# https://github.com/Xevion/Pac-Man/actions/runs/17596477856
[target.'cfg(target_os = "linux")']
rustflags = [
# Manually link zlib.

View File

@@ -3,3 +3,10 @@ fail-fast = false
[profile.coverage]
status-level = "none"
[[profile.default.overrides]]
filter = 'test(pacman::game::)'
test-group = 'serial'
[test-groups]
serial = { max-threads = 1 }

1
.gitattributes vendored
View File

@@ -1 +1,2 @@
* text=auto eol=lf
scripts/* linguist-detectable=false

53
.github/workflows/checks.yaml vendored Normal file
View File

@@ -0,0 +1,53 @@
name: Checks
on: ["push", "pull_request"]
env:
CARGO_TERM_COLOR: always
RUST_TOOLCHAIN: 1.86.0
jobs:
checks:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v5
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_TOOLCHAIN }}
components: clippy, rustfmt
- name: Rust Cache
uses: Swatinem/rust-cache@v2
- name: Cache vcpkg
uses: actions/cache@v4
with:
path: target/vcpkg
key: A-vcpkg-${{ runner.os }}-${{ hashFiles('Cargo.toml', 'Cargo.lock') }}
restore-keys: |
A-vcpkg-${{ runner.os }}-
- name: Vcpkg Linux Dependencies
run: |
sudo apt-get update
sudo apt-get install -y libltdl-dev
- name: Vcpkg
run: |
cargo install cargo-vcpkg
cargo vcpkg -v build
- name: Run clippy
run: cargo clippy -- -D warnings
- name: Check formatting
run: cargo fmt -- --check
- uses: taiki-e/install-action@cargo-audit
- name: Run security audit
run: cargo audit

View File

@@ -4,13 +4,11 @@ on: ["push", "pull_request"]
env:
CARGO_TERM_COLOR: always
RUST_TOOLCHAIN: 1.86.0
RUST_TOOLCHAIN: nightly
jobs:
coverage:
runs-on: ubuntu-latest
env:
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
steps:
- name: Checkout code
uses: actions/checkout@v5
@@ -50,33 +48,9 @@ jobs:
run: |
just coverage
- name: Download Coveralls CLI
if: ${{ env.COVERALLS_REPO_TOKEN != '' }}
run: |
# use GitHub Releases URL instead of coveralls.io because they can't maintain their own files; it 404s
curl -L https://github.com/coverallsapp/coverage-reporter/releases/download/v0.6.15/coveralls-linux-x86_64.tar.gz | tar -xz -C /usr/local/bin
- name: Upload coverage to Coveralls
if: ${{ env.COVERALLS_REPO_TOKEN != '' }}
run: |
if [ ! -f "lcov.info" ]; then
echo "Error: lcov.info file not found. Coverage generation may have failed."
exit 1
fi
for i in {1..10}; do
echo "Attempt $i: Uploading coverage to Coveralls..."
if coveralls -n report lcov.info; then
echo "Successfully uploaded coverage report."
exit 0
fi
if [ $i -lt 10 ]; then
delay=$((2**i))
echo "Attempt $i failed. Retrying in $delay seconds..."
sleep $delay
fi
done
echo "Failed to upload coverage report after 10 attempts."
exit 1
- name: Coveralls upload
uses: coverallsapp/github-action@v2
with:
github-token: ${{ secrets.COVERALLS_REPO_TOKEN }}
path-to-lcov: lcov.info
debug: true

View File

@@ -1,4 +1,4 @@
name: Tests & Checks
name: Tests
on: ["push", "pull_request"]
@@ -18,7 +18,6 @@ jobs:
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_TOOLCHAIN }}
components: clippy, rustfmt
- name: Rust Cache
uses: Swatinem/rust-cache@v2
@@ -45,14 +44,3 @@ jobs:
- name: Run nextest
run: cargo nextest run --workspace
- name: Run clippy
run: cargo clippy -- -D warnings
- name: Check formatting
run: cargo fmt -- --check
- uses: taiki-e/install-action@cargo-audit
- name: Run security audit
run: cargo audit

1
.gitignore vendored
View File

@@ -14,6 +14,7 @@ assets/site/build.css
# Coverage reports
lcov.info
codecov.json
coverage.html
# Profiling output

View File

@@ -12,6 +12,13 @@ repos:
- id: forbid-submodules
- id: mixed-line-ending
- repo: https://github.com/compilerla/conventional-pre-commit
rev: v4.2.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
args: []
- repo: local
hooks:
- id: cargo-fmt
@@ -20,12 +27,14 @@ repos:
language: system
types: [rust]
pass_filenames: false
- id: cargo-check
name: cargo check
entry: cargo check --all-targets
language: system
types_or: [rust, cargo, cargo-lock]
pass_filenames: false
- id: cargo-check-wasm
name: cargo check for wasm32-unknown-emscripten
entry: cargo check --all-targets --target=wasm32-unknown-emscripten

347
Cargo.lock generated
View File

@@ -228,6 +228,15 @@ dependencies = [
"serde",
]
[[package]]
name = "block-buffer"
version = "0.10.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71"
dependencies = [
"generic-array",
]
[[package]]
name = "bumpalo"
version = "3.19.0"
@@ -268,6 +277,15 @@ dependencies = [
"portable-atomic",
]
[[package]]
name = "cpufeatures"
version = "0.2.17"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280"
dependencies = [
"libc",
]
[[package]]
name = "critical-section"
version = "1.2.0"
@@ -289,6 +307,16 @@ version = "0.8.21"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28"
[[package]]
name = "crypto-common"
version = "0.1.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3"
dependencies = [
"generic-array",
"typenum",
]
[[package]]
name = "deprecate-until"
version = "0.1.1"
@@ -337,6 +365,16 @@ version = "0.1.13"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "56254986775e3233ffa9c4d7d3faaf6d36a2c09d30b20687e9f88bc8bafc16c8"
[[package]]
name = "digest"
version = "0.10.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292"
dependencies = [
"block-buffer",
"crypto-common",
]
[[package]]
name = "disqualified"
version = "1.0.0"
@@ -408,6 +446,16 @@ dependencies = [
"pin-project-lite",
]
[[package]]
name = "generic-array"
version = "0.14.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a"
dependencies = [
"typenum",
"version_check",
]
[[package]]
name = "getrandom"
version = "0.3.3"
@@ -570,12 +618,76 @@ dependencies = [
"windows-sys 0.52.0",
]
[[package]]
name = "num"
version = "0.4.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "35bd024e8b2ff75562e5f34e7f4905839deb4b22955ef5e73d2fea1b9813cb23"
dependencies = [
"num-bigint",
"num-complex",
"num-integer",
"num-iter",
"num-rational",
"num-traits",
]
[[package]]
name = "num-bigint"
version = "0.4.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a5e44f723f1133c9deac646763579fdb3ac745e418f2a7af9cd0c431da1f20b9"
dependencies = [
"num-integer",
"num-traits",
]
[[package]]
name = "num-complex"
version = "0.4.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "73f88a1307638156682bada9d7604135552957b7818057dcef22705b4d509495"
dependencies = [
"num-traits",
]
[[package]]
name = "num-conv"
version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "51d515d32fb182ee37cda2ccdcb92950d6a3c2893aa280e540671c2cd0f3b1d9"
[[package]]
name = "num-integer"
version = "0.1.46"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7969661fd2958a5cb096e56c8e1ad0444ac2bbcd0061bd28660485a44879858f"
dependencies = [
"num-traits",
]
[[package]]
name = "num-iter"
version = "0.1.45"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1429034a0490724d0075ebb2bc9e875d6503c3cf69e235a8941aa757d83ef5bf"
dependencies = [
"autocfg",
"num-integer",
"num-traits",
]
[[package]]
name = "num-rational"
version = "0.4.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f83d14da390562dca69fc84082e73e548e1ad308d24accdedd2720017cb37824"
dependencies = [
"num-bigint",
"num-integer",
"num-traits",
]
[[package]]
name = "num-traits"
version = "0.2.19"
@@ -599,7 +711,7 @@ checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d"
[[package]]
name = "pacman"
version = "0.2.0"
version = "0.80.0"
dependencies = [
"anyhow",
"bevy_ecs",
@@ -614,10 +726,12 @@ dependencies = [
"phf",
"pretty_assertions",
"rand",
"rust-embed",
"sdl2",
"serde",
"serde_json",
"smallvec",
"speculoos",
"spin_sleep",
"strum",
"strum_macros",
@@ -628,7 +742,7 @@ dependencies = [
"tracing-error",
"tracing-subscriber",
"windows",
"windows-sys 0.60.2",
"windows-sys 0.61.0",
]
[[package]]
@@ -657,7 +771,7 @@ dependencies = [
"libc",
"redox_syscall",
"smallvec",
"windows-targets 0.52.6",
"windows-targets",
]
[[package]]
@@ -842,6 +956,40 @@ version = "0.8.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
[[package]]
name = "rust-embed"
version = "8.7.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "025908b8682a26ba8d12f6f2d66b987584a4a87bc024abc5bbc12553a8cd178a"
dependencies = [
"rust-embed-impl",
"rust-embed-utils",
"walkdir",
]
[[package]]
name = "rust-embed-impl"
version = "8.7.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6065f1a4392b71819ec1ea1df1120673418bf386f50de1d6f54204d836d4349c"
dependencies = [
"proc-macro2",
"quote",
"rust-embed-utils",
"syn",
"walkdir",
]
[[package]]
name = "rust-embed-utils"
version = "8.7.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f6cc0c81648b20b70c491ff8cce00c1c3b223bb8ed2b5d41f0e54c6c4c0a3594"
dependencies = [
"sha2",
"walkdir",
]
[[package]]
name = "rustc-hash"
version = "2.1.1"
@@ -860,6 +1008,15 @@ version = "1.0.20"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "28d3b2b1366ec20994f1fd18c3c594f05c5dd4bc44d8bb0c1c632c8d6829481f"
[[package]]
name = "same-file"
version = "1.0.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502"
dependencies = [
"winapi-util",
]
[[package]]
name = "scopeguard"
version = "1.2.0"
@@ -929,6 +1086,17 @@ dependencies = [
"serde",
]
[[package]]
name = "sha2"
version = "0.10.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a7507d819769d01a365ab707794a4084392c824f54a7a6a7862f8c3d0892b283"
dependencies = [
"cfg-if",
"cpufeatures",
"digest",
]
[[package]]
name = "sharded-slab"
version = "0.1.4"
@@ -965,6 +1133,16 @@ dependencies = [
"serde",
]
[[package]]
name = "speculoos"
version = "0.13.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "00c84ba5fa63b0de837c0d3cef5373ac1c3c6342053b7f446a210a1dde79a034"
dependencies = [
"num",
"serde_json",
]
[[package]]
name = "spin"
version = "0.9.8"
@@ -976,11 +1154,11 @@ dependencies = [
[[package]]
name = "spin_sleep"
version = "1.3.2"
version = "1.3.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "14ac0e4b54d028c2000a13895bcd84cd02a1d63c4f78e08e4ec5ec8f53efd4b9"
checksum = "9c07347b7c0301b9adba4350bdcf09c039d0e7160922050db0439b3c6723c8ab"
dependencies = [
"windows-sys 0.60.2",
"windows-sys 0.61.0",
]
[[package]]
@@ -1178,6 +1356,12 @@ version = "1.0.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bc7d623258602320d5c55d1bc22793b57daff0ec7efc270ea7d55ce1d5f5471c"
[[package]]
name = "typenum"
version = "1.18.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1dccffe3ce07af9386bfd29e80c0ab1a8205a2fc34e4bcd40364df902cfa8f3f"
[[package]]
name = "unicode-ident"
version = "1.0.11"
@@ -1231,6 +1415,22 @@ version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "579a42fc0b8e0c63b76519a339be31bed574929511fa53c1a3acae26eb258f29"
[[package]]
name = "version_check"
version = "0.9.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a"
[[package]]
name = "walkdir"
version = "2.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "29790946404f91d9c5d06f9874efddea1dc06c5efe94541a7d6863108e3a5e4b"
dependencies = [
"same-file",
"winapi-util",
]
[[package]]
name = "wasi"
version = "0.14.2+wasi-0.2.4"
@@ -1322,10 +1522,19 @@ dependencies = [
]
[[package]]
name = "windows"
version = "0.61.3"
name = "winapi-util"
version = "0.1.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9babd3a767a4c1aef6900409f85f5d53ce2544ccdfaa86dad48c91782c6d6893"
checksum = "c2a7b1c03c876122aa43f3020e6c3c3ee5c05081c9a00739faf7503aeba10d22"
dependencies = [
"windows-sys 0.61.0",
]
[[package]]
name = "windows"
version = "0.62.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9579d0e6970fd5250aa29aba5994052385ff55cf7b28a059e484bb79ea842e42"
dependencies = [
"windows-collections",
"windows-core",
@@ -1336,18 +1545,18 @@ dependencies = [
[[package]]
name = "windows-collections"
version = "0.2.0"
version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3beeceb5e5cfd9eb1d76b381630e82c4241ccd0d27f1a39ed41b2760b255c5e8"
checksum = "a90dd7a7b86859ec4cdf864658b311545ef19dbcf17a672b52ab7cefe80c336f"
dependencies = [
"windows-core",
]
[[package]]
name = "windows-core"
version = "0.61.2"
version = "0.62.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c0fdd3ddb90610c7638aa2b3a3ab2904fb9e5cdbecc643ddb3647212781c4ae3"
checksum = "57fe7168f7de578d2d8a05b07fd61870d2e73b4020e9f49aa00da8471723497c"
dependencies = [
"windows-implement",
"windows-interface",
@@ -1358,9 +1567,9 @@ dependencies = [
[[package]]
name = "windows-future"
version = "0.2.1"
version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fc6a41e98427b19fe4b73c550f060b59fa592d7d686537eebf9385621bfbad8e"
checksum = "b2194dee901458cb79e1148a4e9aac2b164cc95fa431891e7b296ff0b2f1d8a6"
dependencies = [
"windows-core",
"windows-link",
@@ -1391,15 +1600,15 @@ dependencies = [
[[package]]
name = "windows-link"
version = "0.1.3"
version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5e6ad25900d524eaabdbbb96d20b4311e1e7ae1699af4fb28c17ae66c80d798a"
checksum = "45e46c0661abb7180e7b9c281db115305d49ca1709ab8242adf09666d2173c65"
[[package]]
name = "windows-numerics"
version = "0.2.0"
version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9150af68066c4c5c07ddc0ce30421554771e528bde427614c61038bc2c92c2b1"
checksum = "2ce3498fe0aba81e62e477408383196b4b0363db5e0c27646f932676283b43d8"
dependencies = [
"windows-core",
"windows-link",
@@ -1407,18 +1616,18 @@ dependencies = [
[[package]]
name = "windows-result"
version = "0.3.4"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "56f42bd332cc6c8eac5af113fc0c1fd6a8fd2aa08a0119358686e5160d0586c6"
checksum = "7084dcc306f89883455a206237404d3eaf961e5bd7e0f312f7c91f57eb44167f"
dependencies = [
"windows-link",
]
[[package]]
name = "windows-strings"
version = "0.4.2"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "56e6c93f3a0c3b36176cb1327a4958a0353d5d166c2a35cb268ace15e91d3b57"
checksum = "7218c655a553b0bed4426cf54b20d7ba363ef543b52d515b3e48d7fd55318dda"
dependencies = [
"windows-link",
]
@@ -1429,16 +1638,16 @@ version = "0.52.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d"
dependencies = [
"windows-targets 0.52.6",
"windows-targets",
]
[[package]]
name = "windows-sys"
version = "0.60.2"
version = "0.61.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f2f500e4d28234f72040990ec9d39e3a6b950f9f22d3dba18416c35882612bcb"
checksum = "e201184e40b2ede64bc2ea34968b28e33622acdbbf37104f0e4a33f7abe657aa"
dependencies = [
"windows-targets 0.53.2",
"windows-link",
]
[[package]]
@@ -1447,37 +1656,21 @@ version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
dependencies = [
"windows_aarch64_gnullvm 0.52.6",
"windows_aarch64_msvc 0.52.6",
"windows_i686_gnu 0.52.6",
"windows_i686_gnullvm 0.52.6",
"windows_i686_msvc 0.52.6",
"windows_x86_64_gnu 0.52.6",
"windows_x86_64_gnullvm 0.52.6",
"windows_x86_64_msvc 0.52.6",
]
[[package]]
name = "windows-targets"
version = "0.53.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c66f69fcc9ce11da9966ddb31a40968cad001c5bedeb5c2b82ede4253ab48aef"
dependencies = [
"windows_aarch64_gnullvm 0.53.0",
"windows_aarch64_msvc 0.53.0",
"windows_i686_gnu 0.53.0",
"windows_i686_gnullvm 0.53.0",
"windows_i686_msvc 0.53.0",
"windows_x86_64_gnu 0.53.0",
"windows_x86_64_gnullvm 0.53.0",
"windows_x86_64_msvc 0.53.0",
"windows_aarch64_gnullvm",
"windows_aarch64_msvc",
"windows_i686_gnu",
"windows_i686_gnullvm",
"windows_i686_msvc",
"windows_x86_64_gnu",
"windows_x86_64_gnullvm",
"windows_x86_64_msvc",
]
[[package]]
name = "windows-threading"
version = "0.1.0"
version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b66463ad2e0ea3bbf808b7f1d371311c80e115c0b71d60efc142cafbcfb057a6"
checksum = "ab47f085ad6932defa48855254c758cdd0e2f2d48e62a34118a268d8f345e118"
dependencies = [
"windows-link",
]
@@ -1488,96 +1681,48 @@ version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
[[package]]
name = "windows_aarch64_gnullvm"
version = "0.53.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "86b8d5f90ddd19cb4a147a5fa63ca848db3df085e25fee3cc10b39b6eebae764"
[[package]]
name = "windows_aarch64_msvc"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
[[package]]
name = "windows_aarch64_msvc"
version = "0.53.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c7651a1f62a11b8cbd5e0d42526e55f2c99886c77e007179efff86c2b137e66c"
[[package]]
name = "windows_i686_gnu"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
[[package]]
name = "windows_i686_gnu"
version = "0.53.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c1dc67659d35f387f5f6c479dc4e28f1d4bb90ddd1a5d3da2e5d97b42d6272c3"
[[package]]
name = "windows_i686_gnullvm"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
[[package]]
name = "windows_i686_gnullvm"
version = "0.53.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9ce6ccbdedbf6d6354471319e781c0dfef054c81fbc7cf83f338a4296c0cae11"
[[package]]
name = "windows_i686_msvc"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
[[package]]
name = "windows_i686_msvc"
version = "0.53.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "581fee95406bb13382d2f65cd4a908ca7b1e4c2f1917f143ba16efe98a589b5d"
[[package]]
name = "windows_x86_64_gnu"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
[[package]]
name = "windows_x86_64_gnu"
version = "0.53.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2e55b5ac9ea33f2fc1716d1742db15574fd6fc8dadc51caab1c16a3d3b4190ba"
[[package]]
name = "windows_x86_64_gnullvm"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
[[package]]
name = "windows_x86_64_gnullvm"
version = "0.53.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0a6e035dd0599267ce1ee132e51c27dd29437f63325753051e71dd9e42406c57"
[[package]]
name = "windows_x86_64_msvc"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
[[package]]
name = "windows_x86_64_msvc"
version = "0.53.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "271414315aff87387382ec3d271b52d7ae78726f5d44ac98b4f4030c91880486"
[[package]]
name = "winnow"
version = "0.7.12"

View File

@@ -1,6 +1,6 @@
[package]
name = "pacman"
version = "0.2.0"
version = "0.80.0"
authors = ["Xevion"]
edition = "2021"
rust-version = "1.86.0"
@@ -21,7 +21,7 @@ default-run = "pacman"
bevy_ecs = "0.16.1"
glam = "0.30.5"
pathfinding = "4.14"
tracing = { version = "0.1.41", features = ["max_level_debug", "release_max_level_debug"]}
tracing = { version = "0.1.41", features = ["max_level_trace", "release_max_level_debug"]}
tracing-error = "0.2.0"
tracing-subscriber = {version = "0.3.20", features = ["env-filter"]}
time = { version = "0.3.43", features = ["formatting", "macros"] }
@@ -40,17 +40,18 @@ num-width = "0.1.0"
phf = { version = "0.13.1", features = ["macros"] }
# Windows-specific dependencies
[target.'cfg(target_os = "windows")'.dependencies]
[target.'cfg(windows)'.dependencies]
# Used for customizing console output on Windows; both are required due to the `windows` crate having poor Result handling with `GetStdHandle`.
windows = { version = "0.61.3", features = ["Win32_Security", "Win32_Storage_FileSystem", "Win32_System_Console"] }
windows-sys = { version = "0.60.2", features = ["Win32_System_Console"] }
windows = { version = "0.62.0", features = ["Win32_Security", "Win32_Storage_FileSystem", "Win32_System_Console"] }
windows-sys = { version = "0.61.0", features = ["Win32_System_Console"] }
# Desktop-specific dependencies
[target.'cfg(not(target_os = "emscripten"))'.dependencies]
# On desktop platforms, build SDL2 with cargo-vcpkg
sdl2 = { version = "0.38", default-features = false, features = ["image", "ttf", "gfx", "mixer", "unsafe_textures", "static-link", "use-vcpkg"] }
rand = { version = "0.9.2", default-features = false, features = ["thread_rng"] }
spin_sleep = "1.3.2"
rust-embed = "8.7.2"
spin_sleep = "1.3.3"
# Browser-specific dependencies
[target.'cfg(target_os = "emscripten")'.dependencies]
@@ -62,6 +63,7 @@ libc = "0.2.175" # TODO: Describe why this is required.
[dev-dependencies]
pretty_assertions = "1.4.1"
speculoos = "0.13.0"
[build-dependencies]
phf = { version = "0.13.1", features = ["macros"] }
@@ -97,3 +99,6 @@ x86_64-pc-windows-msvc = { triplet = "x64-windows-static-md" }
x86_64-unknown-linux-gnu = { triplet = "x64-linux" }
x86_64-apple-darwin = { triplet = "x64-osx" }
aarch64-apple-darwin = { triplet = "arm64-osx" }
[lints.rust]
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(coverage,coverage_nightly)'] }

View File

@@ -1,9 +1,6 @@
set shell := ["bash", "-c"]
set windows-shell := ["powershell.exe", "-NoLogo", "-Command"]
# Regex to exclude files from coverage report, double escapes for Justfile + CLI
# You can use src\\\\..., but the filename alone is acceptable too
coverage_exclude_pattern := "src\\\\app\\.rs|audio\\.rs|src\\\\error\\.rs|platform\\\\emscripten\\.rs|bin\\\\.+\\.rs|main\\.rs|platform\\\\desktop\\.rs|platform\\\\tracing_buffer\\.rs|platform\\\\buffered_writer\\.rs|systems\\\\debug\\.rs|systems\\\\profiling\\.rs"
binary_extension := if os() == "windows" { ".exe" } else { "" }
@@ -14,22 +11,19 @@ binary_extension := if os() == "windows" { ".exe" } else { "" }
html: coverage
cargo llvm-cov report \
--remap-path-prefix \
--ignore-filename-regex "{{ coverage_exclude_pattern }}" \
--html \
--open
# Display report (for humans)
report-coverage: coverage
cargo llvm-cov report \
--remap-path-prefix \
--ignore-filename-regex "{{ coverage_exclude_pattern }}"
cargo llvm-cov report --remap-path-prefix
# Run & generate report (for CI)
# Run & generate LCOV report (as base report)
coverage:
cargo llvm-cov \
cargo +nightly llvm-cov \
--lcov \
--remap-path-prefix \
--ignore-filename-regex "{{ coverage_exclude_pattern }}" \
--workspace \
--output-path lcov.info \
--profile coverage \
--no-fail-fast nextest
@@ -43,3 +37,8 @@ samply:
web *args:
bun run web.build.ts {{args}};
caddy file-server --root dist
# Run cargo fix
fix:
cargo fix --workspace --lib --allow-dirty
cargo fmt --all

113
README.md
View File

@@ -1,80 +1,94 @@
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable MD041 -->
<div align="center">
<img src="assets/repo/banner.png" alt="Pac-Man Banner Screenshot">
</div>
# Pac-Man
[![Tests Status][badge-test]][test] [![Build Status][badge-build]][build] [![If you're seeing this, Coveralls.io is broken again and it's not my fault.][badge-coverage]][coverage] [![Online Demo][badge-online-demo]][demo] [![Last Commit][badge-last-commit]][commits]
[![A project just for fun, no really!][badge-justforfunnoreally]][justforfunnoreally] ![Built with Rust][badge-built-with-rust] [![Build Status][badge-build]][build] [![Tests Status][badge-test]][test] [![Checks Status][badge-checks]][checks] [![If you're seeing this, Coveralls.io is broken again and it's not my fault.][badge-coverage]][coverage] [![Online Demo][badge-online-demo]][demo]
[badge-built-with-rust]: https://img.shields.io/badge/Built_with-Rust-blue?logo=rust
[badge-justforfunnoreally]: https://img.shields.io/badge/justforfunnoreally-dev-9ff
[badge-test]: https://github.com/Xevion/Pac-Man/actions/workflows/tests.yaml/badge.svg
[badge-checks]: https://github.com/Xevion/Pac-Man/actions/workflows/checks.yaml/badge.svg
[badge-build]: https://github.com/Xevion/Pac-Man/actions/workflows/build.yaml/badge.svg
[badge-coverage]: https://coveralls.io/repos/github/Xevion/Pac-Man/badge.svg?branch=master
[badge-demo]: https://img.shields.io/github/deployments/Xevion/Pac-Man/github-pages?label=GitHub%20Pages
[badge-online-demo]: https://img.shields.io/badge/GitHub%20Pages-Demo-brightgreen
[badge-last-commit]: https://img.shields.io/github/last-commit/Xevion/Pac-Man
[badge-online-demo]: https://img.shields.io/badge/Online%20Demo-Click%20Me!-brightgreen
[justforfunnoreally]: https://justforfunnoreally.dev
[build]: https://github.com/Xevion/Pac-Man/actions/workflows/build.yaml
[test]: https://github.com/Xevion/Pac-Man/actions/workflows/tests.yaml
[checks]: https://github.com/Xevion/Pac-Man/actions/workflows/checks.yaml
[coverage]: https://coveralls.io/github/Xevion/Pac-Man?branch=master
[demo]: https://xevion.github.io/Pac-Man/
[commits]: https://github.com/Xevion/Pac-Man/commits/master
A faithful recreation of the classic Pac-Man arcade game written in Rust. This project aims to replicate the original game's mechanics, graphics, sound, and behavior as accurately as possible while providing modern development features like cross-platform compatibility and WebAssembly support.
A faithful recreation of the classic Pac-Man arcade game, written in Rust.
This project aims to replicate the original game's mechanics, graphics, sound, and behavior as accurately as possible while providing modern development features like cross-platform compatibility and WebAssembly support.
The game includes all the original features you'd expect from Pac-Man:
- [x] Classic maze navigation and dot collection
- [x] Classic maze navigation with tunnels and dot collection
- [ ] Four ghosts with their unique AI behaviors (Blinky, Pinky, Inky, and Clyde)
- [ ] Power pellets that allow Pac-Man to eat ghosts
- [x] Power pellets that allow Pac-Man to eat ghosts
- [ ] Fruit bonuses that appear periodically
- [ ] Progressive difficulty with faster ghosts and shorter power pellet duration
- [x] Authentic sound effects and sprites
This cross-platform implementation is built with SDL2 for graphics, audio, and input handling. It can run on Windows, Linux, macOS, and in web browsers via WebAssembly.
This cross-platform implementation is built with SDL2 for graphics, audio, and input handling. It can run on Windows, Linux, macOS, even web browsers via WebAssembly.
## Quick Start
The easiest way to play is to visit the [online demo][demo]. It is more or less identical to the desktop experience at this time.
While I do plan to have desktop builds released automatically, the game is still a work in progress, and I'm not quite ready to start uploading releases.
However, every commit has build artifacts, so you can grab the [latest build artifacts][build-workflow] if available.
## Screenshots
<div align="center">
<img src="assets/repo/screenshots/0.png" alt="Screenshot 0 - Starting Game">
<p><em>Starting a new game</em></p>
<img src="assets/repo/screenshots/1.png" alt="Screenshot 1 - Eating Dots">
<p><em>Pac-Man collecting dots and avoiding ghosts</em></p>
<img src="assets/repo/screenshots/2.png" alt="Screenshot 2 - Game Over">
<p><em>Game over screen after losing all lives</em></p>
<img src="assets/repo/screenshots/3.png" alt="Screenshot 3 - Debug Mode">
<p><em>Debug mode showing hitboxes, node graph, and performance details.</em></p>
</div>
## Why?
Just because. And because I wanted to learn more about Rust, inter-operability with C, and compiling to WebAssembly.
[Just for fun.][justforfunnoreally] And because I wanted to learn more about Rust, inter-operability with C, and compiling to WebAssembly.
I was inspired by a certain code review video on YouTube; [SOME UNIQUE C++ CODE // Pacman Clone Code Review](https://www.youtube.com/watch?v=OKs_JewEeOo) by The Cherno.
Originally, I was inspired by a certain code review video on YouTube; [SOME UNIQUE C++ CODE // Pacman Clone Code Review](https://www.youtube.com/watch?v=OKs_JewEeOo). For some reason, I was inspired to try and replicate it in Rust, and it was uniquely challenging. It's not easy to integrate SDL2 with Rust, and even harder to get it working with Emscripten.
For some reason, I was inspired to try and replicate it in Rust, and it was uniquely challenging.
I wanted to hit a lot of goals and features, making it a 'perfect' project that I could be proud of.
I wanted to hit a log of goals and features, making it a 'perfect' project that I could be proud of.
- Near-perfect replication of logic, scoring, graphics, sound, and behaviors. No hacks, workarounds, or poor designs.
- Written in Rust, buildable on Windows, Linux, Mac and WebAssembly. Statically linked, no runtime dependencies.
- Near-perfect replication of logic, scoring, graphics, sound, and behaviors. No hacks, workarounds, or poor designs. Well documented, well-tested, and maintainable.
- Written in Rust, buildable on Windows, Linux, Mac and WebAssembly. Statically linked, no runtime dependencies, automatically built with GitHub Actions.
- Performant, low memory, CPU and GPU usage.
- Online demo, playable in a browser.
- Completely automatic build system with releases for all platforms.
- Well documented, well-tested, and maintainable.
- Online demo, playable in a browser, built automatically with GitHub Actions.
## Experimental Ideas
If you're curious about the journey of this project, you can read the [story](STORY.md) file. Eventually, I will be using this as the basis for some sort of blog post or more official page, but for now, I'm keeping it within the repository as a simple file.
- Debug tooling
- Game state visualization
- Game speed controls + pausing
- Log tracing
- Performance details
- Customized Themes & Colors
- Color-blind friendly
- Perfected Ghost Algorithms
- More than 4 ghosts
- Custom Level Generation
- Multi-map tunnelling
- Online Scoreboard
- An online axum server with a simple database and OAuth2 authentication.
- Integrates with GitHub, Discord, and Google OAuth2 to acquire an email identifier & avatar.
- Avatars are optional for score submission and can be disabled, instead using a blank avatar.
- Avatars are downscaled to a low resolution pixellated image to maintain the 8-bit aesthetic.
- A custom name is used for the score submission, which is checked for potential abusive language.
- A max length of 14 characters, and a min length of 3 characters.
- Names are checked for potential abusive language via an external API.
- The client implementation should require zero configuration, environment variables, or special secrets.
- It simply defaults to the pacman server API, or can be overriden manually.
## Roadmap
You can read the [roadmap](ROADMAP.md) file for more details on the project's goals and future plans.
## Build Notes
Since this project is still in progress, I'm only going to cover non-obvious build details. By reading the code, build scripts, and copying the online build workflows, you should be able to replicate the build process.
- Install `cargo-vcpkg` with `cargo install cargo-vcpkg`, then run `cargo vcpkg build` to build the requisite dependencies via vcpkg.
- This is only required for the desktop builds, not the web build.
- We use rustc 1.86.0 for the build, due to bulk-memory-opt related issues on wasm32-unknown-emscripten.
- Technically, we could probably use stable or even nightly on desktop targets, but using different versions for different targets is a pain, mainly because of clippy warnings changing between versions.
- Install `cargo-vcpkg` with `cargo install cargo-vcpkg`, then run `cargo vcpkg build` to build the requisite dependencies via vcpkg.
- For the WASM build, you need to have the Emscripten SDK cloned; you can do so with `git clone https://github.com/emscripten-core/emsdk.git`
- The first time you clone, you'll need to install the appropriate SDK version with `./emsdk install 3.1.43` and then activate it with `./emsdk activate 3.1.43`. On Windows, use `./emsdk/emsdk.ps1` instead.
- I'm still not sure _why_ 3.1.43 is required, but it is. Perhaps in the future I will attempt to use a more modern version.
@@ -87,3 +101,18 @@ Since this project is still in progress, I'm only going to cover non-obvious bui
- `caddy file-server --root dist` (install with `[sudo apt|brew|choco] install caddy` or [a dozen other ways](https://caddyserver.com/docs/install))
- `web.build.ts` auto installs dependencies, but you may need to pass `-i` or `--install=fallback|force` to install missing packages. My guess is that if you have some packages installed, it won't install any missing ones. If you have no packages installed, it will install all of them.
- If you want to have TypeScript resolution for development, you can manually install the dependencies with `bun install` in the `assets/site` folder.
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue.
- The code is not exactly stable or bulletproof, but it is functional and has a lot of tests.
- I am not actively looking for contributors, but I will review pull requests and merge them if they are useful.
- If you have any ideas, please feel free to submit an issue.
- If you have any private issues, security concerns, or anything sensitive, you can email me at [xevion@xevion.dev](mailto:xevion@xevion.dev).
## License
This project is licensed under the GPLv3 license. See the [LICENSE](LICENSE) file for details.
[build-workflow]: https://github.com/Xevion/Pac-Man/actions/workflows/build.yaml

164
ROADMAP.md Normal file
View File

@@ -0,0 +1,164 @@
# Roadmap
A comprehensive list of features needed to complete the Pac-Man emulation, organized by priority and implementation complexity.
## Core Game Features
### Ghost AI & Behavior
- [x] Core Ghost System Architecture
- [x] Ghost entity types (Blinky, Pinky, Inky, Clyde)
- [x] Ghost state management (Normal, Frightened, Eyes)
- [x] Ghost movement and pathfinding systems
- [ ] Authentic Ghost AI Personalities
- [ ] Blinky (Red): Direct chase behavior
- [ ] Pinky (Pink): Target 4 tiles ahead of Pac-Man
- [ ] Inky (Cyan): Complex behavior based on Blinky's position
- [ ] Clyde (Orange): Chase when far, flee when close
- [x] Mode Switching System
- [ ] Scatter/Chase pattern with proper timing
- [x] Frightened mode transitions
- [ ] Ghost house entry/exit mechanics
- [x] Ghost House Behavior
- [x] Proper spawning sequence
- [ ] Exit timing and patterns
- [ ] House-specific movement rules
### Fruit Bonus System
- [x] Fruit Spawning Mechanics
- [x] Spawn at pellet counts 70 and 170
- [x] Fruit display in bottom-right corner
- [x] Fruit collection and scoring
- [x] Bonus point display system
### Level Progression
- [ ] Multiple Levels
- [ ] Level completion detection
- [ ] Progressive difficulty scaling
- [ ] Ghost speed increases per level
- [ ] Power pellet duration decreases
- [ ] Intermission Screens
- [ ] Between-level cutscenes
- [ ] Proper graphics and timing
### Audio System Completion
- [x] Core Audio Infrastructure
- [x] Audio event system
- [x] Sound effect playback
- [x] Audio muting controls
- [ ] Background Music
- [x] Intro jingle
- [ ] Continuous gameplay music
- [ ] Escalating siren based on remaining pellets
- [ ] Power pellet mode music
- [ ] Intermission music
- [x] Sound Effects
- [x] Pellet eating sounds
- [x] Fruit collection sounds
- [x] Ghost eaten sounds
- [x] Pac-Man Death
- [ ] Ghost movement sounds
- [ ] Level completion fanfare
### Game Mechanics
- [ ] Bonus Lives
- [ ] Extra life at 10,000 points
- [x] Life counter display
- [ ] High Score System
- [ ] High score tracking
- [x] High score display
- [ ] Score persistence
## Secondary Features (Medium Priority)
### Game Polish
- [x] Core Input System
- [x] Keyboard controls
- [x] Direction buffering for responsive controls
- [x] Touch controls for mobile
- [x] Pause System
- [x] Pause/unpause functionality
- [ ] Pause menu with options
- [ ] Input System
- [ ] Input remapping
- [ ] Multiple input methods
## Advanced Features (Lower Priority)
### Difficulty Options
- [ ] Easy/Normal/Hard modes
- [ ] Customizable ghost speeds
### Data Persistence
- [ ] High Score Persistence
- [ ] Save high scores to file
- [ ] High score table display
- [ ] Settings Storage
- [ ] Save user preferences
- [ ] Audio/visual settings
- [ ] Statistics Tracking
- [ ] Game statistics
- [ ] Achievement system
### Debug & Development Tools
- [x] Performance details
- [x] Core Debug Infrastructure
- [x] Debug mode toggle
- [x] Comprehensive game event logging
- [x] Performance profiling tools
- [ ] Game State Visualization
- [ ] Ghost AI state display
- [ ] Pathfinding visualization
- [ ] Collision detection display
- [ ] Game Speed Controls
- [ ] Variable game speed for testing
- [ ] Frame-by-frame stepping
## Customization & Extensions
### Visual Customization
- [x] Core Rendering System
- [x] Sprite-based rendering
- [x] Layered rendering system
- [x] Animation system
- [x] HUD rendering
- [ ] Display Options
- [ ] Fullscreen support
- [x] Window resizing
- [ ] Pause while resizing (SDL2 limitation mitigation)
- [ ] Multiple resolution support
### Gameplay Extensions
- [ ] Advanced Ghost AI
- [ ] Support for >4 ghosts
- [ ] Custom ghost behaviors
- [ ] Level Generation
- [ ] Custom level creation
- [ ] Multi-map tunneling
- [ ] Level editor
## Online Features (Future)
### Scoreboard System
- [ ] Backend Infrastructure
- [ ] Axum server with database
- [ ] OAuth2 authentication
- [ ] GitHub/Discord/Google auth
- [ ] Profile Features
- [ ] Optional avatars (8-bit aesthetic)
- [ ] Custom names (3-14 chars, filtered)
- [ ] Client Implementation
- [ ] Zero-config client
- [ ] Default API endpoint
- [ ] Manual override available

View File

@@ -31,7 +31,7 @@ WebAssembly.
The problem is that much of this work was done for pure-Rust applications - and SDL is C++.
This requires a C++ WebAssembly compiler such as Emscripten; and it's a pain to get working.
Luckily though, someone else has done this before, and they fully documented it - [RuggRouge][ruggrouge].
Luckily though, someone else has done this before, and they fully documented it - [RuggRouge][ruggrogue].
- Built with Rust
- Uses SDL2
@@ -92,7 +92,7 @@ This was weird, and honestly, I'm confused as to why the 2-year old sample code
After a bit of time, I noted that the `Instant` times were printing with only the whole seconds changing, and the nanoseconds were always 0.
```
```rust
Instant { tv_sec: 0, tv_nsec: 0 }
Instant { tv_sec: 1, tv_nsec: 0 }
Instant { tv_sec: 2, tv_nsec: 0 }
@@ -357,7 +357,7 @@ Doing so required a full re-work of the animation and texture system, and I ende
So, I ended up using `unsafe` to forcibly cast the lifetimes to `'static`, which was a bit of a gamble, but given that they essentially behave as `'static` in practice, there wasn't much risk as I see it. I might re-look into my understanding of lifetimes and this in the future, but for the time being, it's a good solution that makes the codebase far easier to work with.
## Cross-platform Builds
## Implementing Cross-platform Builds for Pac-Man
Since the original `rust-sdl2-emscripten` demo project had cross-platform builds, I was ready to get it working for this project. For the most part, it wasn't hard, things tended to click into place, but unfortunately, the `emscripten` os target and somehow, the `linux` os target were both failing.
@@ -412,8 +412,8 @@ The bigger downside was that I had to toss out almost all the existing code for
This ended up being okay though, as I was able to clean up a lot of gross code, and the system ended up being easier to work with by comparison.
[code-review-video]: https://www.youtube.com/watch?v=OKs_JewEeOo
[code-review-thumbnail]: https://img.youtube.com/vi/OKs_JewEeOo/hqdefault.jpg
[code-review-video]: https://www.youtube.com/watch?v=OKs_JewEeOo
[fighting-lifetimes-1]: https://devcry.heiho.net/html/2022/20220709-rust-and-sdl2-fighting-with-lifetimes.html
[fighting-lifetimes-2]: https://devcry.heiho.net/html/2022/20220716-rust-and-sdl2-fighting-with-lifetimes-2.html
[fighting-lifetimes-3]: https://devcry.heiho.net/html/2022/20220724-rust-and-sdl2-fighting-with-lifetimes-3.html

BIN
assets/game/sound/begin.ogg Normal file
View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

View File

Binary file not shown.

BIN
assets/repo/banner.png Normal file
View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.3 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

View File

@@ -28,16 +28,18 @@ need_stdout = false
[jobs.test]
command = [
"cargo", "nextest", "run",
"--hide-progress-bar", "--failure-output", "final"
"cargo",
"nextest",
"run",
"--hide-progress-bar",
"--failure-output",
"final",
]
need_stdout = true
analyzer = "nextest"
[jobs.coverage]
command = [
"just", "report-coverage"
]
command = ["just", "report-coverage"]
need_stdout = true
ignored_lines = [
"info:",
@@ -54,7 +56,7 @@ ignored_lines = [
"\\s*Finished.+in \\d+",
"\\s*Summary\\s+\\[",
"\\s*Blocking",
"Finished report saved to"
"Finished report saved to",
]
on_change_strategy = "wait_then_restart"
@@ -69,18 +71,23 @@ need_stdout = false
on_success = "back" # so that we don't open the browser at each change
[jobs.run]
command = [
"cargo", "run",
]
command = ["cargo", "run"]
need_stdout = true
allow_warnings = true
background = false
on_change_strategy = "kill_then_restart"
# kill = ["pkill", "-TERM", "-P"]'
[jobs.precommit]
command = ["pre-commit", "run", "--all-files"]
need_stdout = true
background = false
on_change_strategy = "kill_then_restart"
[keybindings]
c = "job:clippy"
alt-c = "job:check"
ctrl-alt-c = "job:check-all"
shift-c = "job:clippy-all"
f = "job:coverage"
p = "job:precommit"

View File

@@ -10,13 +10,9 @@ use crate::platform;
use sdl2::pixels::PixelFormatEnum;
use sdl2::render::RendererInfo;
use sdl2::{AudioSubsystem, Sdl};
use tracing::debug;
use tracing::{debug, info, trace};
/// Main application wrapper that manages SDL initialization, window lifecycle, and the game loop.
///
/// Handles platform-specific setup, maintains consistent frame timing, and delegates
/// game logic to the contained `Game` instance. The app manages focus state to
/// optimize CPU usage when the window loses focus.
pub struct App {
pub game: Game,
last_tick: Instant,
@@ -29,21 +25,25 @@ pub struct App {
impl App {
/// Initializes SDL subsystems, creates the game window, and sets up the game state.
///
/// Performs comprehensive initialization including video/audio subsystems,
/// window creation with proper scaling, and canvas configuration. All SDL
/// resources are leaked to maintain 'static lifetimes required by the game architecture.
///
/// # Errors
///
/// Returns `GameError::Sdl` if any SDL initialization step fails, or propagates
/// errors from `Game::new()` during game state setup.
pub fn new() -> GameResult<Self> {
info!("Initializing SDL2 application");
let sdl_context = sdl2::init().map_err(|e| GameError::Sdl(e.to_string()))?;
debug!("Initializing SDL2 subsystems");
let ttf_context = sdl2::ttf::init().map_err(|e| GameError::Sdl(e.to_string()))?;
let video_subsystem = sdl_context.video().map_err(|e| GameError::Sdl(e.to_string()))?;
let audio_subsystem = sdl_context.audio().map_err(|e| GameError::Sdl(e.to_string()))?;
// TTF context is initialized within Game::new where it is leaked for font usage
let event_pump = sdl_context.event_pump().map_err(|e| GameError::Sdl(e.to_string()))?;
trace!(
width = (CANVAS_SIZE.x as f32 * SCALE).round() as u32,
height = (CANVAS_SIZE.y as f32 * SCALE).round() as u32,
scale = SCALE,
"Creating game window"
);
let window = video_subsystem
.window(
"Pac-Man",
@@ -72,7 +72,7 @@ impl App {
{
let mut names = drivers.keys().collect::<Vec<_>>();
names.sort_by_key(|k| get_driver(k));
debug!("Drivers: {names:?}")
trace!("Drivers: {names:?}")
}
// Count the number of times each pixel format is supported by each driver
@@ -84,11 +84,12 @@ impl App {
counts
});
debug!("Pixel format counts: {pixel_format_counts:?}");
trace!(pixel_format_counts = ?pixel_format_counts, "Available pixel formats per driver");
let index = get_driver("direct3d");
debug!("Driver index: {index:?}");
trace!(driver_index = ?index, "Selected graphics driver");
trace!("Creating hardware-accelerated canvas");
let mut canvas = window
.into_canvas()
.accelerated()
@@ -96,16 +97,23 @@ impl App {
.build()
.map_err(|e| GameError::Sdl(e.to_string()))?;
trace!(
logical_width = CANVAS_SIZE.x,
logical_height = CANVAS_SIZE.y,
"Setting canvas logical size"
);
canvas
.set_logical_size(CANVAS_SIZE.x, CANVAS_SIZE.y)
.map_err(|e| GameError::Sdl(e.to_string()))?;
debug!("Renderer: {:?}", canvas.info());
debug!(renderer_info = ?canvas.info(), "Canvas renderer initialized");
trace!("Creating texture factory");
let texture_creator = canvas.texture_creator();
let game = Game::new(canvas, texture_creator, event_pump)?;
// game.audio.set_mute(cfg!(debug_assertions));
info!("Starting game initialization");
let game = Game::new(canvas, ttf_context, texture_creator, event_pump)?;
info!("Application initialization completed successfully");
Ok(App {
game,
focused: true,

View File

@@ -1,24 +1,64 @@
#![allow(dead_code)]
//! Cross-platform asset loading abstraction.
//! On desktop, assets are embedded using include_bytes!; on Emscripten, assets are loaded from the filesystem.
use std::borrow::Cow;
use strum_macros::EnumIter;
use std::iter;
use crate::audio::Sound;
use crate::error::AssetError;
/// Enumeration of all game assets with cross-platform loading support.
///
/// Each variant corresponds to a specific file that can be loaded either from
/// binary-embedded data or embedded filesystem (Emscripten).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, EnumIter)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Asset {
Wav1,
Wav2,
Wav3,
Wav4,
/// Main sprite atlas containing all game graphics (atlas.png)
AtlasImage,
/// Terminal Vector font for text rendering (TerminalVector.ttf)
Font,
/// Sound file assets
SoundFile(Sound),
}
use strum::IntoEnumIterator;
impl Asset {
#[allow(dead_code)]
pub fn into_iter() -> AssetIter {
AssetIter {
sound_iter: None,
state: 0,
}
}
}
#[allow(clippy::type_complexity)]
pub struct AssetIter {
sound_iter: Option<iter::Map<<Sound as IntoEnumIterator>::Iterator, fn(Sound) -> Asset>>,
state: u8,
}
impl Iterator for AssetIter {
type Item = Asset;
fn next(&mut self) -> Option<Self::Item> {
match self.state {
0 => {
self.state = 1;
Some(Asset::AtlasImage)
}
1 => {
self.state = 2;
Some(Asset::Font)
}
2 => self
.sound_iter
.get_or_insert_with(|| Sound::iter().map(Asset::SoundFile))
.next(),
_ => None,
}
}
}
impl Asset {
@@ -27,39 +67,71 @@ impl Asset {
/// Paths are consistent across platforms and used by the Emscripten backend
/// for filesystem loading. Desktop builds embed assets directly and don't
/// use these paths at runtime.
#[allow(dead_code)]
pub fn path(&self) -> &str {
use Asset::*;
match self {
Wav1 => "sound/waka/1.ogg",
Wav2 => "sound/waka/2.ogg",
Wav3 => "sound/waka/3.ogg",
Wav4 => "sound/waka/4.ogg",
SoundFile(Sound::Waka(0)) => "sound/pacman/waka/1.ogg",
SoundFile(Sound::Waka(1)) => "sound/pacman/waka/2.ogg",
SoundFile(Sound::Waka(2)) => "sound/pacman/waka/3.ogg",
SoundFile(Sound::Waka(3..=u8::MAX)) => "sound/pacman/waka/4.ogg",
SoundFile(Sound::PacmanDeath) => "sound/pacman/death.ogg",
SoundFile(Sound::ExtraLife) => "sound/pacman/extra_life.ogg",
SoundFile(Sound::Fruit) => "sound/pacman/fruit.ogg",
SoundFile(Sound::Ghost) => "sound/pacman/ghost.ogg",
SoundFile(Sound::Beginning) => "sound/begin.ogg",
SoundFile(Sound::Intermission) => "sound/intermission.ogg",
AtlasImage => "atlas.png",
Font => "TerminalVector.ttf",
}
}
}
mod imp {
use super::*;
use crate::error::AssetError;
use crate::platform;
/// Loads asset bytes using the appropriate platform-specific method.
///
/// On desktop platforms, returns embedded compile-time data via `include_bytes!`.
/// On desktop platforms, returns embedded compile-time data via `rust-embed`.
/// On Emscripten, loads from the filesystem using the asset's path. The returned
/// `Cow` allows zero-copy access to embedded data while supporting owned data
/// when loaded from disk.
///
/// # Errors
///
/// Returns `AssetError::NotFound` if the asset file cannot be located (Emscripten only),
/// Returns `AssetError::NotFound` if the asset file cannot be located,
/// or `AssetError::Io` for filesystem I/O failures.
pub fn get_asset_bytes(asset: Asset) -> Result<Cow<'static, [u8]>, AssetError> {
platform::get_asset_bytes(asset)
pub fn get_bytes(&self) -> Result<Cow<'static, [u8]>, AssetError> {
use tracing::trace;
trace!(asset = ?self, "Loading game asset");
let result = self.get_bytes_platform();
match &result {
Ok(bytes) => trace!(asset = ?self, size_bytes = bytes.len(), "Asset loaded successfully"),
Err(e) => trace!(asset = ?self, error = ?e, "Asset loading failed"),
}
result
}
pub use imp::get_asset_bytes;
#[cfg(not(target_os = "emscripten"))]
fn get_bytes_platform(&self) -> Result<Cow<'static, [u8]>, AssetError> {
#[derive(rust_embed::Embed)]
#[folder = "assets/game/"]
struct EmbeddedAssets;
let path = self.path();
EmbeddedAssets::get(path)
.map(|file| file.data)
.ok_or_else(|| AssetError::NotFound(path.to_string()))
}
#[cfg(target_os = "emscripten")]
fn get_bytes_platform(&self) -> Result<Cow<'static, [u8]>, AssetError> {
use sdl2::rwops::RWops;
use std::io::{self, Read};
let path = format!("assets/game/{}", self.path());
let mut rwops = RWops::from_file(&path, "rb").map_err(|_| AssetError::NotFound(self.path().to_string()))?;
let len = rwops.len().ok_or_else(|| AssetError::NotFound(self.path().to_string()))?;
let mut buf = vec![0u8; len];
rwops.read_exact(&mut buf).map_err(|e| AssetError::Io(io::Error::other(e)))?;
Ok(Cow::Owned(buf))
}
}

View File

@@ -1,22 +1,53 @@
//! This module handles the audio playback for the game.
use crate::asset::{get_asset_bytes, Asset};
use std::collections::HashMap;
use crate::asset::Asset;
use sdl2::{
mixer::{self, Chunk, InitFlag, LoaderRWops, DEFAULT_FORMAT},
mixer::{self, Chunk, InitFlag, LoaderRWops, AUDIO_S16LSB, DEFAULT_CHANNELS},
rwops::RWops,
};
use strum::IntoEnumIterator;
const SOUND_ASSETS: [Asset; 4] = [Asset::Wav1, Asset::Wav2, Asset::Wav3, Asset::Wav4];
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Sound {
Waka(u8),
PacmanDeath,
ExtraLife,
Fruit,
Ghost,
Beginning,
Intermission,
}
impl IntoEnumIterator for Sound {
type Iterator = std::vec::IntoIter<Sound>;
fn iter() -> Self::Iterator {
vec![
Sound::Waka(0),
Sound::Waka(1),
Sound::Waka(2),
Sound::Waka(3),
Sound::PacmanDeath,
Sound::ExtraLife,
Sound::Fruit,
Sound::Ghost,
Sound::Beginning,
Sound::Intermission,
]
.into_iter()
}
}
/// The audio system for the game.
///
/// This struct is responsible for initializing the audio device, loading sounds,
/// and playing them. If audio fails to initialize, it will be disabled and all
/// functions will silently do nothing.
#[allow(dead_code)]
pub struct Audio {
_mixer_context: Option<mixer::Sdl2MixerContext>,
sounds: Vec<Chunk>,
next_sound_index: usize,
sounds: HashMap<Sound, Chunk>,
next_waka_index: u8,
muted: bool,
disabled: bool,
}
@@ -33,24 +64,36 @@ impl Audio {
/// If audio fails to initialize, the audio system will be disabled and
/// all functions will silently do nothing.
pub fn new() -> Self {
let frequency = 44100;
let format = DEFAULT_FORMAT;
let channels = 4;
let chunk_size = 256; // 256 is minimum for emscripten
let frequency = 16_000;
let format = AUDIO_S16LSB;
let chunk_size = {
// 256 is the minimum for Emscripten, but in practice 1024 is much more reliable
#[cfg(target_os = "emscripten")]
{
1024
}
// Otherwise, 256 is plenty safe.
#[cfg(not(target_os = "emscripten"))]
{
256
}
};
// Try to open audio, but don't panic if it fails
if let Err(e) = mixer::open_audio(frequency, format, 1, chunk_size) {
if let Err(e) = mixer::open_audio(frequency, format, DEFAULT_CHANNELS, chunk_size) {
tracing::warn!("Failed to open audio: {}. Audio will be disabled.", e);
return Self {
_mixer_context: None,
sounds: Vec::new(),
next_sound_index: 0,
sounds: HashMap::new(),
next_waka_index: 0u8,
muted: false,
disabled: true,
};
}
mixer::allocate_channels(channels);
let channels = 4;
mixer::allocate_channels(4);
// set channel volume
for i in 0..channels {
@@ -64,8 +107,8 @@ impl Audio {
tracing::warn!("Failed to initialize SDL2_mixer: {}. Audio will be disabled.", e);
return Self {
_mixer_context: None,
sounds: Vec::new(),
next_sound_index: 0,
sounds: HashMap::new(),
next_waka_index: 0u8,
muted: false,
disabled: true,
};
@@ -73,12 +116,15 @@ impl Audio {
};
// Try to load sounds, but don't panic if any fail
let mut sounds = Vec::new();
for (i, asset) in SOUND_ASSETS.iter().enumerate() {
match get_asset_bytes(*asset) {
let mut sounds = HashMap::new();
for (i, sound_type) in Sound::iter().enumerate() {
let asset = Asset::SoundFile(sound_type);
match asset.get_bytes() {
Ok(data) => match RWops::from_bytes(&data) {
Ok(rwops) => match rwops.load_wav() {
Ok(chunk) => sounds.push(chunk),
Ok(chunk) => {
sounds.insert(sound_type, chunk);
}
Err(e) => {
tracing::warn!("Failed to load sound {} from asset API: {}", i + 1, e);
}
@@ -93,13 +139,33 @@ impl Audio {
}
}
let death_sound = match Asset::SoundFile(Sound::PacmanDeath).get_bytes() {
Ok(data) => match RWops::from_bytes(&data) {
Ok(rwops) => match rwops.load_wav() {
Ok(chunk) => Some(chunk),
Err(e) => {
tracing::warn!("Failed to load death sound from asset API: {}", e);
None
}
},
Err(e) => {
tracing::warn!("Failed to create RWops for death sound: {}", e);
None
}
},
Err(e) => {
tracing::warn!("Failed to load death sound asset: {}", e);
None
}
};
// If no sounds loaded successfully, disable audio
if sounds.is_empty() {
if sounds.is_empty() && death_sound.is_none() {
tracing::warn!("No sounds loaded successfully. Audio will be disabled.");
return Self {
_mixer_context: Some(mixer_context),
sounds: Vec::new(),
next_sound_index: 0,
sounds: HashMap::new(),
next_waka_index: 0u8,
muted: false,
disabled: true,
};
@@ -108,7 +174,7 @@ impl Audio {
Audio {
_mixer_context: Some(mixer_context),
sounds,
next_sound_index: 0,
next_waka_index: 0u8,
muted: false,
disabled: false,
}
@@ -119,23 +185,54 @@ impl Audio {
/// Automatically rotates through the four eating sound assets. The sound plays on channel 0 and the internal sound index
/// advances to the next variant. Silently returns if audio is disabled, muted,
/// or no sounds were loaded successfully.
#[allow(dead_code)]
pub fn eat(&mut self) {
pub fn waka(&mut self) {
if self.disabled || self.muted || self.sounds.is_empty() {
return;
}
if let Some(chunk) = self.sounds.get(self.next_sound_index) {
match mixer::Channel(0).play(chunk, 0) {
if let Some(chunk) = self.sounds.get(&Sound::Waka(self.next_waka_index)) {
match mixer::Channel::all().play(chunk, 0) {
Ok(channel) => {
tracing::trace!("Playing sound #{} on channel {:?}", self.next_sound_index + 1, channel);
tracing::trace!("Playing sound #{} on channel {:?}", self.next_waka_index + 1, channel);
}
Err(e) => {
tracing::warn!("Could not play sound #{}: {}", self.next_sound_index + 1, e);
tracing::warn!("Could not play sound #{}: {}", self.next_waka_index + 1, e);
}
}
}
self.next_sound_index = (self.next_sound_index + 1) % self.sounds.len();
self.next_waka_index = (self.next_waka_index + 1) & 3;
}
/// Plays the provided sound effect once.
pub fn play(&mut self, sound: Sound) {
if self.disabled || self.muted {
return;
}
if let Some(chunk) = self.sounds.get(&sound) {
let _ = mixer::Channel::all().play(chunk, 0);
}
}
/// Halts all currently playing audio channels.
pub fn stop_all(&mut self) {
if !self.disabled {
mixer::Channel::all().halt();
}
}
/// Pauses all currently playing audio channels.
pub fn pause_all(&mut self) {
if !self.disabled {
mixer::Channel::all().pause();
}
}
/// Resumes all currently playing audio channels.
pub fn resume_all(&mut self) {
if !self.disabled {
mixer::Channel::all().resume();
}
}
/// Instantly mutes or unmutes all audio channels by adjusting their volume.
@@ -168,7 +265,6 @@ impl Audio {
/// Audio can be disabled due to SDL2_mixer initialization failures, missing
/// audio device, or failure to load any sound assets. When disabled, all
/// audio operations become no-ops.
#[allow(dead_code)]
pub fn is_disabled(&self) -> bool {
self.disabled
}

View File

@@ -1,3 +1,6 @@
#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
#![cfg_attr(coverage_nightly, coverage(off))]
use std::time::{Duration, Instant};
use sdl2::event::Event;

View File

@@ -1,3 +1,6 @@
#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
#![cfg_attr(coverage_nightly, coverage(off))]
use circular_buffer::CircularBuffer;
use pacman::constants::CANVAS_SIZE;
use sdl2::event::Event;

View File

@@ -25,12 +25,25 @@ pub const SCALE: f32 = 2.6;
/// screen for score display, player lives, and other UI elements.
pub const BOARD_CELL_OFFSET: UVec2 = UVec2::new(0, 3);
/// Bottom HUD row offset to reserve space below the game board.
///
/// The 2-cell vertical offset (16 pixels) provides space at the bottom of the
/// screen for displaying Pac-Man's lives (left) and fruit symbols (right).
pub const BOARD_BOTTOM_CELL_OFFSET: UVec2 = UVec2::new(0, 2);
/// Pixel-space equivalent of `BOARD_CELL_OFFSET` for rendering calculations.
///
/// Automatically calculated from the cell offset to maintain consistency
/// when the cell size changes. Used for positioning sprites and debug overlays.
pub const BOARD_PIXEL_OFFSET: UVec2 = UVec2::new(BOARD_CELL_OFFSET.x * CELL_SIZE, BOARD_CELL_OFFSET.y * CELL_SIZE);
/// Pixel-space equivalent of `BOARD_BOTTOM_CELL_OFFSET` for rendering calculations.
///
/// Automatically calculated from the cell offset to maintain consistency
/// when the cell size changes. Used for positioning bottom HUD elements.
pub const BOARD_BOTTOM_PIXEL_OFFSET: UVec2 =
UVec2::new(BOARD_BOTTOM_CELL_OFFSET.x * CELL_SIZE, BOARD_BOTTOM_CELL_OFFSET.y * CELL_SIZE);
/// Animation timing constants for ghost state management
pub mod animation {
/// Normal ghost movement animation speed (ticks per frame at 60 ticks/sec)
@@ -39,21 +52,23 @@ pub mod animation {
pub const GHOST_EATEN_SPEED: u16 = 6;
/// Frightened ghost animation speed (ticks per frame at 60 ticks/sec)
pub const GHOST_FRIGHTENED_SPEED: u16 = 12;
/// Time in ticks when frightened ghosts start flashing (2 seconds at 60 FPS)
pub const FRIGHTENED_FLASH_START_TICKS: u32 = 120;
/// Time in ticks for frightened ghosts to return to normal
pub const GHOST_FRIGHTENED_TICKS: u32 = 300;
/// Time in ticks when frightened ghosts start flashing
pub const GHOST_FRIGHTENED_FLASH_START_TICKS: u32 = GHOST_FRIGHTENED_TICKS - 120;
}
/// The size of the canvas, in pixels.
pub const CANVAS_SIZE: UVec2 = UVec2::new(
(BOARD_CELL_SIZE.x + BOARD_CELL_OFFSET.x) * CELL_SIZE,
(BOARD_CELL_SIZE.y + BOARD_CELL_OFFSET.y) * CELL_SIZE,
(BOARD_CELL_SIZE.x + BOARD_CELL_OFFSET.x + BOARD_BOTTOM_CELL_OFFSET.x) * CELL_SIZE,
(BOARD_CELL_SIZE.y + BOARD_CELL_OFFSET.y + BOARD_BOTTOM_CELL_OFFSET.y) * CELL_SIZE,
);
pub const LARGE_SCALE: f32 = 2.6;
pub const LARGE_CANVAS_SIZE: UVec2 = UVec2::new(
(((BOARD_CELL_SIZE.x + BOARD_CELL_OFFSET.x) * CELL_SIZE) as f32 * LARGE_SCALE) as u32,
(((BOARD_CELL_SIZE.y + BOARD_CELL_OFFSET.y) * CELL_SIZE) as f32 * LARGE_SCALE) as u32,
(((BOARD_CELL_SIZE.x + BOARD_CELL_OFFSET.x + BOARD_BOTTOM_CELL_OFFSET.x) * CELL_SIZE) as f32 * LARGE_SCALE) as u32,
(((BOARD_CELL_SIZE.y + BOARD_CELL_OFFSET.y + BOARD_BOTTOM_CELL_OFFSET.y) * CELL_SIZE) as f32 * LARGE_SCALE) as u32,
);
/// Collider size constants for different entity types
@@ -66,14 +81,16 @@ pub mod collider {
pub const PELLET_SIZE: f32 = CELL_SIZE as f32 * 0.4;
/// Collider size for power pellets/energizers (0.95x cell size)
pub const POWER_PELLET_SIZE: f32 = CELL_SIZE as f32 * 0.95;
/// Collider size for fruits (0.8x cell size)
pub const FRUIT_SIZE: f32 = CELL_SIZE as f32 * 1.375;
}
/// UI and rendering constants
pub mod ui {
/// Debug font size in points
pub const DEBUG_FONT_SIZE: u16 = 12;
/// Power pellet blink rate in seconds
pub const POWER_PELLET_BLINK_RATE: f32 = 0.2;
/// Power pellet blink rate in ticks (at 60 FPS, 12 ticks = 0.2 seconds)
pub const POWER_PELLET_BLINK_RATE: u32 = 12;
}
/// Map tile types that define gameplay behavior and collision properties.
@@ -132,8 +149,6 @@ pub const RAW_BOARD: [&str; BOARD_CELL_SIZE.y as usize] = [
pub mod startup {
/// Number of frames for the startup sequence (3 seconds at 60 FPS)
pub const STARTUP_FRAMES: u32 = 60 * 3;
/// Number of ticks per frame during startup
pub const STARTUP_TICKS_PER_FRAME: u32 = 60;
}
/// Game mechanics constants

View File

@@ -46,19 +46,16 @@ pub enum AssetError {
#[error("IO error: {0}")]
Io(#[from] io::Error),
#[allow(dead_code)]
#[error("Asset not found: {0}")]
NotFound(String),
}
/// Platform-specific errors.
#[derive(thiserror::Error, Debug)]
#[allow(dead_code)]
pub enum PlatformError {
#[error("Console initialization failed: {0}")]
#[cfg(any(windows, target_os = "emscripten"))]
ConsoleInit(String),
#[error("Platform-specific error: {0}")]
Other(String),
}
/// Error type for map parsing operations.
@@ -110,55 +107,3 @@ pub enum MapError {
/// Result type for game operations.
pub type GameResult<T> = Result<T, GameError>;
/// Helper trait for converting other error types to GameError.
pub trait IntoGameError<T> {
#[allow(dead_code)]
fn into_game_error(self) -> GameResult<T>;
}
impl<T, E> IntoGameError<T> for Result<T, E>
where
E: std::error::Error + Send + Sync + 'static,
{
fn into_game_error(self) -> GameResult<T> {
self.map_err(|e| GameError::InvalidState(e.to_string()))
}
}
/// Helper trait for converting Option to GameResult with a custom error.
pub trait OptionExt<T> {
#[allow(dead_code)]
fn ok_or_game_error<F>(self, f: F) -> GameResult<T>
where
F: FnOnce() -> GameError;
}
impl<T> OptionExt<T> for Option<T> {
fn ok_or_game_error<F>(self, f: F) -> GameResult<T>
where
F: FnOnce() -> GameError,
{
self.ok_or_else(f)
}
}
/// Helper trait for converting Result to GameResult with context.
pub trait ResultExt<T, E> {
#[allow(dead_code)]
fn with_context<F>(self, f: F) -> GameResult<T>
where
F: FnOnce(&E) -> GameError;
}
impl<T, E> ResultExt<T, E> for Result<T, E>
where
E: std::error::Error + Send + Sync + 'static,
{
fn with_context<F>(self, f: F) -> GameResult<T>
where
F: FnOnce(&E) -> GameError,
{
self.map_err(|e| f(&e))
}
}

View File

@@ -1,6 +1,6 @@
use bevy_ecs::{entity::Entity, event::Event};
use crate::map::direction::Direction;
use crate::{map::direction::Direction, systems::Ghost};
/// Player input commands that trigger specific game actions.
///
@@ -24,15 +24,12 @@ pub enum GameCommand {
/// Global events that flow through the ECS event system to coordinate game behavior.
///
/// Events enable loose coupling between systems - input generates commands, collision
/// detection reports overlaps, and various systems respond appropriately without
/// direct dependencies.
/// Events enable loose coupling between systems - input generates commands and
/// various systems respond appropriately without direct dependencies.
#[derive(Event, Clone, Copy, Debug, PartialEq, Eq)]
pub enum GameEvent {
/// Player input command to be processed by relevant game systems
Command(GameCommand),
/// Physical overlap detected between two entities requiring gameplay response
Collision(Entity, Entity),
}
impl From<GameCommand> for GameEvent {
@@ -40,3 +37,22 @@ impl From<GameCommand> for GameEvent {
GameEvent::Command(command)
}
}
/// Data for requesting stage transitions; processed centrally in stage_system
#[derive(Event, Clone, Copy, Debug, PartialEq, Eq)]
pub enum StageTransition {
GhostEatenPause { ghost_entity: Entity, ghost_type: Ghost },
}
/// Collision triggers for immediate collision handling via observers
#[derive(Event, Clone, Copy, Debug, PartialEq, Eq)]
pub enum CollisionTrigger {
/// Pac-Man collided with a ghost
GhostCollision {
pacman: Entity,
ghost: Entity,
ghost_type: Ghost,
},
/// Pac-Man collided with an item
ItemCollision { item: Entity },
}

View File

@@ -4,9 +4,9 @@ use std::fmt;
use std::sync::atomic::{AtomicU64, Ordering};
use time::macros::format_description;
use time::{format_description::FormatItem, OffsetDateTime};
use tracing::{Event, Subscriber};
use tracing::{Event, Level, Subscriber};
use tracing_subscriber::fmt::format::Writer;
use tracing_subscriber::fmt::{FmtContext, FormatEvent, FormatFields};
use tracing_subscriber::fmt::{FmtContext, FormatEvent, FormatFields, FormattedFields};
use tracing_subscriber::registry::LookupSpan;
/// Global atomic counter for tracking game ticks
@@ -25,15 +25,7 @@ const TIMESTAMP_FORMAT: &[FormatItem<'static>] = format_description!("[hour]:[mi
/// A custom formatter that includes both timestamp and tick counter in hexadecimal
///
/// This formatter provides:
/// - High-precision timestamps (HH:MM:SS.mmm on Emscripten, HH:MM:SS.mmmmm otherwise)
/// - Hexadecimal tick counter for frame correlation
/// - Standard log level and target information
///
/// Performance considerations:
/// - Timestamp format is cached at compile time
/// - Tick counter access is atomic and very fast
/// - Combined formatting operations for efficiency
/// Re-implementation of the Full formatter to add a tick counter and timestamp.
pub struct CustomFormatter;
impl<S, N> FormatEvent<S, N> for CustomFormatter
@@ -42,35 +34,109 @@ where
N: for<'a> FormatFields<'a> + 'static,
{
fn format_event(&self, ctx: &FmtContext<'_, S, N>, mut writer: Writer<'_>, event: &Event<'_>) -> fmt::Result {
// Format timestamp using cached format description
let meta = event.metadata();
// 1) Timestamp (dimmed when ANSI)
let now = OffsetDateTime::now_utc();
let formatted_time = now.format(&TIMESTAMP_FORMAT).map_err(|e| {
// Preserve the original error information for debugging
eprintln!("Failed to format timestamp: {}", e);
fmt::Error
})?;
write_dimmed(&mut writer, formatted_time)?;
writer.write_char(' ')?;
// Get tick count and format everything together
let tick_count = get_tick_count();
let metadata = event.metadata();
// 2) Tick counter, dim when ANSI
let tick_count = get_tick_count() & TICK_DISPLAY_MASK;
if writer.has_ansi_escapes() {
write!(writer, "\x1b[2m0x{:04X}\x1b[0m ", tick_count)?;
} else {
write!(writer, "0x{:04X} ", tick_count)?;
}
// Combined formatting: timestamp, tick counter, level, and target in one write
write!(
writer,
"{} 0x{:04X} {:5} {}: ",
formatted_time,
tick_count & TICK_DISPLAY_MASK,
metadata.level(),
metadata.target()
)?;
// 3) Colored 5-char level like Full
write_colored_level(&mut writer, meta.level())?;
writer.write_char(' ')?;
// Format the fields (the actual log message)
ctx.field_format().format_fields(writer.by_ref(), event)?;
// 4) Span scope chain (bold names, fields in braces, dimmed ':')
if let Some(scope) = ctx.event_scope() {
let mut saw_any = false;
for span in scope.from_root() {
write_bold(&mut writer, span.metadata().name())?;
saw_any = true;
let ext = span.extensions();
if let Some(fields) = &ext.get::<FormattedFields<N>>() {
if !fields.is_empty() {
write_bold(&mut writer, "{")?;
write!(writer, "{}", fields)?;
write_bold(&mut writer, "}")?;
}
}
if writer.has_ansi_escapes() {
write!(writer, "\x1b[2m:\x1b[0m")?;
} else {
writer.write_char(':')?;
}
}
if saw_any {
writer.write_char(' ')?;
}
}
// 5) Target (dimmed), then a space
if writer.has_ansi_escapes() {
write!(writer, "\x1b[2m{}\x1b[0m\x1b[2m:\x1b[0m ", meta.target())?;
} else {
write!(writer, "{}: ", meta.target())?;
}
// 6) Event fields
ctx.format_fields(writer.by_ref(), event)?;
// 7) Newline
writeln!(writer)
}
}
/// Write the verbosity level with the same coloring/alignment as the Full formatter.
fn write_colored_level(writer: &mut Writer<'_>, level: &Level) -> fmt::Result {
if writer.has_ansi_escapes() {
// Basic ANSI color sequences; reset with \x1b[0m
let (color, text) = match *level {
Level::TRACE => ("\x1b[35m", "TRACE"), // purple
Level::DEBUG => ("\x1b[34m", "DEBUG"), // blue
Level::INFO => ("\x1b[32m", " INFO"), // green, note leading space
Level::WARN => ("\x1b[33m", " WARN"), // yellow, note leading space
Level::ERROR => ("\x1b[31m", "ERROR"), // red
};
write!(writer, "{}{}\x1b[0m", color, text)
} else {
// Right-pad to width 5 like Full's non-ANSI mode
match *level {
Level::TRACE => write!(writer, "{:>5}", "TRACE"),
Level::DEBUG => write!(writer, "{:>5}", "DEBUG"),
Level::INFO => write!(writer, "{:>5}", " INFO"),
Level::WARN => write!(writer, "{:>5}", " WARN"),
Level::ERROR => write!(writer, "{:>5}", "ERROR"),
}
}
}
fn write_dimmed(writer: &mut Writer<'_>, s: impl fmt::Display) -> fmt::Result {
if writer.has_ansi_escapes() {
write!(writer, "\x1b[2m{}\x1b[0m", s)
} else {
write!(writer, "{}", s)
}
}
fn write_bold(writer: &mut Writer<'_>, s: impl fmt::Display) -> fmt::Result {
if writer.has_ansi_escapes() {
write!(writer, "\x1b[1m{}\x1b[0m", s)
} else {
write!(writer, "{}", s)
}
}
/// Increment the global tick counter by 1
///
/// This should be called once per game tick/frame from the main game loop
@@ -84,11 +150,3 @@ pub fn increment_tick() {
pub fn get_tick_count() -> u64 {
TICK_COUNTER.load(Ordering::Relaxed)
}
/// Reset the tick counter to 0
///
/// This can be used for testing or when restarting the game
#[allow(dead_code)]
pub fn reset_tick_counter() {
TICK_COUNTER.store(0, Ordering::Relaxed);
}

View File

@@ -3,38 +3,37 @@
include!(concat!(env!("OUT_DIR"), "/atlas_data.rs"));
use std::collections::HashMap;
use std::ops::Not;
use tracing::{debug, info, trace, warn};
use crate::constants::{self, animation, MapTile, CANVAS_SIZE};
use crate::error::{GameError, GameResult, TextureError};
use crate::events::GameEvent;
use crate::error::{GameError, GameResult};
use crate::events::{CollisionTrigger, GameEvent, StageTransition};
use crate::map::builder::Map;
use crate::map::direction::Direction;
use crate::systems::blinking::Blinking;
use crate::systems::components::{GhostAnimation, GhostState, LastAnimationState};
use crate::systems::movement::{BufferedDirection, Position, Velocity};
use crate::systems::profiling::SystemId;
use crate::systems::render::touch_ui_render_system;
use crate::systems::render::RenderDirty;
use crate::systems::item::PelletCount;
use crate::systems::state::IntroPlayed;
use crate::systems::{
self, combined_render_system, ghost_collision_system, present_system, Hidden, LinearAnimation, MovementModifiers, NodeId,
};
use crate::systems::{
audio_system, blinking_system, collision_system, directional_render_system, dirty_render_system, eaten_ghost_system,
ghost_movement_system, ghost_state_system, hud_render_system, item_system, linear_render_system, profile, AudioEvent,
AudioResource, AudioState, BackbufferResource, Collider, DebugState, DebugTextureResource, DeltaTime, DirectionalAnimation,
EntityType, Frozen, Ghost, GhostAnimations, GhostBundle, GhostCollider, GlobalState, ItemBundle, ItemCollider,
MapTextureResource, PacmanCollider, PlayerBundle, PlayerControlled, Renderable, ScoreResource, StartupSequence,
SystemTimings,
self, audio_system, blinking_system, collision_system, combined_render_system, directional_render_system,
dirty_render_system, eaten_ghost_system, fruit_sprite_system, ghost_collision_observer, ghost_movement_system,
ghost_state_system, hud_render_system, item_collision_observer, linear_render_system, player_life_sprite_system,
present_system, profile, time_to_live_system, touch_ui_render_system, AudioEvent, AudioResource, AudioState,
BackbufferResource, Blinking, BufferedDirection, Collider, DebugState, DebugTextureResource, DeltaTime, DirectionalAnimation,
EntityType, Frozen, FruitSprites, GameStage, Ghost, GhostAnimation, GhostAnimations, GhostBundle, GhostCollider, GhostState,
GlobalState, ItemBundle, ItemCollider, LastAnimationState, LinearAnimation, MapTextureResource, MovementModifiers, NodeId,
PacmanCollider, Paused, PlayerAnimation, PlayerBundle, PlayerControlled, PlayerDeathAnimation, PlayerLives, Position,
RenderDirty, Renderable, ScoreResource, StartupSequence, SystemId, SystemTimings, Timing, TouchState, Velocity, Visibility,
};
use crate::texture::animated::{DirectionalTiles, TileSequence};
use crate::texture::sprite::AtlasTile;
use crate::texture::sprites::{FrightenedColor, GameSprite, GhostSprite, MazeSprite, PacmanSprite};
use bevy_ecs::change_detection::DetectChanges;
use bevy_ecs::event::EventRegistry;
use bevy_ecs::observer::Trigger;
use bevy_ecs::schedule::common_conditions::resource_changed;
use bevy_ecs::schedule::{Condition, IntoScheduleConfigs, Schedule, SystemSet};
use bevy_ecs::system::{Local, ResMut};
use bevy_ecs::schedule::{IntoScheduleConfigs, Schedule, SystemSet};
use bevy_ecs::system::{Local, Res, ResMut};
use bevy_ecs::world::World;
use glam::UVec2;
use sdl2::event::EventType;
use sdl2::image::LoadTexture;
use sdl2::render::{BlendMode, Canvas, ScaleMode, TextureCreator};
@@ -43,17 +42,31 @@ use sdl2::video::{Window, WindowContext};
use sdl2::EventPump;
use crate::{
asset::{get_asset_bytes, Asset},
asset::Asset,
events::GameCommand,
map::render::MapRenderer,
systems::debug::{BatchedLinesResource, TtfAtlasResource},
systems::input::{Bindings, CursorPosition},
systems::{BatchedLinesResource, Bindings, CursorPosition, TtfAtlasResource},
texture::sprite::{AtlasMapper, SpriteAtlas},
};
/// System set for all gameplay systems to ensure they run after input processing
#[derive(SystemSet, Debug, Hash, PartialEq, Eq, Clone)]
enum GameplaySet {
/// Gameplay systems that process inputs
Input,
/// Gameplay systems that update the game state
Update,
/// Gameplay systems that respond to events
Respond,
}
/// System set for all rendering systems to ensure they run after gameplay logic
#[derive(SystemSet, Debug, Hash, PartialEq, Eq, Clone)]
pub struct RenderSet;
enum RenderSet {
Animation,
Draw,
Present,
}
/// Core game state manager built on the Bevy ECS architecture.
///
@@ -88,10 +101,80 @@ impl Game {
/// errors, or entity initialization issues.
pub fn new(
mut canvas: Canvas<Window>,
ttf_context: sdl2::ttf::Sdl2TtfContext,
texture_creator: TextureCreator<WindowContext>,
mut event_pump: EventPump,
) -> GameResult<Game> {
// Disable uninteresting events
info!("Starting game initialization");
debug!("Disabling unnecessary SDL events");
Self::disable_sdl_events(&mut event_pump);
debug!("Setting up textures and fonts");
let (backbuffer, mut map_texture, debug_texture, ttf_atlas) =
Self::setup_textures_and_fonts(&mut canvas, &texture_creator, ttf_context)?;
debug!("Initializing audio subsystem");
let audio = crate::audio::Audio::new();
debug!("Loading sprite atlas and map tiles");
let (mut atlas, map_tiles) = Self::load_atlas_and_map_tiles(&texture_creator)?;
debug!("Rendering static map to texture cache");
canvas
.with_texture_canvas(&mut map_texture, |map_canvas| {
MapRenderer::render_map(map_canvas, &mut atlas, &map_tiles);
})
.map_err(|e| GameError::Sdl(e.to_string()))?;
debug!("Building navigation graph from map layout");
let map = Map::new(constants::RAW_BOARD)?;
debug!("Creating player animations and bundle");
let (player_animation, player_start_sprite) = Self::create_player_animations(&atlas)?;
let player_bundle = Self::create_player_bundle(&map, player_animation, player_start_sprite);
debug!("Creating death animation sequence");
let death_animation = Self::create_death_animation(&atlas)?;
debug!("Initializing ECS world and system schedule");
let mut world = World::default();
let mut schedule = Schedule::default();
debug!("Setting up ECS event registry and observers");
Self::setup_ecs(&mut world);
world.add_observer(systems::spawn_fruit_observer);
debug!("Inserting resources into ECS world");
Self::insert_resources(
&mut world,
map,
audio,
atlas,
event_pump,
canvas,
backbuffer,
map_texture,
debug_texture,
ttf_atlas,
death_animation,
)?;
debug!("Configuring system execution schedule");
Self::configure_schedule(&mut schedule);
debug!("Spawning player entity");
world.spawn(player_bundle).insert((Frozen, Visibility::hidden()));
info!("Spawning game entities");
Self::spawn_ghosts(&mut world)?;
Self::spawn_items(&mut world)?;
info!("Game initialization completed successfully");
Ok(Game { world, schedule })
}
fn disable_sdl_events(event_pump: &mut EventPump) {
for event_type in [
EventType::JoyAxisMotion,
EventType::JoyBallMotion,
@@ -109,9 +192,6 @@ impl Game {
EventType::ControllerTouchpadDown,
EventType::ControllerTouchpadMotion,
EventType::ControllerTouchpadUp,
// EventType::FingerDown, // Enable for touch controls
// EventType::FingerUp, // Enable for touch controls
// EventType::FingerMotion, // Enable for touch controls
EventType::DollarGesture,
EventType::DollarRecord,
EventType::MultiGesture,
@@ -128,11 +208,7 @@ impl Game {
EventType::TextInput,
EventType::TextEditing,
EventType::Display,
// EventType::Window,
EventType::MouseWheel,
// EventType::MouseMotion,
// EventType::MouseButtonDown, // Enable for desktop touch testing
// EventType::MouseButtonUp, // Enable for desktop touch testing
EventType::AppDidEnterBackground,
EventType::AppWillEnterForeground,
EventType::AppWillEnterBackground,
@@ -144,8 +220,18 @@ impl Game {
] {
event_pump.disable_event(event_type);
}
}
let ttf_context = Box::leak(Box::new(sdl2::ttf::init().map_err(|e| GameError::Sdl(e.to_string()))?));
fn setup_textures_and_fonts(
canvas: &mut Canvas<Window>,
texture_creator: &TextureCreator<WindowContext>,
ttf_context: sdl2::ttf::Sdl2TtfContext,
) -> GameResult<(
sdl2::render::Texture,
sdl2::render::Texture,
sdl2::render::Texture,
crate::texture::ttf::TtfAtlas,
)> {
let mut backbuffer = texture_creator
.create_texture_target(None, CANVAS_SIZE.x, CANVAS_SIZE.y)
.map_err(|e| GameError::Sdl(e.to_string()))?;
@@ -156,32 +242,28 @@ impl Game {
.map_err(|e| GameError::Sdl(e.to_string()))?;
map_texture.set_scale_mode(ScaleMode::Nearest);
// Create debug texture at output resolution for crisp debug rendering
let output_size = constants::LARGE_CANVAS_SIZE;
let mut debug_texture = texture_creator
.create_texture_target(Some(sdl2::pixels::PixelFormatEnum::ARGB8888), output_size.x, output_size.y)
.map_err(|e| GameError::Sdl(e.to_string()))?;
// Debug texture is copied over the backbuffer, it requires transparency abilities
debug_texture.set_blend_mode(BlendMode::Blend);
debug_texture.set_scale_mode(ScaleMode::Nearest);
// Create debug text atlas for efficient debug rendering
let font_data: &'static [u8] = get_asset_bytes(Asset::Font)?.to_vec().leak();
let font_data: &'static [u8] = Asset::Font.get_bytes()?.to_vec().leak();
let font_asset = RWops::from_bytes(font_data).map_err(|_| GameError::Sdl("Failed to load font".to_string()))?;
let debug_font = ttf_context
.load_font_from_rwops(font_asset, constants::ui::DEBUG_FONT_SIZE)
.map_err(|e| GameError::Sdl(e.to_string()))?;
let mut ttf_atlas = crate::texture::ttf::TtfAtlas::new(&texture_creator, &debug_font)?;
// Populate the atlas with actual character data
ttf_atlas.populate_atlas(&mut canvas, &texture_creator, &debug_font)?;
let mut ttf_atlas = crate::texture::ttf::TtfAtlas::new(texture_creator, &debug_font)?;
ttf_atlas.populate_atlas(canvas, texture_creator, &debug_font)?;
// Initialize audio system
let audio = crate::audio::Audio::new();
Ok((backbuffer, map_texture, debug_texture, ttf_atlas))
}
// Load atlas and create map texture
let atlas_bytes = get_asset_bytes(Asset::AtlasImage)?;
fn load_atlas_and_map_tiles(texture_creator: &TextureCreator<WindowContext>) -> GameResult<(SpriteAtlas, Vec<AtlasTile>)> {
trace!("Loading atlas image from embedded assets");
let atlas_bytes = Asset::AtlasImage.get_bytes()?;
let atlas_texture = texture_creator.load_texture_bytes(&atlas_bytes).map_err(|e| {
if e.to_string().contains("format") || e.to_string().contains("unsupported") {
GameError::Texture(crate::error::TextureError::InvalidFormat(format!(
@@ -192,60 +274,49 @@ impl Game {
}
})?;
debug!(frame_count = ATLAS_FRAMES.len(), "Creating sprite atlas from texture");
let atlas_mapper = AtlasMapper {
frames: ATLAS_FRAMES.into_iter().map(|(k, v)| (k.to_string(), *v)).collect(),
};
let mut atlas = SpriteAtlas::new(atlas_texture, atlas_mapper);
let atlas = SpriteAtlas::new(atlas_texture, atlas_mapper);
// Create map tiles
trace!("Extracting map tile sprites from atlas");
let mut map_tiles = Vec::with_capacity(35);
for i in 0..35 {
let tile_name = format!("maze/tiles/{}.png", i);
let tile = atlas.get_tile(&tile_name).unwrap();
let tile_name = GameSprite::Maze(MazeSprite::Tile(i)).to_path();
let tile = atlas.get_tile(&tile_name)?;
map_tiles.push(tile);
}
// Render map to texture
canvas
.with_texture_canvas(&mut map_texture, |map_canvas| {
MapRenderer::render_map(map_canvas, &mut atlas, &map_tiles);
})
.map_err(|e| GameError::Sdl(e.to_string()))?;
Ok((atlas, map_tiles))
}
let map = Map::new(constants::RAW_BOARD)?;
// Create directional animated textures for Pac-Man
fn create_player_animations(atlas: &SpriteAtlas) -> GameResult<(DirectionalAnimation, AtlasTile)> {
let up_moving_tiles = [
SpriteAtlas::get_tile(&atlas, "pacman/up_a.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/up_a.png".to_string())))?,
SpriteAtlas::get_tile(&atlas, "pacman/up_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/up_b.png".to_string())))?,
SpriteAtlas::get_tile(&atlas, "pacman/full.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/full.png".to_string())))?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Moving(Direction::Up, 0)).to_path())?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Moving(Direction::Up, 1)).to_path())?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Full).to_path())?,
];
let down_moving_tiles = [
SpriteAtlas::get_tile(&atlas, "pacman/down_a.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/down_a.png".to_string())))?,
SpriteAtlas::get_tile(&atlas, "pacman/down_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/down_b.png".to_string())))?,
SpriteAtlas::get_tile(&atlas, "pacman/full.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/full.png".to_string())))?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Moving(Direction::Down, 0)).to_path())?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Moving(Direction::Down, 1)).to_path())?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Full).to_path())?,
];
let left_moving_tiles = [
SpriteAtlas::get_tile(&atlas, "pacman/left_a.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/left_a.png".to_string())))?,
SpriteAtlas::get_tile(&atlas, "pacman/left_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/left_b.png".to_string())))?,
SpriteAtlas::get_tile(&atlas, "pacman/full.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/full.png".to_string())))?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Moving(Direction::Left, 0)).to_path())?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Moving(Direction::Left, 1)).to_path())?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Full).to_path())?,
];
let right_moving_tiles = [
SpriteAtlas::get_tile(&atlas, "pacman/right_a.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/right_a.png".to_string())))?,
SpriteAtlas::get_tile(&atlas, "pacman/right_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/right_b.png".to_string())))?,
SpriteAtlas::get_tile(&atlas, "pacman/full.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/full.png".to_string())))?,
SpriteAtlas::get_tile(
atlas,
&GameSprite::Pacman(PacmanSprite::Moving(Direction::Right, 0)).to_path(),
)?,
SpriteAtlas::get_tile(
atlas,
&GameSprite::Pacman(PacmanSprite::Moving(Direction::Right, 1)).to_path(),
)?,
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Full).to_path())?,
];
let moving_tiles = DirectionalTiles::new(
@@ -255,14 +326,16 @@ impl Game {
TileSequence::new(&right_moving_tiles),
);
let up_stopped_tile = SpriteAtlas::get_tile(&atlas, "pacman/up_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/up_b.png".to_string())))?;
let down_stopped_tile = SpriteAtlas::get_tile(&atlas, "pacman/down_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/down_b.png".to_string())))?;
let left_stopped_tile = SpriteAtlas::get_tile(&atlas, "pacman/left_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/left_b.png".to_string())))?;
let right_stopped_tile = SpriteAtlas::get_tile(&atlas, "pacman/right_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/right_b.png".to_string())))?;
let up_stopped_tile =
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Moving(Direction::Up, 1)).to_path())?;
let down_stopped_tile =
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Moving(Direction::Down, 1)).to_path())?;
let left_stopped_tile =
SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Moving(Direction::Left, 1)).to_path())?;
let right_stopped_tile = SpriteAtlas::get_tile(
atlas,
&GameSprite::Pacman(PacmanSprite::Moving(Direction::Right, 1)).to_path(),
)?;
let stopped_tiles = DirectionalTiles::new(
TileSequence::new(&[up_stopped_tile]),
@@ -271,7 +344,26 @@ impl Game {
TileSequence::new(&[right_stopped_tile]),
);
let player = PlayerBundle {
let player_animation = DirectionalAnimation::new(moving_tiles, stopped_tiles, 5);
let player_start_sprite = SpriteAtlas::get_tile(atlas, &GameSprite::Pacman(PacmanSprite::Full).to_path())?;
Ok((player_animation, player_start_sprite))
}
fn create_death_animation(atlas: &SpriteAtlas) -> GameResult<LinearAnimation> {
let mut death_tiles = Vec::new();
for i in 0..=10 {
// Assuming death animation has 11 frames named pacman/die_0, pacman/die_1, etc.
let tile = atlas.get_tile(&GameSprite::Pacman(PacmanSprite::Dying(i)).to_path())?;
death_tiles.push(tile);
}
let tile_sequence = TileSequence::new(&death_tiles);
Ok(LinearAnimation::new(tile_sequence, 8)) // 8 ticks per frame, non-looping
}
fn create_player_bundle(map: &Map, player_animation: DirectionalAnimation, player_start_sprite: AtlasTile) -> PlayerBundle {
PlayerBundle {
player: PlayerControlled,
position: Position::Stopped {
node: map.start_positions.pacman,
@@ -283,54 +375,24 @@ impl Game {
movement_modifiers: MovementModifiers::default(),
buffered_direction: BufferedDirection::None,
sprite: Renderable {
sprite: SpriteAtlas::get_tile(&atlas, "pacman/full.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("pacman/full.png".to_string())))?,
sprite: player_start_sprite,
layer: 0,
},
directional_animation: DirectionalAnimation::new(moving_tiles, stopped_tiles, 5),
directional_animation: player_animation,
entity_type: EntityType::Player,
collider: Collider {
size: constants::collider::PLAYER_GHOST_SIZE,
},
pacman_collider: PacmanCollider,
};
}
}
let mut world = World::default();
let mut schedule = Schedule::default();
EventRegistry::register_event::<GameError>(&mut world);
EventRegistry::register_event::<GameEvent>(&mut world);
EventRegistry::register_event::<AudioEvent>(&mut world);
let scale =
(UVec2::from(canvas.output_size().unwrap()).as_vec2() / UVec2::from(canvas.logical_size()).as_vec2()).min_element();
world.insert_resource(BatchedLinesResource::new(&map, scale));
world.insert_resource(Self::create_ghost_animations(&atlas)?);
world.insert_resource(map);
world.insert_resource(GlobalState { exit: false });
world.insert_resource(ScoreResource(0));
world.insert_resource(SystemTimings::default());
world.insert_resource(Bindings::default());
world.insert_resource(DeltaTime(0f32));
world.insert_resource(RenderDirty::default());
world.insert_resource(DebugState::default());
world.insert_resource(AudioState::default());
world.insert_resource(CursorPosition::default());
world.insert_resource(systems::input::TouchState::default());
world.insert_resource(StartupSequence::new(
constants::startup::STARTUP_FRAMES,
constants::startup::STARTUP_TICKS_PER_FRAME,
));
world.insert_non_send_resource(atlas);
world.insert_non_send_resource(event_pump);
world.insert_non_send_resource::<&mut Canvas<Window>>(Box::leak(Box::new(canvas)));
world.insert_non_send_resource(BackbufferResource(backbuffer));
world.insert_non_send_resource(MapTextureResource(map_texture));
world.insert_non_send_resource(DebugTextureResource(debug_texture));
world.insert_non_send_resource(TtfAtlasResource(ttf_atlas));
world.insert_non_send_resource(AudioResource(audio));
fn setup_ecs(world: &mut World) {
EventRegistry::register_event::<GameError>(world);
EventRegistry::register_event::<GameEvent>(world);
EventRegistry::register_event::<AudioEvent>(world);
EventRegistry::register_event::<StageTransition>(world);
EventRegistry::register_event::<CollisionTrigger>(world);
world.add_observer(
|event: Trigger<GameEvent>, mut state: ResMut<GlobalState>, _score: ResMut<ScoreResource>| {
@@ -340,73 +402,154 @@ impl Game {
},
);
world.add_observer(ghost_collision_observer);
world.add_observer(item_collision_observer);
}
#[allow(clippy::too_many_arguments)]
fn insert_resources(
world: &mut World,
map: Map,
audio: crate::audio::Audio,
atlas: SpriteAtlas,
event_pump: EventPump,
canvas: Canvas<Window>,
backbuffer: sdl2::render::Texture,
map_texture: sdl2::render::Texture,
debug_texture: sdl2::render::Texture,
ttf_atlas: crate::texture::ttf::TtfAtlas,
death_animation: LinearAnimation,
) -> GameResult<()> {
world.insert_non_send_resource(atlas);
world.insert_resource(Self::create_ghost_animations(world.non_send_resource::<SpriteAtlas>())?);
let player_animation = Self::create_player_animations(world.non_send_resource::<SpriteAtlas>())?.0;
world.insert_resource(PlayerAnimation(player_animation));
world.insert_resource(PlayerDeathAnimation(death_animation));
world.insert_resource(FruitSprites::default());
world.insert_resource(BatchedLinesResource::new(&map, constants::LARGE_SCALE));
world.insert_resource(map);
world.insert_resource(GlobalState { exit: false });
world.insert_resource(PlayerLives::default());
world.insert_resource(ScoreResource(0));
world.insert_resource(PelletCount(0));
world.insert_resource(SystemTimings::default());
world.insert_resource(Timing::default());
world.insert_resource(Bindings::default());
world.insert_resource(DeltaTime { seconds: 0.0, ticks: 0 });
world.insert_resource(RenderDirty::default());
world.insert_resource(DebugState::default());
world.insert_resource(AudioState::default());
world.insert_resource(IntroPlayed::default());
world.insert_resource(CursorPosition::default());
world.insert_resource(TouchState::default());
world.insert_resource(GameStage::Starting(StartupSequence::TextOnly {
remaining_ticks: constants::startup::STARTUP_FRAMES,
}));
world.insert_resource(Paused(false));
world.insert_non_send_resource(event_pump);
world.insert_non_send_resource::<&mut Canvas<Window>>(Box::leak(Box::new(canvas)));
world.insert_non_send_resource(BackbufferResource(backbuffer));
world.insert_non_send_resource(MapTextureResource(map_texture));
world.insert_non_send_resource(DebugTextureResource(debug_texture));
world.insert_non_send_resource(TtfAtlasResource(ttf_atlas));
world.insert_non_send_resource(AudioResource(audio));
Ok(())
}
fn configure_schedule(schedule: &mut Schedule) {
let stage_system = profile(SystemId::Stage, systems::stage_system);
let input_system = profile(SystemId::Input, systems::input::input_system);
let pause_system = profile(SystemId::Input, systems::handle_pause_command);
let player_control_system = profile(SystemId::PlayerControls, systems::player_control_system);
let player_movement_system = profile(SystemId::PlayerMovement, systems::player_movement_system);
let startup_stage_system = profile(SystemId::Stage, systems::startup_stage_system);
let player_tunnel_slowdown_system = profile(SystemId::PlayerMovement, systems::player::player_tunnel_slowdown_system);
let ghost_movement_system = profile(SystemId::Ghost, ghost_movement_system);
let collision_system = profile(SystemId::Collision, collision_system);
let ghost_collision_system = profile(SystemId::GhostCollision, ghost_collision_system);
let item_system = profile(SystemId::Item, item_system);
let audio_system = profile(SystemId::Audio, audio_system);
let blinking_system = profile(SystemId::Blinking, blinking_system);
let directional_render_system = profile(SystemId::DirectionalRender, directional_render_system);
let linear_render_system = profile(SystemId::LinearRender, linear_render_system);
let dirty_render_system = profile(SystemId::DirtyRender, dirty_render_system);
let hud_render_system = profile(SystemId::HudRender, hud_render_system);
let player_life_sprite_system = profile(SystemId::HudRender, player_life_sprite_system);
let fruit_sprite_system = profile(SystemId::HudRender, fruit_sprite_system);
let present_system = profile(SystemId::Present, present_system);
let unified_ghost_state_system = profile(SystemId::GhostStateAnimation, ghost_state_system);
let eaten_ghost_system = profile(SystemId::EatenGhost, eaten_ghost_system);
let time_to_live_system = profile(SystemId::TimeToLive, time_to_live_system);
let forced_dirty_system = |mut dirty: ResMut<RenderDirty>| {
dirty.0 = true;
};
schedule.add_systems((
forced_dirty_system.run_if(resource_changed::<ScoreResource>.or(resource_changed::<StartupSequence>)),
(
// Input system should always run to prevent SDL event pump from blocking
let input_systems = (
input_system.run_if(|mut local: Local<u8>| {
*local = local.wrapping_add(1u8);
// run every nth frame
*local % 2 == 0
}),
player_control_system,
player_movement_system,
startup_stage_system,
pause_system,
)
.chain(),
.chain();
// .run_if(|game_state: Res<GameStage>| matches!(*game_state, GameStage::Playing));
schedule
.add_systems((
input_systems.in_set(GameplaySet::Input),
time_to_live_system.before(GameplaySet::Update),
(
player_movement_system,
player_tunnel_slowdown_system,
ghost_movement_system,
profile(SystemId::EatenGhost, eaten_ghost_system),
eaten_ghost_system,
collision_system,
unified_ghost_state_system,
(collision_system, ghost_collision_system, item_system).chain(),
audio_system,
blinking_system,
)
.in_set(GameplaySet::Update),
(
blinking_system,
directional_render_system,
linear_render_system,
dirty_render_system,
player_life_sprite_system,
fruit_sprite_system,
)
.in_set(RenderSet::Animation),
stage_system.in_set(GameplaySet::Respond),
(
(|mut dirty: ResMut<RenderDirty>, score: Res<ScoreResource>, stage: Res<GameStage>| {
dirty.0 = score.is_changed() || stage.is_changed();
}),
dirty_render_system.run_if(|dirty: Res<RenderDirty>| dirty.0.not()),
combined_render_system,
hud_render_system,
touch_ui_render_system,
present_system,
)
.chain(),
.chain()
.in_set(RenderSet::Draw),
(present_system, audio_system).chain().in_set(RenderSet::Present),
))
.configure_sets((
GameplaySet::Input,
GameplaySet::Update.run_if(|paused: Res<Paused>| !paused.0),
GameplaySet::Respond.run_if(|paused: Res<Paused>| !paused.0),
RenderSet::Animation.run_if(|paused: Res<Paused>| !paused.0),
RenderSet::Draw,
RenderSet::Present,
));
}
// Spawn player and attach initial state bundle
world.spawn(player).insert((Frozen, Hidden));
fn spawn_items(world: &mut World) -> GameResult<()> {
trace!("Loading item sprites from atlas");
let pellet_sprite = SpriteAtlas::get_tile(
world.non_send_resource::<SpriteAtlas>(),
&GameSprite::Maze(MazeSprite::Pellet).to_path(),
)?;
let energizer_sprite = SpriteAtlas::get_tile(
world.non_send_resource::<SpriteAtlas>(),
&GameSprite::Maze(MazeSprite::Energizer).to_path(),
)?;
// Spawn ghosts
Self::spawn_ghosts(&mut world)?;
let pellet_sprite = SpriteAtlas::get_tile(world.non_send_resource::<SpriteAtlas>(), "maze/pellet.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("maze/pellet.png".to_string())))?;
let energizer_sprite = SpriteAtlas::get_tile(world.non_send_resource::<SpriteAtlas>(), "maze/energizer.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("maze/energizer.png".to_string())))?;
// Build a list of item entities to spawn from the map
let nodes: Vec<(NodeId, EntityType, AtlasTile, f32)> = world
.resource::<Map>()
.iter_nodes()
@@ -422,7 +565,12 @@ impl Game {
})
.collect();
// Construct and spawn the item entities
info!(
pellet_count = nodes.iter().filter(|(_, t, _, _)| *t == EntityType::Pellet).count(),
power_pellet_count = nodes.iter().filter(|(_, t, _, _)| *t == EntityType::PowerPellet).count(),
"Spawning collectible items"
);
for (id, item_type, sprite, size) in nodes {
let mut item = world.spawn(ItemBundle {
position: Position::Stopped { node: id },
@@ -432,13 +580,11 @@ impl Game {
item_collider: ItemCollider,
});
// Make power pellets blink
if item_type == EntityType::PowerPellet {
item.insert((Frozen, Blinking::new(constants::ui::POWER_PELLET_BLINK_RATE)));
}
}
Ok(Game { world, schedule })
Ok(())
}
/// Creates and spawns all four ghosts with unique AI personalities and directional animations.
@@ -448,6 +594,7 @@ impl Game {
/// Returns `GameError::Texture` if any ghost sprite cannot be found in the atlas,
/// typically indicating missing or misnamed sprite files.
fn spawn_ghosts(world: &mut World) -> GameResult<()> {
trace!("Spawning ghost entities with AI personalities");
// Extract the data we need first to avoid borrow conflicts
let ghost_start_positions = {
let map = world.resource::<Map>();
@@ -462,8 +609,9 @@ impl Game {
for (ghost_type, start_node) in ghost_start_positions {
// Create the ghost bundle in a separate scope to manage borrows
let ghost = {
let animations = *world.resource::<GhostAnimations>().get_normal(&ghost_type).unwrap();
let animations = world.resource::<GhostAnimations>().get_normal(&ghost_type).unwrap().clone();
let atlas = world.non_send_resource::<SpriteAtlas>();
let sprite_path = GameSprite::Ghost(GhostSprite::Normal(ghost_type, Direction::Left, 0)).to_path();
GhostBundle {
ghost: ghost_type,
@@ -473,14 +621,7 @@ impl Game {
direction: Direction::Left,
},
sprite: Renderable {
sprite: SpriteAtlas::get_tile(atlas, &format!("ghost/{}/left_a.png", ghost_type.as_str())).ok_or_else(
|| {
GameError::Texture(TextureError::AtlasTileNotFound(format!(
"ghost/{}/left_a.png",
ghost_type.as_str()
)))
},
)?,
sprite: SpriteAtlas::get_tile(atlas, &sprite_path)?,
layer: 0,
},
directional_animation: animations,
@@ -494,26 +635,20 @@ impl Game {
}
};
world.spawn(ghost).insert((Frozen, Hidden));
let entity = world.spawn(ghost).insert((Frozen, Visibility::hidden())).id();
trace!(ghost = ?ghost_type, entity = ?entity, start_node, "Spawned ghost entity");
}
info!("All ghost entities spawned successfully");
Ok(())
}
fn create_ghost_animations(atlas: &SpriteAtlas) -> GameResult<GhostAnimations> {
// Eaten (eyes) animations - single tile per direction
let up_eye = atlas
.get_tile("ghost/eyes/up.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("ghost/eyes/up.png".to_string())))?;
let down_eye = atlas
.get_tile("ghost/eyes/down.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("ghost/eyes/down.png".to_string())))?;
let left_eye = atlas
.get_tile("ghost/eyes/left.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("ghost/eyes/left.png".to_string())))?;
let right_eye = atlas
.get_tile("ghost/eyes/right.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("ghost/eyes/right.png".to_string())))?;
let up_eye = atlas.get_tile(&GameSprite::Ghost(GhostSprite::Eyes(Direction::Up)).to_path())?;
let down_eye = atlas.get_tile(&GameSprite::Ghost(GhostSprite::Eyes(Direction::Down)).to_path())?;
let left_eye = atlas.get_tile(&GameSprite::Ghost(GhostSprite::Eyes(Direction::Left)).to_path())?;
let right_eye = atlas.get_tile(&GameSprite::Ghost(GhostSprite::Eyes(Direction::Right)).to_path())?;
let eyes_tiles = DirectionalTiles::new(
TileSequence::new(&[up_eye]),
@@ -521,83 +656,27 @@ impl Game {
TileSequence::new(&[left_eye]),
TileSequence::new(&[right_eye]),
);
let eyes = DirectionalAnimation::new(eyes_tiles, eyes_tiles, animation::GHOST_EATEN_SPEED);
let eyes = DirectionalAnimation::new(eyes_tiles.clone(), eyes_tiles, animation::GHOST_EATEN_SPEED);
let mut animations = HashMap::new();
for ghost_type in [Ghost::Blinky, Ghost::Pinky, Ghost::Inky, Ghost::Clyde] {
// Normal animations - create directional tiles for each direction
let up_tiles = [
atlas
.get_tile(&format!("ghost/{}/up_a.png", ghost_type.as_str()))
.ok_or_else(|| {
GameError::Texture(TextureError::AtlasTileNotFound(format!(
"ghost/{}/up_a.png",
ghost_type.as_str()
)))
})?,
atlas
.get_tile(&format!("ghost/{}/up_b.png", ghost_type.as_str()))
.ok_or_else(|| {
GameError::Texture(TextureError::AtlasTileNotFound(format!(
"ghost/{}/up_b.png",
ghost_type.as_str()
)))
})?,
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Normal(ghost_type, Direction::Up, 0)).to_path())?,
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Normal(ghost_type, Direction::Up, 1)).to_path())?,
];
let down_tiles = [
atlas
.get_tile(&format!("ghost/{}/down_a.png", ghost_type.as_str()))
.ok_or_else(|| {
GameError::Texture(TextureError::AtlasTileNotFound(format!(
"ghost/{}/down_a.png",
ghost_type.as_str()
)))
})?,
atlas
.get_tile(&format!("ghost/{}/down_b.png", ghost_type.as_str()))
.ok_or_else(|| {
GameError::Texture(TextureError::AtlasTileNotFound(format!(
"ghost/{}/down_b.png",
ghost_type.as_str()
)))
})?,
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Normal(ghost_type, Direction::Down, 0)).to_path())?,
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Normal(ghost_type, Direction::Down, 1)).to_path())?,
];
let left_tiles = [
atlas
.get_tile(&format!("ghost/{}/left_a.png", ghost_type.as_str()))
.ok_or_else(|| {
GameError::Texture(TextureError::AtlasTileNotFound(format!(
"ghost/{}/left_a.png",
ghost_type.as_str()
)))
})?,
atlas
.get_tile(&format!("ghost/{}/left_b.png", ghost_type.as_str()))
.ok_or_else(|| {
GameError::Texture(TextureError::AtlasTileNotFound(format!(
"ghost/{}/left_b.png",
ghost_type.as_str()
)))
})?,
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Normal(ghost_type, Direction::Left, 0)).to_path())?,
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Normal(ghost_type, Direction::Left, 1)).to_path())?,
];
let right_tiles = [
atlas
.get_tile(&format!("ghost/{}/right_a.png", ghost_type.as_str()))
.ok_or_else(|| {
GameError::Texture(TextureError::AtlasTileNotFound(format!(
"ghost/{}/right_a.png",
ghost_type.as_str()
)))
})?,
atlas
.get_tile(&format!("ghost/{}/right_b.png", ghost_type.as_str()))
.ok_or_else(|| {
GameError::Texture(TextureError::AtlasTileNotFound(format!(
"ghost/{}/right_b.png",
ghost_type.as_str()
)))
})?,
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Normal(ghost_type, Direction::Right, 0)).to_path())?,
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Normal(ghost_type, Direction::Right, 1)).to_path())?,
];
let normal_moving = DirectionalTiles::new(
@@ -606,25 +685,21 @@ impl Game {
TileSequence::new(&left_tiles),
TileSequence::new(&right_tiles),
);
let normal = DirectionalAnimation::new(normal_moving, normal_moving, animation::GHOST_NORMAL_SPEED);
let normal = DirectionalAnimation::new(normal_moving.clone(), normal_moving, animation::GHOST_NORMAL_SPEED);
animations.insert(ghost_type, normal);
}
let (frightened, frightened_flashing) = {
// Load frightened animation tiles (same for all ghosts)
let frightened_blue_a = atlas
.get_tile("ghost/frightened/blue_a.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("ghost/frightened/blue_a.png".to_string())))?;
let frightened_blue_b = atlas
.get_tile("ghost/frightened/blue_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("ghost/frightened/blue_b.png".to_string())))?;
let frightened_white_a = atlas
.get_tile("ghost/frightened/white_a.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("ghost/frightened/white_a.png".to_string())))?;
let frightened_white_b = atlas
.get_tile("ghost/frightened/white_b.png")
.ok_or_else(|| GameError::Texture(TextureError::AtlasTileNotFound("ghost/frightened/white_b.png".to_string())))?;
let frightened_blue_a =
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Frightened(FrightenedColor::Blue, 0)).to_path())?;
let frightened_blue_b =
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Frightened(FrightenedColor::Blue, 1)).to_path())?;
let frightened_white_a =
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Frightened(FrightenedColor::White, 0)).to_path())?;
let frightened_white_b =
atlas.get_tile(&GameSprite::Ghost(GhostSprite::Frightened(FrightenedColor::White, 1)).to_path())?;
(
LinearAnimation::new(
@@ -657,10 +732,45 @@ impl Game {
///
/// `true` if the game should terminate (exit command received), `false` to continue
pub fn tick(&mut self, dt: f32) -> bool {
self.world.insert_resource(DeltaTime(dt));
self.world.insert_resource(DeltaTime { seconds: dt, ticks: 1 });
// Run all systems
// Note: We don't need to read the current tick here since we increment it after running systems
// Measure total frame time including all systems
let start = std::time::Instant::now();
self.schedule.run(&mut self.world);
let total_duration = start.elapsed();
// Increment tick counter and record the total timing
if let (Some(timings), Some(timing)) = (
self.world.get_resource::<systems::profiling::SystemTimings>(),
self.world.get_resource::<Timing>(),
) {
let new_tick = timing.increment_tick();
timings.add_total_timing(total_duration, new_tick);
// Log performance warnings for slow frames
if total_duration.as_millis() > 17 {
// Warn if frame takes too long
let slowest_systems = timings.get_slowest_systems();
let systems_context = if slowest_systems.is_empty() {
"No specific systems identified".to_string()
} else {
slowest_systems
.iter()
.map(|(id, duration)| format!("{} ({:.2?})", id, duration))
.collect::<Vec<String>>()
.join(", ")
};
warn!(
total = format!("{:.3?}", total_duration),
tick = new_tick,
systems = systems_context,
"Frame took longer than expected"
);
}
}
let state = self
.world
@@ -669,68 +779,4 @@ impl Game {
state.exit
}
// /// Renders pathfinding debug lines from each ghost to Pac-Man.
// ///
// /// Each ghost's path is drawn in its respective color with a small offset
// /// to prevent overlapping lines.
// fn render_pathfinding_debug<T: sdl2::render::RenderTarget>(&self, canvas: &mut Canvas<T>) -> GameResult<()> {
// let pacman_node = self.state.pacman.current_node_id();
// for ghost in self.state.ghosts.iter() {
// if let Ok(path) = ghost.calculate_path_to_target(&self.state.map.graph, pacman_node) {
// if path.len() < 2 {
// continue; // Skip if path is too short
// }
// // Set the ghost's color
// canvas.set_draw_color(ghost.debug_color());
// // Calculate offset based on ghost index to prevent overlapping lines
// // let offset = (i as f32) * 2.0 - 3.0; // Offset range: -3.0 to 3.0
// // Calculate a consistent offset direction for the entire path
// // let first_node = self.map.graph.get_node(path[0]).unwrap();
// // let last_node = self.map.graph.get_node(path[path.len() - 1]).unwrap();
// // Use the overall direction from start to end to determine the perpendicular offset
// let offset = match ghost.ghost_type {
// GhostType::Blinky => glam::Vec2::new(0.25, 0.5),
// GhostType::Pinky => glam::Vec2::new(-0.25, -0.25),
// GhostType::Inky => glam::Vec2::new(0.5, -0.5),
// GhostType::Clyde => glam::Vec2::new(-0.5, 0.25),
// } * 5.0;
// // Calculate offset positions for all nodes using the same perpendicular direction
// let mut offset_positions = Vec::new();
// for &node_id in &path {
// let node = self
// .state
// .map
// .graph
// .get_node(node_id)
// .ok_or(crate::error::EntityError::NodeNotFound(node_id))?;
// let pos = node.position + crate::constants::BOARD_PIXEL_OFFSET.as_vec2();
// offset_positions.push(pos + offset);
// }
// // Draw lines between the offset positions
// for window in offset_positions.windows(2) {
// if let (Some(from), Some(to)) = (window.first(), window.get(1)) {
// // Skip if the distance is too far (used for preventing lines between tunnel portals)
// if from.distance_squared(*to) > (crate::constants::CELL_SIZE * 16).pow(2) as f32 {
// continue;
// }
// // Draw the line
// canvas
// .draw_line((from.x as i32, from.y as i32), (to.x as i32, to.y as i32))
// .map_err(|e| crate::error::GameError::Sdl(e.to_string()))?;
// }
// }
// }
// }
// Ok(())
// }
}

View File

@@ -1,14 +1,22 @@
//! Pac-Man game library crate.
#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod app;
pub mod asset;
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod audio;
pub mod constants;
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod error;
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod events;
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod formatter;
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod platform;
pub mod asset;
pub mod constants;
pub mod game;
pub mod map;
pub mod platform;
pub mod systems;
pub mod texture;

View File

@@ -1,20 +1,29 @@
// Note: This disables the console window on Windows. We manually re-attach to the parent terminal or process later on.
#![windows_subsystem = "windows"]
#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
#![cfg_attr(coverage_nightly, coverage(off))]
use crate::{app::App, constants::LOOP_TIME};
use tracing::info;
// These modules are excluded from coverage.
#[cfg_attr(coverage_nightly, coverage(off))]
mod app;
mod asset;
#[cfg_attr(coverage_nightly, coverage(off))]
mod audio;
mod constants;
#[cfg_attr(coverage_nightly, coverage(off))]
mod error;
#[cfg_attr(coverage_nightly, coverage(off))]
mod events;
#[cfg_attr(coverage_nightly, coverage(off))]
mod formatter;
#[cfg_attr(coverage_nightly, coverage(off))]
mod platform;
mod asset;
mod constants;
mod game;
mod map;
mod platform;
mod systems;
mod texture;

View File

@@ -3,7 +3,7 @@ use crate::constants::{MapTile, BOARD_CELL_SIZE, CELL_SIZE};
use crate::map::direction::Direction;
use crate::map::graph::{Graph, Node, TraversalFlags};
use crate::map::parser::MapTileParser;
use crate::systems::movement::NodeId;
use crate::systems::{NodeId, Position};
use bevy_ecs::resource::Resource;
use glam::{I8Vec2, IVec2, Vec2};
use std::collections::{HashMap, VecDeque};
@@ -25,6 +25,8 @@ pub struct NodePositions {
pub inky: NodeId,
/// Clyde starts in the center of the ghost house
pub clyde: NodeId,
/// Fruit spawn location directly below the ghost house
pub fruit_spawn: Position,
}
/// Complete maze representation combining visual layout with navigation pathfinding.
@@ -56,11 +58,17 @@ impl Map {
/// This function will panic if the board layout contains unknown characters or if
/// the house door is not defined by exactly two '=' characters.
pub fn new(raw_board: [&str; BOARD_CELL_SIZE.y as usize]) -> GameResult<Map> {
debug!("Starting map construction from character layout");
let parsed_map = MapTileParser::parse_board(raw_board)?;
let map = parsed_map.tiles;
let house_door = parsed_map.house_door;
let tunnel_ends = parsed_map.tunnel_ends;
debug!(
house_door_count = house_door.len(),
tunnel_ends_count = tunnel_ends.len(),
"Parsed map special locations"
);
let mut graph = Graph::new();
let mut grid_to_node = HashMap::new();
@@ -148,17 +156,39 @@ impl Map {
let (house_entrance_node_id, left_center_node_id, center_center_node_id, right_center_node_id) =
Self::build_house(&mut graph, &grid_to_node, &house_door)?;
// Find fruit spawn location (directly below ghost house)
let left_node_position = I8Vec2::new(13, 17);
let left_node_id = grid_to_node.get(&left_node_position).unwrap();
let right_node_position = I8Vec2::new(14, 17);
let right_node_id = grid_to_node.get(&right_node_position).unwrap();
let distance = graph
.get_node(*right_node_id)
.unwrap()
.position
.distance(graph.get_node(*left_node_id).unwrap().position);
// interpolate between the two nodes
let fruit_spawn_position: Position = Position::Moving {
from: *left_node_id,
to: *right_node_id,
remaining_distance: distance / 2.0,
};
let start_positions = NodePositions {
pacman: grid_to_node[&start_pos],
blinky: house_entrance_node_id,
pinky: left_center_node_id,
inky: right_center_node_id,
clyde: center_center_node_id,
fruit_spawn: fruit_spawn_position,
};
// Build tunnel connections
debug!("Building tunnel connections");
Self::build_tunnels(&mut graph, &grid_to_node, &tunnel_ends)?;
debug!(node_count = graph.nodes().count(), "Map construction completed successfully");
Ok(Map {
graph,
grid_to_node,
@@ -359,12 +389,7 @@ impl Map {
+ IVec2::from(Direction::Left.as_ivec2()).as_vec2() * (CELL_SIZE as f32 * 2.0),
},
)
.map_err(|e| {
MapError::InvalidConfig(format!(
"Failed to connect left tunnel entrance to left tunnel hidden node: {}",
e
))
})?
.expect("Failed to connect left tunnel entrance to left tunnel hidden node")
};
// Create the right tunnel nodes
@@ -384,12 +409,7 @@ impl Map {
+ IVec2::from(Direction::Right.as_ivec2()).as_vec2() * (CELL_SIZE as f32 * 2.0),
},
)
.map_err(|e| {
MapError::InvalidConfig(format!(
"Failed to connect right tunnel entrance to right tunnel hidden node: {}",
e
))
})?
.expect("Failed to connect right tunnel entrance to right tunnel hidden node")
};
// Connect the left tunnel hidden node to the right tunnel hidden node
@@ -401,12 +421,7 @@ impl Map {
Some(0.0),
Direction::Left,
)
.map_err(|e| {
MapError::InvalidConfig(format!(
"Failed to connect left tunnel hidden node to right tunnel hidden node: {}",
e
))
})?;
.expect("Failed to connect left tunnel hidden node to right tunnel hidden node");
Ok(())
}

View File

@@ -1,6 +1,6 @@
use glam::Vec2;
use crate::systems::movement::NodeId;
use crate::systems::NodeId;
use super::direction::Direction;

View File

@@ -1,57 +0,0 @@
#![allow(dead_code)]
//! Buffered writer for tracing logs that can store logs before console attachment.
use parking_lot::Mutex;
use std::io::{self, Write};
use std::sync::Arc;
/// A thread-safe buffered writer that stores logs in memory until flushed.
#[derive(Clone)]
pub struct BufferedWriter {
buffer: Arc<Mutex<Vec<u8>>>,
}
impl BufferedWriter {
/// Creates a new buffered writer.
pub fn new() -> Self {
Self {
buffer: Arc::new(Mutex::new(Vec::new())),
}
}
/// Flushes all buffered content to the provided writer and clears the buffer.
pub fn flush_to<W: Write>(&self, mut writer: W) -> io::Result<()> {
let mut buffer = self.buffer.lock();
if !buffer.is_empty() {
writer.write_all(&buffer)?;
writer.flush()?;
buffer.clear();
}
Ok(())
}
/// Returns the current buffer size in bytes.
pub fn buffer_size(&self) -> usize {
self.buffer.lock().len()
}
}
impl Write for BufferedWriter {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
let mut buffer = self.buffer.lock();
buffer.extend_from_slice(buf);
Ok(buf.len())
}
fn flush(&mut self) -> io::Result<()> {
// For buffered writer, flush is a no-op since we're storing in memory
Ok(())
}
}
impl Default for BufferedWriter {
fn default() -> Self {
Self::new()
}
}

View File

@@ -1,12 +1,15 @@
//! Desktop platform implementation.
use std::borrow::Cow;
use std::time::Duration;
use rand::rngs::ThreadRng;
use rust_embed::Embed;
use crate::asset::Asset;
use crate::error::{AssetError, PlatformError};
use crate::error::PlatformError;
#[derive(Embed)]
#[folder = "assets/game/"]
struct EmbeddedAssets;
/// Desktop platform implementation.
pub fn sleep(duration: Duration, focused: bool) {
@@ -21,7 +24,7 @@ pub fn init_console() -> Result<(), PlatformError> {
#[cfg(windows)]
{
use crate::platform::tracing_buffer::setup_switchable_subscriber;
use tracing::{debug, info};
use tracing::{debug, info, trace};
use windows::Win32::System::Console::GetConsoleWindow;
// Setup buffered tracing subscriber that will buffer logs until console is ready
@@ -32,13 +35,13 @@ pub fn init_console() -> Result<(), PlatformError> {
debug!("Already have a console window");
return Ok(());
} else {
debug!("No existing console window found");
trace!("No existing console window found");
}
if let Some(file_type) = is_output_setup()? {
debug!(r#type = file_type, "Existing output detected");
trace!(r#type = file_type, "Existing output detected");
} else {
debug!("No existing output detected");
trace!("No existing output detected");
// Try to attach to parent console for direct cargo run
attach_to_parent_console()?;
@@ -46,7 +49,7 @@ pub fn init_console() -> Result<(), PlatformError> {
}
// Now that console is initialized, flush buffered logs and switch to direct output
debug!("Switching to direct logging mode and flushing buffer...");
trace!("Switching to direct logging mode and flushing buffer...");
if let Err(error) = switchable_writer.switch_to_direct_mode() {
use tracing::warn;
@@ -57,17 +60,6 @@ pub fn init_console() -> Result<(), PlatformError> {
Ok(())
}
pub fn get_asset_bytes(asset: Asset) -> Result<Cow<'static, [u8]>, AssetError> {
match asset {
Asset::Wav1 => Ok(Cow::Borrowed(include_bytes!("../../assets/game/sound/waka/1.ogg"))),
Asset::Wav2 => Ok(Cow::Borrowed(include_bytes!("../../assets/game/sound/waka/2.ogg"))),
Asset::Wav3 => Ok(Cow::Borrowed(include_bytes!("../../assets/game/sound/waka/3.ogg"))),
Asset::Wav4 => Ok(Cow::Borrowed(include_bytes!("../../assets/game/sound/waka/4.ogg"))),
Asset::AtlasImage => Ok(Cow::Borrowed(include_bytes!("../../assets/game/atlas.png"))),
Asset::Font => Ok(Cow::Borrowed(include_bytes!("../../assets/game/TerminalVector.ttf"))),
}
}
pub fn rng() -> ThreadRng {
rand::rng()
}
@@ -78,7 +70,7 @@ pub fn rng() -> ThreadRng {
/// Windows-only
#[cfg(windows)]
fn is_output_setup() -> Result<Option<&'static str>, PlatformError> {
use tracing::{debug, warn};
use tracing::{trace, warn};
use windows::Win32::Storage::FileSystem::{
GetFileType, FILE_TYPE_CHAR, FILE_TYPE_DISK, FILE_TYPE_PIPE, FILE_TYPE_REMOTE, FILE_TYPE_UNKNOWN,
@@ -113,7 +105,7 @@ fn is_output_setup() -> Result<Option<&'static str>, PlatformError> {
}
};
debug!("File type: {file_type:?}, well known: {well_known}");
trace!("File type: {file_type:?}, well known: {well_known}");
// If it's anything recognizable and valid, assume that a parent process has setup an output stream
Ok(well_known.then_some(file_type))

View File

@@ -1,21 +1,15 @@
//! Emscripten platform implementation.
use crate::asset::Asset;
use crate::error::{AssetError, PlatformError};
use crate::error::PlatformError;
use crate::formatter::CustomFormatter;
use rand::{rngs::SmallRng, SeedableRng};
use sdl2::rwops::RWops;
use std::borrow::Cow;
use std::ffi::CString;
use std::io::{self, Read, Write};
use std::io::{self, Write};
use std::time::Duration;
// Emscripten FFI functions
#[allow(dead_code)]
extern "C" {
fn emscripten_sleep(ms: u32);
fn emscripten_get_element_css_size(target: *const u8, width: *mut f64, height: *mut f64) -> i32;
// Standard C functions that Emscripten redirects to console
fn printf(format: *const u8, ...) -> i32;
}
@@ -65,32 +59,6 @@ impl Write for EmscriptenConsoleWriter {
}
}
#[allow(dead_code)]
pub fn get_canvas_size() -> Option<(u32, u32)> {
let mut width = 0.0;
let mut height = 0.0;
unsafe {
emscripten_get_element_css_size(c"canvas".as_ptr().cast(), &mut width, &mut height);
if width == 0.0 || height == 0.0 {
return None;
}
}
Some((width as u32, height as u32))
}
pub fn get_asset_bytes(asset: Asset) -> Result<Cow<'static, [u8]>, AssetError> {
let path = format!("assets/game/{}", asset.path());
let mut rwops = RWops::from_file(&path, "rb").map_err(|_| AssetError::NotFound(asset.path().to_string()))?;
let len = rwops.len().ok_or_else(|| AssetError::NotFound(asset.path().to_string()))?;
let mut buf = vec![0u8; len];
rwops.read_exact(&mut buf).map_err(|e| AssetError::Io(io::Error::other(e)))?;
Ok(Cow::Owned(buf))
}
pub fn rng() -> SmallRng {
SmallRng::from_os_rng()
}

View File

@@ -1,14 +1,14 @@
//! Platform abstraction layer for cross-platform functionality.
#[cfg(not(target_os = "emscripten"))]
pub mod buffered_writer;
#[cfg(not(target_os = "emscripten"))]
mod desktop;
#[cfg(not(target_os = "emscripten"))]
pub mod tracing_buffer;
#[cfg(not(target_os = "emscripten"))]
pub use desktop::*;
/// Tracing buffer is only used on Windows.
#[cfg(windows)]
pub mod tracing_buffer;
#[cfg(target_os = "emscripten")]
pub use emscripten::*;
#[cfg(target_os = "emscripten")]

View File

@@ -1,15 +1,65 @@
#![allow(dead_code)]
//! Buffered tracing setup for handling logs before console attachment.
use crate::formatter::CustomFormatter;
use crate::platform::buffered_writer::BufferedWriter;
use parking_lot::Mutex;
use std::io;
use std::io::Write;
use std::sync::Arc;
use tracing::{debug, Level};
use tracing_error::ErrorLayer;
use tracing_subscriber::fmt::MakeWriter;
use tracing_subscriber::layer::SubscriberExt;
/// A thread-safe buffered writer that stores logs in memory until flushed.
#[derive(Clone)]
pub struct BufferedWriter {
buffer: Arc<Mutex<Vec<u8>>>,
}
impl BufferedWriter {
/// Creates a new buffered writer.
pub fn new() -> Self {
Self {
buffer: Arc::new(Mutex::new(Vec::new())),
}
}
/// Flushes all buffered content to the provided writer and clears the buffer.
pub fn flush_to<W: Write>(&self, mut writer: W) -> io::Result<()> {
let mut buffer = self.buffer.lock();
if !buffer.is_empty() {
writer.write_all(&buffer)?;
writer.flush()?;
buffer.clear();
}
Ok(())
}
/// Returns the current buffer size in bytes.
pub fn buffer_size(&self) -> usize {
self.buffer.lock().len()
}
}
impl Write for BufferedWriter {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
let mut buffer = self.buffer.lock();
buffer.extend_from_slice(buf);
Ok(buf.len())
}
fn flush(&mut self) -> io::Result<()> {
// For buffered writer, flush is a no-op since we're storing in memory
Ok(())
}
}
impl Default for BufferedWriter {
fn default() -> Self {
Self::new()
}
}
/// A writer that can switch between buffering and direct output.
#[derive(Clone, Default)]
pub struct SwitchableWriter {

View File

@@ -0,0 +1,66 @@
use bevy_ecs::{
component::Component,
query::{Has, With},
system::{Query, Res},
};
use crate::systems::{DeltaTime, Frozen, Renderable, Visibility};
#[derive(Component, Debug)]
pub struct Blinking {
pub tick_timer: u32,
pub interval_ticks: u32,
}
impl Blinking {
pub fn new(interval_ticks: u32) -> Self {
Self {
tick_timer: 0,
interval_ticks,
}
}
}
/// Updates blinking entities by toggling their visibility at regular intervals.
///
/// This system manages entities that have both `Blinking` and `Renderable` components,
/// accumulating ticks and toggling visibility when the specified interval is reached.
/// Uses integer arithmetic for deterministic behavior.
#[allow(clippy::type_complexity)]
pub fn blinking_system(time: Res<DeltaTime>, mut query: Query<(&mut Blinking, &mut Visibility, Has<Frozen>), With<Renderable>>) {
for (mut blinking, mut visibility, frozen) in query.iter_mut() {
// If the entity is frozen, blinking is disabled and the entity is made visible
if frozen {
visibility.show();
continue;
}
// Increase the timer by the delta ticks
blinking.tick_timer += time.ticks;
// Handle zero interval case (immediate toggling)
if blinking.interval_ticks == 0 {
if time.ticks > 0 {
visibility.toggle();
}
continue;
}
// Calculate how many complete intervals have passed
let complete_intervals = blinking.tick_timer / blinking.interval_ticks;
// If no complete intervals have passed, there's nothing to do yet
if complete_intervals == 0 {
continue;
}
// Update the timer to the remainder after complete intervals
blinking.tick_timer %= blinking.interval_ticks;
// Toggle the visibility for each complete interval
// Since toggling twice is a no-op, we only need to toggle if the count is odd
if complete_intervals % 2 == 1 {
visibility.toggle();
}
}
}

View File

@@ -0,0 +1,104 @@
use bevy_ecs::{
component::Component,
query::{Has, Or, With, Without},
system::{Query, Res},
};
use crate::{
systems::{DeltaTime, Dying, Frozen, LinearAnimation, Looping, Position, Renderable, Velocity},
texture::animated::DirectionalTiles,
};
/// Directional animation component with shared timing across all directions
#[derive(Component, Clone)]
pub struct DirectionalAnimation {
pub moving_tiles: DirectionalTiles,
pub stopped_tiles: DirectionalTiles,
pub current_frame: usize,
pub time_bank: u16,
pub frame_duration: u16,
}
impl DirectionalAnimation {
/// Creates a new directional animation with the given tiles and frame duration
pub fn new(moving_tiles: DirectionalTiles, stopped_tiles: DirectionalTiles, frame_duration: u16) -> Self {
Self {
moving_tiles,
stopped_tiles,
current_frame: 0,
time_bank: 0,
frame_duration,
}
}
}
/// Updates directional animated entities with synchronized timing across directions.
///
/// This runs before the render system to update sprites based on current direction and movement state.
/// All directions share the same frame timing to ensure perfect synchronization.
pub fn directional_render_system(
dt: Res<DeltaTime>,
mut query: Query<(&Position, &Velocity, &mut DirectionalAnimation, &mut Renderable, Has<Frozen>)>,
) {
let ticks = (dt.seconds * 60.0).round() as u16; // Convert from seconds to ticks at 60 ticks/sec
for (position, velocity, mut anim, mut renderable, frozen) in query.iter_mut() {
let stopped = matches!(position, Position::Stopped { .. });
// Only tick animation when moving to preserve stopped frame
if !stopped && !frozen {
// Tick shared animation state
anim.time_bank += ticks;
while anim.time_bank >= anim.frame_duration {
anim.time_bank -= anim.frame_duration;
anim.current_frame += 1;
}
}
// Get tiles for current direction and movement state
let tiles = if stopped {
anim.stopped_tiles.get(velocity.direction)
} else {
anim.moving_tiles.get(velocity.direction)
};
if !tiles.is_empty() {
let new_tile = tiles.get_tile(anim.current_frame);
if renderable.sprite != new_tile {
renderable.sprite = new_tile;
}
}
}
}
/// System that updates `Renderable` sprites for entities with `LinearAnimation`.
#[allow(clippy::type_complexity)]
pub fn linear_render_system(
dt: Res<DeltaTime>,
mut query: Query<(&mut LinearAnimation, &mut Renderable, Has<Looping>), Or<(Without<Frozen>, With<Dying>)>>,
) {
for (mut anim, mut renderable, looping) in query.iter_mut() {
if anim.finished {
continue;
}
anim.time_bank += dt.ticks as u16;
let frames_to_advance = (anim.time_bank / anim.frame_duration) as usize;
if frames_to_advance == 0 {
continue;
}
let total_frames = anim.tiles.len();
if !looping && anim.current_frame + frames_to_advance >= total_frames {
anim.finished = true;
anim.current_frame = total_frames - 1;
} else {
anim.current_frame += frames_to_advance;
}
anim.time_bank %= anim.frame_duration;
renderable.sprite = anim.tiles.get_tile(anim.current_frame);
}
}

View File

@@ -0,0 +1,30 @@
use crate::texture::animated::TileSequence;
use bevy_ecs::component::Component;
use bevy_ecs::resource::Resource;
/// Tag component to mark animations that should loop when they reach the end
#[derive(Component, Clone, Copy, Debug, PartialEq, Eq)]
pub struct Looping;
/// Linear animation component for non-directional animations (frightened ghosts)
#[derive(Component, Resource, Clone)]
pub struct LinearAnimation {
pub tiles: TileSequence,
pub current_frame: usize,
pub time_bank: u16,
pub frame_duration: u16,
pub finished: bool,
}
impl LinearAnimation {
/// Creates a new linear animation with the given tiles and frame duration
pub fn new(tiles: TileSequence, frame_duration: u16) -> Self {
Self {
tiles,
current_frame: 0,
time_bank: 0,
frame_duration,
finished: false,
}
}
}

View File

@@ -0,0 +1,7 @@
mod blinking;
mod directional;
mod linear;
pub use self::blinking::*;
pub use self::directional::*;
pub use self::linear::*;

View File

@@ -9,8 +9,9 @@ use bevy_ecs::{
resource::Resource,
system::{NonSendMut, ResMut},
};
use tracing::{debug, trace};
use crate::{audio::Audio, error::GameError};
use crate::{audio::Audio, audio::Sound, error::GameError};
/// Resource for tracking audio state
#[derive(Resource, Debug, Clone, Default)]
@@ -24,8 +25,16 @@ pub struct AudioState {
/// Events for triggering audio playback
#[derive(Event, Debug, Clone, Copy, PartialEq, Eq)]
pub enum AudioEvent {
/// Play the "eat" sound when Pac-Man consumes a pellet
PlayEat,
/// Play a specific sound effect
PlaySound(Sound),
/// Play the cycling waka sound variant
Waka,
/// Stop all currently playing sounds
StopAll,
/// Pause all sounds
Pause,
/// Resume all sounds
Resume,
}
/// Non-send resource wrapper for SDL2 audio system
@@ -45,18 +54,62 @@ pub fn audio_system(
) {
// Set mute state if it has changed
if audio.0.is_muted() != audio_state.muted {
debug!(muted = audio_state.muted, "Audio mute state changed");
audio.0.set_mute(audio_state.muted);
}
// Process audio events
for event in audio_events.read() {
match event {
AudioEvent::PlayEat => {
AudioEvent::Waka => {
if !audio.0.is_disabled() && !audio_state.muted {
audio.0.eat();
trace!(sound_index = audio_state.sound_index, "Playing eat sound");
audio.0.waka();
// Update the sound index for cycling through sounds
audio_state.sound_index = (audio_state.sound_index + 1) % 4;
// 4 eat sounds available
} else {
debug!(
disabled = audio.0.is_disabled(),
muted = audio_state.muted,
"Skipping eat sound due to audio state"
);
}
}
AudioEvent::PlaySound(sound) => {
if !audio.0.is_disabled() && !audio_state.muted {
trace!(?sound, "Playing sound");
audio.0.play(*sound);
} else {
debug!(
disabled = audio.0.is_disabled(),
muted = audio_state.muted,
"Skipping sound due to audio state"
);
}
}
AudioEvent::StopAll => {
if !audio.0.is_disabled() {
debug!("Stopping all audio");
audio.0.stop_all();
} else {
debug!("Audio disabled, ignoring stop all request");
}
}
AudioEvent::Pause => {
if !audio.0.is_disabled() {
debug!("Pausing all audio");
audio.0.pause_all();
} else {
debug!("Audio disabled, ignoring pause all request");
}
}
AudioEvent::Resume => {
if !audio.0.is_disabled() {
debug!("Resuming all audio");
audio.0.resume_all();
} else {
debug!("Audio disabled, ignoring resume all request");
}
}
}

View File

@@ -1,63 +0,0 @@
use bevy_ecs::{
component::Component,
entity::Entity,
query::{Has, With},
system::{Commands, Query, Res},
};
use crate::systems::{
components::{DeltaTime, Renderable},
Frozen, Hidden,
};
#[derive(Component, Debug)]
pub struct Blinking {
pub timer: f32,
pub interval: f32,
}
impl Blinking {
pub fn new(interval: f32) -> Self {
Self { timer: 0.0, interval }
}
}
/// Updates blinking entities by toggling their visibility at regular intervals.
///
/// This system manages entities that have both `Blinking` and `Renderable` components,
/// accumulating time and toggling visibility when the specified interval is reached.
#[allow(clippy::type_complexity)]
pub fn blinking_system(
mut commands: Commands,
time: Res<DeltaTime>,
mut query: Query<(Entity, &mut Blinking, Has<Hidden>, Has<Frozen>), With<Renderable>>,
) {
for (entity, mut blinking, hidden, frozen) in query.iter_mut() {
// If the entity is frozen, blinking is disabled and the entity is unhidden (if it was hidden)
if frozen {
if hidden {
commands.entity(entity).remove::<Hidden>();
}
continue;
}
// Increase the timer by the delta time
blinking.timer += time.0;
// If the timer is less than the interval, there's nothing to do yet
if blinking.timer < blinking.interval {
continue;
}
// Subtract the interval (allows for the timer to retain partial interval progress)
blinking.timer -= blinking.interval;
// Toggle the Hidden component
if hidden {
commands.entity(entity).remove::<Hidden>();
} else {
commands.entity(entity).insert(Hidden);
}
}
}

View File

@@ -1,15 +1,26 @@
use bevy_ecs::component::Component;
use bevy_ecs::entity::Entity;
use bevy_ecs::event::{EventReader, EventWriter};
use bevy_ecs::query::With;
use bevy_ecs::system::{Query, Res, ResMut};
use bevy_ecs::{
component::Component,
entity::Entity,
event::EventWriter,
observer::Trigger,
query::With,
system::{Commands, Query, Res, ResMut},
};
use tracing::{debug, trace, warn};
use crate::error::GameError;
use crate::events::GameEvent;
use crate::map::builder::Map;
use crate::systems::movement::Position;
use crate::systems::{AudioEvent, Ghost, GhostState, PlayerControlled, ScoreResource};
use crate::audio::Sound;
use crate::{
constants,
systems::{movement::Position, AudioEvent, DyingSequence, FruitSprites, GameStage, Ghost, ScoreResource, SpawnTrigger},
};
use crate::{error::GameError, systems::GhostState};
use crate::{
events::{CollisionTrigger, StageTransition},
systems::PelletCount,
};
use crate::{map::builder::Map, systems::EntityType};
/// A component for defining the collision area of an entity.
#[derive(Component)]
pub struct Collider {
pub size: f32,
@@ -52,22 +63,23 @@ pub fn check_collision(
Ok(collider1.collides_with(collider2.size, distance))
}
/// Detects overlapping entities and generates collision events for gameplay systems.
/// Detects overlapping entities and triggers collision observers immediately.
///
/// Performs distance-based collision detection between Pac-Man and collectible items
/// using each entity's position and collision radius. When entities overlap, emits
/// a `GameEvent::Collision` for the item system to handle scoring and removal.
/// using each entity's position and collision radius. When entities overlap, triggers
/// collision observers for immediate handling without race conditions.
/// Collision detection accounts for both entities being in motion and supports
/// circular collision boundaries for accurate gameplay feel.
///
/// Also detects collisions between Pac-Man and ghosts for gameplay mechanics like
/// power pellet effects, ghost eating, and player death.
#[allow(clippy::too_many_arguments)]
pub fn collision_system(
map: Res<Map>,
pacman_query: Query<(Entity, &Position, &Collider), With<PacmanCollider>>,
item_query: Query<(Entity, &Position, &Collider), With<ItemCollider>>,
ghost_query: Query<(Entity, &Position, &Collider), With<GhostCollider>>,
mut events: EventWriter<GameEvent>,
ghost_query: Query<(Entity, &Position, &Collider, &Ghost, &GhostState), With<GhostCollider>>,
mut commands: Commands,
mut errors: EventWriter<GameError>,
) {
// Check PACMAN × ITEM collisions
@@ -76,7 +88,8 @@ pub fn collision_system(
match check_collision(pacman_pos, pacman_collider, item_pos, item_collider, &map) {
Ok(colliding) => {
if colliding {
events.write(GameEvent::Collision(pacman_entity, item_entity));
trace!("Item collision detected");
commands.trigger(CollisionTrigger::ItemCollision { item: item_entity });
}
}
Err(e) => {
@@ -89,12 +102,19 @@ pub fn collision_system(
}
// Check PACMAN × GHOST collisions
for (ghost_entity, ghost_pos, ghost_collider) in ghost_query.iter() {
for (ghost_entity, ghost_pos, ghost_collider, ghost, ghost_state) in ghost_query.iter() {
match check_collision(pacman_pos, pacman_collider, ghost_pos, ghost_collider, &map) {
Ok(colliding) => {
if colliding {
events.write(GameEvent::Collision(pacman_entity, ghost_entity));
if !colliding || matches!(*ghost_state, GhostState::Eyes) {
continue;
}
trace!(ghost = ?ghost, "Ghost collision detected");
commands.trigger(CollisionTrigger::GhostCollision {
pacman: pacman_entity,
ghost: ghost_entity,
ghost_type: *ghost,
});
}
Err(e) => {
errors.write(GameError::InvalidState(format!(
@@ -107,42 +127,135 @@ pub fn collision_system(
}
}
pub fn ghost_collision_system(
mut collision_events: EventReader<GameEvent>,
/// Observer for handling ghost collisions immediately when they occur
#[allow(clippy::too_many_arguments)]
pub fn ghost_collision_observer(
trigger: Trigger<CollisionTrigger>,
mut stage_events: EventWriter<StageTransition>,
mut score: ResMut<ScoreResource>,
pacman_query: Query<(), With<PlayerControlled>>,
ghost_query: Query<(Entity, &Ghost), With<GhostCollider>>,
mut game_state: ResMut<GameStage>,
mut ghost_state_query: Query<&mut GhostState>,
mut events: EventWriter<AudioEvent>,
) {
for event in collision_events.read() {
if let GameEvent::Collision(entity1, entity2) = event {
// Check if one is Pacman and the other is a ghost
let (_pacman_entity, ghost_entity) = if pacman_query.get(*entity1).is_ok() && ghost_query.get(*entity2).is_ok() {
(*entity1, *entity2)
} else if pacman_query.get(*entity2).is_ok() && ghost_query.get(*entity1).is_ok() {
(*entity2, *entity1)
} else {
continue;
};
if let CollisionTrigger::GhostCollision {
pacman: _pacman,
ghost,
ghost_type,
} = *trigger
{
// Check if Pac-Man is already dying
if matches!(*game_state, GameStage::PlayerDying(_)) {
return;
}
// Check if the ghost is frightened
if let Ok((ghost_ent, _ghost_type)) = ghost_query.get(ghost_entity) {
if let Ok(mut ghost_state) = ghost_state_query.get_mut(ghost_ent) {
if let Ok(mut ghost_state) = ghost_state_query.get_mut(ghost) {
// Check if ghost is in frightened state
if matches!(*ghost_state, GhostState::Frightened { .. }) {
// Pac-Man eats the ghost
// Add score (200 points per ghost eaten)
debug!(ghost = ?ghost_type, score_added = 200, new_score = score.0 + 200, "Pacman ate frightened ghost");
score.0 += 200;
// Set ghost state to Eyes
*ghost_state = GhostState::Eyes;
// Play eat sound
events.write(AudioEvent::PlayEat);
// Enter short pause to show bonus points, hide ghost, then set Eyes after pause
// Request transition via event so stage_system can process it
stage_events.write(StageTransition::GhostEatenPause {
ghost_entity: ghost,
ghost_type,
});
// Play ghost eaten sound
events.write(AudioEvent::PlaySound(Sound::Ghost));
} else if matches!(*ghost_state, GhostState::Normal) {
// Pac-Man dies
warn!(ghost = ?ghost_type, "Pacman hit by normal ghost, player dies");
*game_state = GameStage::PlayerDying(DyingSequence::Frozen { remaining_ticks: 60 });
events.write(AudioEvent::StopAll);
} else {
// Pac-Man dies (this would need a death system)
}
trace!(ghost_state = ?*ghost_state, "Ghost collision ignored due to state");
}
}
}
}
/// Observer for handling item collisions immediately when they occur
#[allow(clippy::too_many_arguments)]
pub fn item_collision_observer(
trigger: Trigger<CollisionTrigger>,
mut commands: Commands,
mut score: ResMut<ScoreResource>,
mut pellet_count: ResMut<PelletCount>,
item_query: Query<(Entity, &EntityType, &Position), With<ItemCollider>>,
mut ghost_query: Query<&mut GhostState, With<GhostCollider>>,
mut fruit_sprites: ResMut<FruitSprites>,
mut events: EventWriter<AudioEvent>,
) {
if let CollisionTrigger::ItemCollision { item } = *trigger {
// Get the item type and update score
if let Ok((item_ent, entity_type, position)) = item_query.get(item) {
if let Some(score_value) = entity_type.score_value() {
trace!(item_entity = ?item_ent, item_type = ?entity_type, score_value, new_score = score.0 + score_value, "Item collected by player");
score.0 += score_value;
// Remove the collected item
commands.entity(item_ent).despawn();
// Track pellet consumption for fruit spawning
if *entity_type == EntityType::Pellet {
pellet_count.0 += 1;
trace!(pellet_count = pellet_count.0, "Pellet consumed");
// Check if we should spawn a fruit
if pellet_count.0 == 5 || pellet_count.0 == 170 {
debug!(pellet_count = pellet_count.0, "Fruit spawn milestone reached");
commands.trigger(SpawnTrigger::Fruit);
}
}
// Trigger bonus points effect if a fruit is collected
if let EntityType::Fruit(fruit) = *entity_type {
fruit_sprites.0.push(fruit);
commands.trigger(SpawnTrigger::Bonus {
position: *position,
value: entity_type.score_value().unwrap(),
ttl: 60 * 2,
});
}
// Trigger audio if appropriate
if entity_type.is_collectible() {
match *entity_type {
EntityType::Fruit(_) => {
events.write(AudioEvent::PlaySound(Sound::Fruit));
}
EntityType::Pellet | EntityType::PowerPellet => {
events.write(AudioEvent::Waka);
}
_ => {}
}
}
// Make non-eaten ghosts frightened when power pellet is collected
if matches!(*entity_type, EntityType::PowerPellet) {
debug!(
duration_ticks = constants::animation::GHOST_FRIGHTENED_TICKS,
"Power pellet collected, frightening ghosts"
);
for mut ghost_state in ghost_query.iter_mut() {
if matches!(*ghost_state, GhostState::Normal) {
*ghost_state = GhostState::new_frightened(
constants::animation::GHOST_FRIGHTENED_TICKS,
constants::animation::GHOST_FRIGHTENED_FLASH_START_TICKS,
);
}
}
debug!(
frightened_count = ghost_query.iter().count(),
"Ghosts set to frightened state"
);
}
}
}

View File

@@ -0,0 +1,43 @@
use bevy_ecs::bundle::Bundle;
use crate::systems::{
BufferedDirection, Collider, DirectionalAnimation, EntityType, Ghost, GhostCollider, GhostState, ItemCollider,
LastAnimationState, MovementModifiers, PacmanCollider, PlayerControlled, Position, Renderable, Velocity,
};
#[derive(Bundle)]
pub struct PlayerBundle {
pub player: PlayerControlled,
pub position: Position,
pub velocity: Velocity,
pub buffered_direction: BufferedDirection,
pub sprite: Renderable,
pub directional_animation: DirectionalAnimation,
pub entity_type: EntityType,
pub collider: Collider,
pub movement_modifiers: MovementModifiers,
pub pacman_collider: PacmanCollider,
}
#[derive(Bundle)]
pub struct ItemBundle {
pub position: Position,
pub sprite: Renderable,
pub entity_type: EntityType,
pub collider: Collider,
pub item_collider: ItemCollider,
}
#[derive(Bundle)]
pub struct GhostBundle {
pub ghost: Ghost,
pub position: Position,
pub velocity: Velocity,
pub sprite: Renderable,
pub directional_animation: DirectionalAnimation,
pub entity_type: EntityType,
pub collider: Collider,
pub ghost_collider: GhostCollider,
pub ghost_state: GhostState,
pub last_animation_state: LastAnimationState,
}

View File

@@ -0,0 +1,106 @@
use bevy_ecs::{component::Component, resource::Resource};
use crate::{map::graph::TraversalFlags, systems::FruitType};
/// A tag component denoting the type of entity.
#[derive(Component, Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum EntityType {
Player,
Ghost,
Pellet,
PowerPellet,
Fruit(FruitType),
Effect,
}
impl EntityType {
/// Returns the traversal flags for this entity type.
pub fn traversal_flags(&self) -> TraversalFlags {
match self {
EntityType::Player => TraversalFlags::PACMAN,
EntityType::Ghost => TraversalFlags::GHOST,
_ => TraversalFlags::empty(), // Static entities don't traverse
}
}
pub fn score_value(&self) -> Option<u32> {
match self {
EntityType::Pellet => Some(10),
EntityType::PowerPellet => Some(50),
EntityType::Fruit(fruit_type) => Some(fruit_type.score_value()),
_ => None,
}
}
pub fn is_collectible(&self) -> bool {
matches!(self, EntityType::Pellet | EntityType::PowerPellet | EntityType::Fruit(_))
}
}
#[derive(Resource)]
pub struct GlobalState {
pub exit: bool,
}
#[derive(Resource)]
pub struct ScoreResource(pub u32);
#[derive(Resource)]
pub struct DeltaTime {
/// Floating-point delta time in seconds
pub seconds: f32,
/// Integer tick delta (usually 1, but can be different for testing)
pub ticks: u32,
}
#[allow(dead_code)]
impl DeltaTime {
/// Creates a new DeltaTime from a floating-point delta time in seconds
///
/// While this method exists as a helper, it does not mean that seconds and ticks are interchangeable.
pub fn from_seconds(seconds: f32) -> Self {
Self {
seconds,
ticks: (seconds * 60.0).round() as u32,
}
}
/// Creates a new DeltaTime from an integer tick delta
///
/// While this method exists as a helper, it does not mean that seconds and ticks are interchangeable.
pub fn from_ticks(ticks: u32) -> Self {
Self {
seconds: ticks as f32 / 60.0,
ticks,
}
}
}
/// Movement modifiers that can affect Pac-Man's speed or handling.
#[derive(Component, Debug, Clone, Copy)]
pub struct MovementModifiers {
/// Multiplier applied to base speed (e.g., tunnels)
pub speed_multiplier: f32,
/// True when currently in a tunnel slowdown region
pub tunnel_slowdown_active: bool,
}
impl Default for MovementModifiers {
fn default() -> Self {
Self {
speed_multiplier: 1.0,
tunnel_slowdown_active: false,
}
}
}
/// Tag component for entities that should be frozen during startup
#[derive(Component, Debug, Clone, Copy, PartialEq, Eq)]
pub struct Frozen;
/// Component for HUD life sprite entities.
/// Each life sprite entity has an index indicating its position from left to right (0, 1, 2, etc.).
/// This mostly functions as a tag component for sprites.
#[derive(Component, Debug, Clone, Copy)]
pub struct PlayerLife {
pub index: u32,
}

View File

@@ -0,0 +1,5 @@
pub mod bundles;
pub mod components;
pub use self::bundles::*;
pub use self::components::*;

View File

@@ -1,364 +0,0 @@
use std::collections::HashMap;
use bevy_ecs::{bundle::Bundle, component::Component, resource::Resource};
use bitflags::bitflags;
use crate::{
map::graph::TraversalFlags,
systems::{
movement::{BufferedDirection, Position, Velocity},
Collider, GhostCollider, ItemCollider, PacmanCollider,
},
texture::{
animated::{DirectionalTiles, TileSequence},
sprite::AtlasTile,
},
};
/// A tag component for entities that are controlled by the player.
#[derive(Default, Component)]
pub struct PlayerControlled;
#[derive(Component, Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Ghost {
Blinky,
Pinky,
Inky,
Clyde,
}
impl Ghost {
/// Returns the ghost type name for atlas lookups.
pub fn as_str(self) -> &'static str {
match self {
Ghost::Blinky => "blinky",
Ghost::Pinky => "pinky",
Ghost::Inky => "inky",
Ghost::Clyde => "clyde",
}
}
/// Returns the base movement speed for this ghost type.
pub fn base_speed(self) -> f32 {
match self {
Ghost::Blinky => 1.0,
Ghost::Pinky => 0.95,
Ghost::Inky => 0.9,
Ghost::Clyde => 0.85,
}
}
/// Returns the ghost's color for debug rendering.
#[allow(dead_code)]
pub fn debug_color(&self) -> sdl2::pixels::Color {
match self {
Ghost::Blinky => sdl2::pixels::Color::RGB(255, 0, 0), // Red
Ghost::Pinky => sdl2::pixels::Color::RGB(255, 182, 255), // Pink
Ghost::Inky => sdl2::pixels::Color::RGB(0, 255, 255), // Cyan
Ghost::Clyde => sdl2::pixels::Color::RGB(255, 182, 85), // Orange
}
}
}
/// A tag component denoting the type of entity.
#[derive(Component, Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum EntityType {
Player,
Ghost,
Pellet,
PowerPellet,
}
impl EntityType {
/// Returns the traversal flags for this entity type.
pub fn traversal_flags(&self) -> TraversalFlags {
match self {
EntityType::Player => TraversalFlags::PACMAN,
EntityType::Ghost => TraversalFlags::GHOST,
_ => TraversalFlags::empty(), // Static entities don't traverse
}
}
pub fn score_value(&self) -> Option<u32> {
match self {
EntityType::Pellet => Some(10),
EntityType::PowerPellet => Some(50),
_ => None,
}
}
pub fn is_collectible(&self) -> bool {
matches!(self, EntityType::Pellet | EntityType::PowerPellet)
}
}
/// A component for entities that have a sprite, with a layer for ordering.
///
/// This is intended to be modified by other entities allowing animation.
#[derive(Component)]
pub struct Renderable {
pub sprite: AtlasTile,
pub layer: u8,
}
/// Directional animation component with shared timing across all directions
#[derive(Component, Clone, Copy)]
pub struct DirectionalAnimation {
pub moving_tiles: DirectionalTiles,
pub stopped_tiles: DirectionalTiles,
pub current_frame: usize,
pub time_bank: u16,
pub frame_duration: u16,
}
impl DirectionalAnimation {
/// Creates a new directional animation with the given tiles and frame duration
pub fn new(moving_tiles: DirectionalTiles, stopped_tiles: DirectionalTiles, frame_duration: u16) -> Self {
Self {
moving_tiles,
stopped_tiles,
current_frame: 0,
time_bank: 0,
frame_duration,
}
}
}
/// Linear animation component for non-directional animations (frightened ghosts)
#[derive(Component, Clone, Copy)]
pub struct LinearAnimation {
pub tiles: TileSequence,
pub current_frame: usize,
pub time_bank: u16,
pub frame_duration: u16,
}
impl LinearAnimation {
/// Creates a new linear animation with the given tiles and frame duration
pub fn new(tiles: TileSequence, frame_duration: u16) -> Self {
Self {
tiles,
current_frame: 0,
time_bank: 0,
frame_duration,
}
}
}
bitflags! {
#[derive(Component, Default, Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CollisionLayer: u8 {
const PACMAN = 1 << 0;
const GHOST = 1 << 1;
const ITEM = 1 << 2;
}
}
#[derive(Resource)]
pub struct GlobalState {
pub exit: bool,
}
#[derive(Resource)]
pub struct ScoreResource(pub u32);
#[derive(Resource)]
pub struct DeltaTime(pub f32);
/// Movement modifiers that can affect Pac-Man's speed or handling.
#[derive(Component, Debug, Clone, Copy)]
pub struct MovementModifiers {
/// Multiplier applied to base speed (e.g., tunnels)
pub speed_multiplier: f32,
/// True when currently in a tunnel slowdown region
pub tunnel_slowdown_active: bool,
}
impl Default for MovementModifiers {
fn default() -> Self {
Self {
speed_multiplier: 1.0,
tunnel_slowdown_active: false,
}
}
}
/// Tag component for entities that should be frozen during startup
#[derive(Component, Debug, Clone, Copy)]
pub struct Frozen;
/// Tag component for eaten ghosts
#[derive(Component, Debug, Clone, Copy)]
pub struct Eaten;
#[derive(Component, Debug, Clone, Copy)]
pub enum GhostState {
/// Normal ghost behavior - chasing Pac-Man
Normal,
/// Frightened state after power pellet - ghost can be eaten
Frightened {
remaining_ticks: u32,
flash: bool,
remaining_flash_ticks: u32,
},
/// Eyes state - ghost has been eaten and is returning to ghost house
Eyes,
}
/// Component to track the last animation state for efficient change detection
#[derive(Component, Debug, Clone, Copy, PartialEq)]
pub struct LastAnimationState(pub GhostAnimation);
impl GhostState {
/// Creates a new frightened state with the specified duration
pub fn new_frightened(total_ticks: u32, flash_start_ticks: u32) -> Self {
Self::Frightened {
remaining_ticks: total_ticks,
flash: false,
remaining_flash_ticks: flash_start_ticks, // Time until flashing starts
}
}
/// Ticks the ghost state, returning true if the state changed.
pub fn tick(&mut self) -> bool {
if let GhostState::Frightened {
remaining_ticks,
flash,
remaining_flash_ticks,
} = self
{
// Transition out of frightened state
if *remaining_ticks == 0 {
*self = GhostState::Normal;
return true;
}
*remaining_ticks -= 1;
if *remaining_flash_ticks > 0 {
*remaining_flash_ticks = remaining_flash_ticks.saturating_sub(1);
if *remaining_flash_ticks == 0 {
*flash = true;
true
} else {
false
}
} else {
false
}
} else {
false
}
}
/// Returns the appropriate animation state for this ghost state
pub fn animation_state(&self) -> GhostAnimation {
match self {
GhostState::Normal => GhostAnimation::Normal,
GhostState::Eyes => GhostAnimation::Eyes,
GhostState::Frightened { flash: false, .. } => GhostAnimation::Frightened { flash: false },
GhostState::Frightened { flash: true, .. } => GhostAnimation::Frightened { flash: true },
}
}
}
/// Enumeration of different ghost animation states.
/// Note that this is used in micromap which has a fixed size based on the number of variants,
/// so extending this should be done with caution, and will require updating the micromap's capacity.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum GhostAnimation {
/// Normal ghost appearance with directional movement animations
Normal,
/// Blue ghost appearance when vulnerable (power pellet active)
Frightened { flash: bool },
/// Eyes-only animation when ghost has been consumed by Pac-Man (Eaten state)
Eyes,
}
/// Global resource containing pre-loaded animation sets for all ghost types.
///
/// This resource is initialized once during game startup and provides O(1) access
/// to animation sets for each ghost type. The animation system uses this resource
/// to efficiently switch between different ghost states without runtime asset loading.
///
/// The HashMap is keyed by `Ghost` enum variants (Blinky, Pinky, Inky, Clyde) and
/// contains the normal directional animation for each ghost type.
#[derive(Resource)]
pub struct GhostAnimations {
pub normal: HashMap<Ghost, DirectionalAnimation>,
pub eyes: DirectionalAnimation,
pub frightened: LinearAnimation,
pub frightened_flashing: LinearAnimation,
}
impl GhostAnimations {
/// Creates a new GhostAnimations resource with the provided data.
pub fn new(
normal: HashMap<Ghost, DirectionalAnimation>,
eyes: DirectionalAnimation,
frightened: LinearAnimation,
frightened_flashing: LinearAnimation,
) -> Self {
Self {
normal,
eyes,
frightened,
frightened_flashing,
}
}
/// Gets the normal directional animation for the specified ghost type.
pub fn get_normal(&self, ghost_type: &Ghost) -> Option<&DirectionalAnimation> {
self.normal.get(ghost_type)
}
/// Gets the eyes animation (shared across all ghosts).
pub fn eyes(&self) -> &DirectionalAnimation {
&self.eyes
}
/// Gets the frightened animations (shared across all ghosts).
pub fn frightened(&self, flash: bool) -> &LinearAnimation {
if flash {
&self.frightened_flashing
} else {
&self.frightened
}
}
}
#[derive(Bundle)]
pub struct PlayerBundle {
pub player: PlayerControlled,
pub position: Position,
pub velocity: Velocity,
pub buffered_direction: BufferedDirection,
pub sprite: Renderable,
pub directional_animation: DirectionalAnimation,
pub entity_type: EntityType,
pub collider: Collider,
pub movement_modifiers: MovementModifiers,
pub pacman_collider: PacmanCollider,
}
#[derive(Bundle)]
pub struct ItemBundle {
pub position: Position,
pub sprite: Renderable,
pub entity_type: EntityType,
pub collider: Collider,
pub item_collider: ItemCollider,
}
#[derive(Bundle)]
pub struct GhostBundle {
pub ghost: Ghost,
pub position: Position,
pub velocity: Velocity,
pub sprite: Renderable,
pub directional_animation: DirectionalAnimation,
pub entity_type: EntityType,
pub collider: Collider,
pub ghost_collider: GhostCollider,
pub ghost_state: GhostState,
pub last_animation_state: LastAnimationState,
}

View File

@@ -1,6 +1,4 @@
//! Debug rendering system
use std::cmp::Ordering;
use crate::constants::{self, BOARD_PIXEL_OFFSET};
use crate::map::builder::Map;
use crate::systems::{Collider, CursorPosition, NodeId, Position, SystemTimings};
@@ -13,6 +11,7 @@ use sdl2::rect::{Point, Rect};
use sdl2::render::{Canvas, Texture};
use sdl2::video::Window;
use smallvec::SmallVec;
use std::cmp::Ordering;
use std::collections::{HashMap, HashSet};
use tracing::warn;
@@ -149,14 +148,16 @@ fn transform_position_with_offset(pos: Vec2, scale: f32) -> IVec2 {
}
/// Renders timing information in the top-left corner of the screen using the debug text atlas
#[cfg_attr(coverage_nightly, coverage(off))]
fn render_timing_display(
canvas: &mut Canvas<Window>,
timings: &SystemTimings,
current_tick: u64,
text_renderer: &TtfRenderer,
atlas: &mut TtfAtlas,
) {
// Format timing information using the formatting module
let lines = timings.format_timing_display();
let lines = timings.format_timing_display(current_tick);
let line_height = text_renderer.text_height(atlas) as i32 + 2; // Add 2px line spacing
let padding = 10;
@@ -202,12 +203,14 @@ fn render_timing_display(
}
#[allow(clippy::too_many_arguments)]
#[cfg_attr(coverage_nightly, coverage(off))]
pub fn debug_render_system(
canvas: &mut Canvas<Window>,
ttf_atlas: &mut TtfAtlasResource,
batched_lines: &Res<BatchedLinesResource>,
debug_state: &Res<DebugState>,
timings: &Res<SystemTimings>,
timing: &Res<crate::systems::profiling::Timing>,
map: &Res<Map>,
colliders: &Query<(&Collider, &Position)>,
cursor: &Res<CursorPosition>,
@@ -329,5 +332,8 @@ pub fn debug_render_system(
}
// Render timing information in the top-left corner
render_timing_display(canvas, timings, &text_renderer, &mut ttf_atlas.0);
// Use previous tick since current tick is incomplete (frame is still running)
let current_tick = timing.get_current_tick();
let previous_tick = current_tick.saturating_sub(1);
render_timing_display(canvas, timings, previous_tick, &text_renderer, &mut ttf_atlas.0);
}

View File

@@ -1,5 +1,7 @@
use std::collections::HashMap;
use crate::platform;
use crate::systems::components::{DirectionalAnimation, Frozen, GhostAnimation, GhostState, LastAnimationState, LinearAnimation};
use crate::systems::{DirectionalAnimation, Frozen, LinearAnimation, Looping};
use crate::{
map::{
builder::Map,
@@ -7,17 +9,186 @@ use crate::{
graph::{Edge, TraversalFlags},
},
systems::{
components::{DeltaTime, Ghost},
components::DeltaTime,
movement::{Position, Velocity},
},
};
use bevy_ecs::component::Component;
use bevy_ecs::resource::Resource;
use tracing::{debug, trace, warn};
use crate::systems::GhostAnimations;
use bevy_ecs::query::Without;
use bevy_ecs::system::{Commands, Query, Res};
use rand::seq::IndexedRandom;
use smallvec::SmallVec;
/// Tag component for Pac-Man during his death animation.
/// This is mainly because the Frozen tag would stop both movement and animation, while the Dying tag can signal that the animation should continue despite being frozen.
#[derive(Component, Debug, Clone, Copy)]
pub struct Dying;
#[derive(Component, Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Ghost {
Blinky,
Pinky,
Inky,
Clyde,
}
impl Ghost {
/// Returns the ghost type name for atlas lookups.
pub fn as_str(self) -> &'static str {
match self {
Ghost::Blinky => "blinky",
Ghost::Pinky => "pinky",
Ghost::Inky => "inky",
Ghost::Clyde => "clyde",
}
}
/// Returns the base movement speed for this ghost type.
pub fn base_speed(self) -> f32 {
match self {
Ghost::Blinky => 1.0,
Ghost::Pinky => 0.95,
Ghost::Inky => 0.9,
Ghost::Clyde => 0.85,
}
}
}
#[derive(Component, Debug, Clone, Copy, PartialEq, Eq)]
pub enum GhostState {
/// Normal ghost behavior - chasing Pac-Man
Normal,
/// Frightened state after power pellet - ghost can be eaten
Frightened {
remaining_ticks: u32,
flash: bool,
remaining_flash_ticks: u32,
},
/// Eyes state - ghost has been eaten and is returning to ghost house
Eyes,
}
impl GhostState {
/// Creates a new frightened state with the specified duration
pub fn new_frightened(total_ticks: u32, flash_start_ticks: u32) -> Self {
Self::Frightened {
remaining_ticks: total_ticks,
flash: false,
remaining_flash_ticks: flash_start_ticks, // Time until flashing starts
}
}
/// Ticks the ghost state, returning true if the state changed.
pub fn tick(&mut self) -> bool {
if let GhostState::Frightened {
remaining_ticks,
flash,
remaining_flash_ticks,
} = self
{
// Transition out of frightened state
if *remaining_ticks == 0 {
*self = GhostState::Normal;
return true;
}
*remaining_ticks -= 1;
if *remaining_flash_ticks > 0 {
*remaining_flash_ticks = remaining_flash_ticks.saturating_sub(1);
if *remaining_flash_ticks == 0 {
*flash = true;
true
} else {
false
}
} else {
false
}
} else {
false
}
}
/// Returns the appropriate animation state for this ghost state
pub fn animation_state(&self) -> GhostAnimation {
match self {
GhostState::Normal => GhostAnimation::Normal,
GhostState::Eyes => GhostAnimation::Eyes,
GhostState::Frightened { flash: false, .. } => GhostAnimation::Frightened { flash: false },
GhostState::Frightened { flash: true, .. } => GhostAnimation::Frightened { flash: true },
}
}
}
/// Enumeration of different ghost animation states.
/// Note that this is used in micromap which has a fixed size based on the number of variants,
/// so extending this should be done with caution, and will require updating the micromap's capacity.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum GhostAnimation {
/// Normal ghost appearance with directional movement animations
Normal,
/// Blue ghost appearance when vulnerable (power pellet active)
Frightened { flash: bool },
/// Eyes-only animation when ghost has been consumed by Pac-Man (Eaten state)
Eyes,
}
/// Global resource containing pre-loaded animation sets for all ghost types.
///
/// This resource is initialized once during game startup and provides O(1) access
/// to animation sets for each ghost type. The animation system uses this resource
/// to efficiently switch between different ghost states without runtime asset loading.
///
/// The HashMap is keyed by `Ghost` enum variants (Blinky, Pinky, Inky, Clyde) and
/// contains the normal directional animation for each ghost type.
#[derive(Resource)]
pub struct GhostAnimations {
pub normal: HashMap<Ghost, DirectionalAnimation>,
pub eyes: DirectionalAnimation,
pub frightened: LinearAnimation,
pub frightened_flashing: LinearAnimation,
}
impl GhostAnimations {
/// Creates a new GhostAnimations resource with the provided data.
pub fn new(
normal: HashMap<Ghost, DirectionalAnimation>,
eyes: DirectionalAnimation,
frightened: LinearAnimation,
frightened_flashing: LinearAnimation,
) -> Self {
Self {
normal,
eyes,
frightened,
frightened_flashing,
}
}
/// Gets the normal directional animation for the specified ghost type.
pub fn get_normal(&self, ghost_type: &Ghost) -> Option<&DirectionalAnimation> {
self.normal.get(ghost_type)
}
/// Gets the eyes animation (shared across all ghosts).
pub fn eyes(&self) -> &DirectionalAnimation {
&self.eyes
}
/// Gets the frightened animations (shared across all ghosts).
pub fn frightened(&self, flash: bool) -> &LinearAnimation {
if flash {
&self.frightened_flashing
} else {
&self.frightened
}
}
}
/// Autonomous ghost AI system implementing randomized movement with backtracking avoidance.
pub fn ghost_movement_system(
map: Res<Map>,
@@ -25,7 +196,7 @@ pub fn ghost_movement_system(
mut ghosts: Query<(&Ghost, &mut Velocity, &mut Position), Without<Frozen>>,
) {
for (_ghost, mut velocity, mut position) in ghosts.iter_mut() {
let mut distance = velocity.speed * 60.0 * delta_time.0;
let mut distance = velocity.speed * 60.0 * delta_time.seconds;
loop {
match *position {
Position::Stopped { node: current_node } => {
@@ -43,8 +214,10 @@ pub fn ghost_movement_system(
let new_edge: Edge = if non_opposite_options.is_empty() {
if let Some(edge) = intersection.get(opposite) {
trace!(node = current_node, ghost = ?_ghost, direction = ?opposite, "Ghost forced to reverse direction");
edge
} else {
warn!(node = current_node, ghost = ?_ghost, "Ghost stuck with no available directions");
break;
}
} else {
@@ -81,7 +254,7 @@ pub fn ghost_movement_system(
pub fn eaten_ghost_system(
map: Res<Map>,
delta_time: Res<DeltaTime>,
mut eaten_ghosts: Query<(&Ghost, &mut Position, &mut Velocity, &mut GhostState)>,
mut eaten_ghosts: Query<(&Ghost, &mut Position, &mut Velocity, &mut GhostState), Without<Frozen>>,
) {
for (ghost_type, mut position, mut velocity, mut ghost_state) in eaten_ghosts.iter_mut() {
// Only process ghosts that are in Eyes state
@@ -111,11 +284,12 @@ pub fn eaten_ghost_system(
}
}
Position::Moving { to, .. } => {
let distance = velocity.speed * 60.0 * delta_time.0;
let distance = velocity.speed * 60.0 * delta_time.seconds;
if let Some(_overflow) = position.tick(distance) {
// Reached target node, check if we're at ghost house center
if to == ghost_house_center {
// Respawn the ghost - set state back to normal
debug!(ghost = ?ghost_type, "Eaten ghost reached ghost house, respawning as normal");
*ghost_state = GhostState::Normal;
// Reset to stopped at ghost house center
*position = Position::Stopped {
@@ -179,6 +353,10 @@ fn find_direction_to_target(
None
}
/// Component to track the last animation state for efficient change detection
#[derive(Component, Debug, Clone, Copy, PartialEq)]
pub struct LastAnimationState(pub GhostAnimation);
/// Unified system that manages ghost state transitions and animations with component swapping
pub fn ghost_state_system(
mut commands: Commands,
@@ -192,24 +370,30 @@ pub fn ghost_state_system(
// Only update animation if the animation state actually changed
let current_animation_state = ghost_state.animation_state();
if last_animation_state.0 != current_animation_state {
trace!(ghost = ?ghost_type, old_state = ?last_animation_state.0, new_state = ?current_animation_state, "Ghost animation state changed");
match current_animation_state {
GhostAnimation::Frightened { flash } => {
// Remove DirectionalAnimation, add LinearAnimation
// Remove DirectionalAnimation, add LinearAnimation with Looping component
commands
.entity(entity)
.remove::<DirectionalAnimation>()
.insert(*animations.frightened(flash));
.insert(animations.frightened(flash).clone())
.insert(Looping);
}
GhostAnimation::Normal => {
// Remove LinearAnimation, add DirectionalAnimation
// Remove LinearAnimation and Looping, add DirectionalAnimation
commands
.entity(entity)
.remove::<LinearAnimation>()
.insert(*animations.get_normal(ghost_type).unwrap());
.remove::<(LinearAnimation, Looping)>()
.insert(animations.get_normal(ghost_type).unwrap().clone());
}
GhostAnimation::Eyes => {
// Remove LinearAnimation, add DirectionalAnimation (eyes animation)
commands.entity(entity).remove::<LinearAnimation>().insert(*animations.eyes());
// Remove LinearAnimation and Looping, add DirectionalAnimation (eyes animation)
trace!(ghost = ?ghost_type, "Switching to eyes animation for eaten ghost");
commands
.entity(entity)
.remove::<(LinearAnimation, Looping)>()
.insert(animations.eyes().clone());
}
}
last_animation_state.0 = current_animation_state;

79
src/systems/hud/fruits.rs Normal file
View File

@@ -0,0 +1,79 @@
use crate::systems::item::FruitType;
use crate::texture::sprites::GameSprite;
use bevy_ecs::component::Component;
use bevy_ecs::resource::Resource;
#[derive(Component)]
pub struct FruitInHud {
pub index: u32,
}
#[derive(Resource, Default)]
pub struct FruitSprites(pub Vec<FruitType>);
use crate::constants::{BOARD_BOTTOM_PIXEL_OFFSET, CANVAS_SIZE, CELL_SIZE};
use crate::error::GameError;
use crate::systems::{PixelPosition, Renderable};
use crate::texture::sprite::SpriteAtlas;
use bevy_ecs::entity::Entity;
use bevy_ecs::event::EventWriter;
use bevy_ecs::system::{Commands, NonSendMut, Query, Res};
use glam::Vec2;
/// Calculates the pixel position for a fruit sprite based on its index
fn calculate_fruit_sprite_position(index: u32) -> Vec2 {
let start_x = CANVAS_SIZE.x - CELL_SIZE * 2; // 2 cells from right
let start_y = CANVAS_SIZE.y - BOARD_BOTTOM_PIXEL_OFFSET.y + (CELL_SIZE / 2) + 1; // In bottom area
let sprite_spacing = CELL_SIZE + CELL_SIZE / 2; // 1.5 cells between sprites
let x = start_x - ((index as f32) * (sprite_spacing as f32 * 1.5)).round() as u32;
let y = start_y - CELL_SIZE / 2;
Vec2::new((x - CELL_SIZE) as f32, (y + CELL_SIZE) as f32)
}
/// System that manages fruit sprite entities in the HUD.
/// Spawns and despawns fruit sprite entities based on changes to FruitSprites resource.
/// Displays up to 6 fruits, sorted by value.
pub fn fruit_sprite_system(
mut commands: Commands,
atlas: NonSendMut<SpriteAtlas>,
current_fruit_sprites: Query<(Entity, &FruitInHud)>,
fruit_sprites: Res<FruitSprites>,
mut errors: EventWriter<GameError>,
) {
// We only want to display the greatest 6 fruits
let fruits_to_display: Vec<_> = fruit_sprites.0.iter().rev().take(6).collect();
let mut current_sprites: Vec<_> = current_fruit_sprites.iter().collect();
current_sprites.sort_by_key(|(_, fruit)| fruit.index);
// Despawn all current sprites. We will respawn them.
// This is simpler than trying to match them up.
for (entity, _) in &current_sprites {
commands.entity(*entity).despawn();
}
for (i, fruit_type) in fruits_to_display.iter().enumerate() {
let fruit_sprite = match atlas.get_tile(&GameSprite::Fruit(**fruit_type).to_path()) {
Ok(sprite) => sprite,
Err(e) => {
errors.write(e.into());
continue;
}
};
let position = calculate_fruit_sprite_position(i as u32);
commands.spawn((
FruitInHud { index: i as u32 },
Renderable {
sprite: fruit_sprite,
layer: 255, // High layer to render on top
},
PixelPosition {
pixel_position: position,
},
));
}
}

89
src/systems/hud/lives.rs Normal file
View File

@@ -0,0 +1,89 @@
use std::cmp::Ordering;
use crate::constants::{BOARD_BOTTOM_PIXEL_OFFSET, CANVAS_SIZE, CELL_SIZE};
use crate::error::GameError;
use crate::map::direction::Direction;
use crate::systems::{PixelPosition, PlayerLife, PlayerLives, Renderable};
use crate::texture::sprite::SpriteAtlas;
use crate::texture::sprites::{GameSprite, PacmanSprite};
use bevy_ecs::entity::Entity;
use bevy_ecs::event::EventWriter;
use bevy_ecs::system::{Commands, NonSendMut, Query, Res};
use glam::Vec2;
/// Calculates the pixel position for a life sprite based on its index
fn calculate_life_sprite_position(index: u32) -> Vec2 {
let start_x = CELL_SIZE * 2; // 2 cells from left
let start_y = CANVAS_SIZE.y - BOARD_BOTTOM_PIXEL_OFFSET.y + (CELL_SIZE / 2) + 1; // In bottom area
let sprite_spacing = CELL_SIZE + CELL_SIZE / 2; // 1.5 cells between sprites
let x = start_x + ((index as f32) * (sprite_spacing as f32 * 1.5)).round() as u32;
let y = start_y - CELL_SIZE / 2;
Vec2::new((x + CELL_SIZE) as f32, (y + CELL_SIZE) as f32)
}
/// System that manages player life sprite entities.
/// Spawns and despawns life sprite entities based on changes to PlayerLives resource.
/// Each life sprite is positioned based on its index (0, 1, 2, etc. from left to right).
pub fn player_life_sprite_system(
mut commands: Commands,
atlas: NonSendMut<SpriteAtlas>,
current_life_sprites: Query<(Entity, &PlayerLife)>,
player_lives: Res<PlayerLives>,
mut errors: EventWriter<GameError>,
) {
let displayed_lives = player_lives.0.saturating_sub(1);
// Get current life sprite entities, sorted by index
let mut current_sprites: Vec<_> = current_life_sprites.iter().collect();
current_sprites.sort_by_key(|(_, life)| life.index);
let current_count = current_sprites.len() as u8;
// Calculate the difference
let diff = (displayed_lives as i8) - (current_count as i8);
match diff.cmp(&0) {
// Ignore when the number of lives displayed is correct
Ordering::Equal => {}
// Spawn new life sprites
Ordering::Greater => {
let life_sprite = match atlas.get_tile(&GameSprite::Pacman(PacmanSprite::Moving(Direction::Left, 1)).to_path()) {
Ok(sprite) => sprite,
Err(e) => {
errors.write(e.into());
return;
}
};
for i in 0..diff {
let position = calculate_life_sprite_position(i as u32);
commands.spawn((
PlayerLife { index: i as u32 },
Renderable {
sprite: life_sprite,
layer: 255, // High layer to render on top
},
PixelPosition {
pixel_position: position,
},
));
}
}
// Remove excess life sprites (highest indices first)
Ordering::Less => {
let to_remove = diff.unsigned_abs();
let sprites_to_remove: Vec<_> = current_sprites
.iter()
.rev() // Start from highest index
.take(to_remove as usize)
.map(|(entity, _)| *entity)
.collect();
for entity in sprites_to_remove {
commands.entity(entity).despawn();
}
}
}
}

9
src/systems/hud/mod.rs Normal file
View File

@@ -0,0 +1,9 @@
pub mod fruits;
pub mod lives;
pub mod score;
pub mod touch;
pub use self::fruits::*;
pub use self::lives::*;
pub use self::score::*;
pub use self::touch::*;

86
src/systems/hud/score.rs Normal file
View File

@@ -0,0 +1,86 @@
use crate::constants;
use crate::error::{GameError, TextureError};
use crate::systems::{BackbufferResource, GameStage, ScoreResource, StartupSequence};
use crate::texture::sprite::SpriteAtlas;
use crate::texture::text::TextTexture;
use bevy_ecs::event::EventWriter;
use bevy_ecs::system::{NonSendMut, Res};
use sdl2::pixels::Color;
use sdl2::render::Canvas;
use sdl2::video::Window;
/// Renders the HUD (score, lives, etc.) on top of the game.
#[allow(clippy::too_many_arguments)]
pub fn hud_render_system(
mut backbuffer: NonSendMut<BackbufferResource>,
mut canvas: NonSendMut<&mut Canvas<Window>>,
mut atlas: NonSendMut<SpriteAtlas>,
score: Res<ScoreResource>,
stage: Res<GameStage>,
mut errors: EventWriter<GameError>,
) {
let _ = canvas.with_texture_canvas(&mut backbuffer.0, |canvas| {
let mut text_renderer = TextTexture::new(1.0);
// Render lives and high score text in white
let lives_text = "1UP HIGH SCORE ";
let lives_position = glam::UVec2::new(4 + 8 * 3, 2); // x_offset + lives_offset * 8, y_offset
if let Err(e) = text_renderer.render(canvas, &mut atlas, lives_text, lives_position) {
errors.write(TextureError::RenderFailed(format!("Failed to render lives text: {}", e)).into());
}
// Render score text
let score_text = format!("{:02}", score.0);
let score_offset = 7 - (score_text.len() as i32);
let score_position = glam::UVec2::new(4 + 8 * score_offset as u32, 10); // x_offset + score_offset * 8, 8 + y_offset
if let Err(e) = text_renderer.render(canvas, &mut atlas, &score_text, score_position) {
errors.write(TextureError::RenderFailed(format!("Failed to render score text: {}", e)).into());
}
// Render high score text
let high_score_text = format!("{:02}", score.0);
let high_score_offset = 17 - (high_score_text.len() as i32);
let high_score_position = glam::UVec2::new(4 + 8 * high_score_offset as u32, 10); // x_offset + score_offset * 8, 8 + y_offset
if let Err(e) = text_renderer.render(canvas, &mut atlas, &high_score_text, high_score_position) {
errors.write(TextureError::RenderFailed(format!("Failed to render high score text: {}", e)).into());
}
// Render GAME OVER text
if matches!(*stage, GameStage::GameOver) {
let game_over_text = "GAME OVER";
let game_over_width = text_renderer.text_width(game_over_text);
let game_over_position = glam::UVec2::new((constants::CANVAS_SIZE.x - game_over_width) / 2, 160);
if let Err(e) = text_renderer.render_with_color(canvas, &mut atlas, game_over_text, game_over_position, Color::RED) {
errors.write(TextureError::RenderFailed(format!("Failed to render GAME OVER text: {}", e)).into());
}
}
// Render text based on StartupSequence stage
if matches!(
*stage,
GameStage::Starting(StartupSequence::TextOnly { .. })
| GameStage::Starting(StartupSequence::CharactersVisible { .. })
) {
let ready_text = "READY!";
let ready_width = text_renderer.text_width(ready_text);
let ready_position = glam::UVec2::new((constants::CANVAS_SIZE.x - ready_width) / 2, 160);
if let Err(e) = text_renderer.render_with_color(canvas, &mut atlas, ready_text, ready_position, Color::YELLOW) {
errors.write(TextureError::RenderFailed(format!("Failed to render READY text: {}", e)).into());
}
if matches!(*stage, GameStage::Starting(StartupSequence::TextOnly { .. })) {
let player_one_text = "PLAYER ONE";
let player_one_width = text_renderer.text_width(player_one_text);
let player_one_position = glam::UVec2::new((constants::CANVAS_SIZE.x - player_one_width) / 2, 113);
if let Err(e) =
text_renderer.render_with_color(canvas, &mut atlas, player_one_text, player_one_position, Color::CYAN)
{
errors.write(TextureError::RenderFailed(format!("Failed to render PLAYER ONE text: {}", e)).into());
}
}
}
});
}

81
src/systems/hud/touch.rs Normal file
View File

@@ -0,0 +1,81 @@
use crate::error::{GameError, TextureError};
use crate::systems::{BackbufferResource, TouchState};
use bevy_ecs::event::EventWriter;
use bevy_ecs::system::{NonSendMut, Res};
use sdl2::pixels::Color;
use sdl2::rect::Point;
use sdl2::render::{BlendMode, Canvas};
use sdl2::video::Window;
/// Renders touch UI overlay for mobile/testing.
pub fn touch_ui_render_system(
mut backbuffer: NonSendMut<BackbufferResource>,
mut canvas: NonSendMut<&mut Canvas<Window>>,
touch_state: Res<TouchState>,
mut errors: EventWriter<GameError>,
) {
if let Some(ref touch_data) = touch_state.active_touch {
let _ = canvas.with_texture_canvas(&mut backbuffer.0, |canvas| {
// Set blend mode for transparency
canvas.set_blend_mode(BlendMode::Blend);
// Draw semi-transparent circle at touch start position
canvas.set_draw_color(Color::RGBA(255, 255, 255, 100));
let center = Point::new(touch_data.start_pos.x as i32, touch_data.start_pos.y as i32);
// Draw a simple circle by drawing filled rectangles (basic approach)
let radius = 30;
for dy in -radius..=radius {
for dx in -radius..=radius {
if dx * dx + dy * dy <= radius * radius {
let point = Point::new(center.x + dx, center.y + dy);
if let Err(e) = canvas.draw_point(point) {
errors.write(TextureError::RenderFailed(format!("Touch UI render error: {}", e)).into());
return;
}
}
}
}
// Draw direction indicator if we have a direction
if let Some(direction) = touch_data.current_direction {
canvas.set_draw_color(Color::RGBA(0, 255, 0, 150));
// Draw arrow indicating direction
let arrow_length = 40;
let (dx, dy) = match direction {
crate::map::direction::Direction::Up => (0, -arrow_length),
crate::map::direction::Direction::Down => (0, arrow_length),
crate::map::direction::Direction::Left => (-arrow_length, 0),
crate::map::direction::Direction::Right => (arrow_length, 0),
};
let end_point = Point::new(center.x + dx, center.y + dy);
if let Err(e) = canvas.draw_line(center, end_point) {
errors.write(TextureError::RenderFailed(format!("Touch arrow render error: {}", e)).into());
}
// Draw arrowhead (simple approach)
let arrow_size = 8;
match direction {
crate::map::direction::Direction::Up => {
let _ = canvas.draw_line(end_point, Point::new(end_point.x - arrow_size, end_point.y + arrow_size));
let _ = canvas.draw_line(end_point, Point::new(end_point.x + arrow_size, end_point.y + arrow_size));
}
crate::map::direction::Direction::Down => {
let _ = canvas.draw_line(end_point, Point::new(end_point.x - arrow_size, end_point.y - arrow_size));
let _ = canvas.draw_line(end_point, Point::new(end_point.x + arrow_size, end_point.y - arrow_size));
}
crate::map::direction::Direction::Left => {
let _ = canvas.draw_line(end_point, Point::new(end_point.x + arrow_size, end_point.y - arrow_size));
let _ = canvas.draw_line(end_point, Point::new(end_point.x + arrow_size, end_point.y + arrow_size));
}
crate::map::direction::Direction::Right => {
let _ = canvas.draw_line(end_point, Point::new(end_point.x - arrow_size, end_point.y - arrow_size));
let _ = canvas.draw_line(end_point, Point::new(end_point.x - arrow_size, end_point.y + arrow_size));
}
}
}
});
}
}

View File

@@ -12,19 +12,18 @@ use sdl2::{
EventPump,
};
use smallvec::{smallvec, SmallVec};
use tracing::{debug, info};
use crate::systems::components::DeltaTime;
use crate::systems::DeltaTime;
use crate::{
events::{GameCommand, GameEvent},
map::direction::Direction,
};
// Touch input constants
const TOUCH_DIRECTION_THRESHOLD: f32 = 10.0;
const TOUCH_EASING_DISTANCE_THRESHOLD: f32 = 1.0;
const MAX_TOUCH_MOVEMENT_SPEED: f32 = 100.0;
const TOUCH_EASING_FACTOR: f32 = 1.5;
pub const TOUCH_DIRECTION_THRESHOLD: f32 = 10.0;
pub const TOUCH_EASING_DISTANCE_THRESHOLD: f32 = 1.0;
pub const MAX_TOUCH_MOVEMENT_SPEED: f32 = 100.0;
pub const TOUCH_EASING_FACTOR: f32 = 1.5;
#[derive(Resource, Default, Debug, Copy, Clone)]
pub enum CursorPosition {
@@ -36,7 +35,7 @@ pub enum CursorPosition {
},
}
#[derive(Resource, Default, Debug)]
#[derive(Resource, Default, Debug, Clone)]
pub struct TouchState {
pub active_touch: Option<TouchData>,
}
@@ -86,8 +85,12 @@ impl Default for Bindings {
key_bindings.insert(Keycode::Space, GameCommand::ToggleDebug);
key_bindings.insert(Keycode::M, GameCommand::MuteAudio);
key_bindings.insert(Keycode::R, GameCommand::ResetLevel);
#[cfg(not(target_os = "emscripten"))]
{
key_bindings.insert(Keycode::Escape, GameCommand::Exit);
key_bindings.insert(Keycode::Q, GameCommand::Exit);
}
let movement_keys = HashSet::from([
Keycode::W,
@@ -161,7 +164,7 @@ pub fn process_simple_key_events(bindings: &mut Bindings, frame_events: &[Simple
}
/// Calculates the primary direction from a 2D vector delta
fn calculate_direction_from_delta(delta: Vec2) -> Direction {
pub fn calculate_direction_from_delta(delta: Vec2) -> Direction {
if delta.x.abs() > delta.y.abs() {
if delta.x > 0.0 {
Direction::Right
@@ -180,7 +183,7 @@ fn calculate_direction_from_delta(delta: Vec2) -> Direction {
/// This slowly moves the start_pos towards the current_pos, with the speed
/// decreasing as the distance gets smaller. The maximum movement speed is capped.
/// Returns the delta vector and its length for reuse by the caller.
fn update_touch_reference_position(touch_data: &mut TouchData, delta_time: f32) -> (Vec2, f32) {
pub fn update_touch_reference_position(touch_data: &mut TouchData, delta_time: f32) -> (Vec2, f32) {
// Calculate the vector from start to current position
let delta = touch_data.current_pos - touch_data.start_pos;
let distance = delta.length();
@@ -221,16 +224,6 @@ pub fn input_system(
// Collect all events for this frame.
let frame_events: SmallVec<[Event; 3]> = pump.poll_iter().collect();
// Warn if the smallvec was heap allocated due to exceeding stack capacity
#[cfg(debug_assertions)]
if frame_events.len() > frame_events.capacity() {
tracing::warn!(
"More than {} events in a frame, consider adjusting stack capacity: {:?}",
frame_events.capacity(),
frame_events
);
}
// Handle non-keyboard events inline and build a simplified keyboard event stream.
let mut simple_key_events: SmallVec<[SimpleKeyEvent; 3]> = smallvec![];
for event in &frame_events {
@@ -298,19 +291,15 @@ pub fn input_system(
simple_key_events.push(SimpleKeyEvent::KeyUp(key));
}
}
Event::Window { win_event, .. } => match win_event {
WindowEvent::Resized(w, h) => {
info!("Window resized to {}x{}", w, h);
Event::Window { win_event, .. } => {
if let WindowEvent::Resized(w, h) = win_event {
tracing::info!(width = w, height = h, event = ?win_event, "Window Resized");
}
}
// Despite disabling this event, it's still received, so we ignore it explicitly.
Event::RenderTargetsReset { .. } => {}
_ => {
debug!("Window event: {:?}", win_event);
}
},
Event::RenderTargetsReset { .. } => {
// No-op
}
_ => {
tracing::warn!("Unhandled event, consider disabling: {:?}", event);
tracing::warn!(event = ?event, "Unhandled Event");
}
}
}
@@ -324,7 +313,7 @@ pub fn input_system(
// Update touch reference position with easing
if let Some(ref mut touch_data) = touch_state.active_touch {
// Apply easing to the reference position and get the delta for direction calculation
let (delta, distance) = update_touch_reference_position(touch_data, delta_time.0);
let (delta, distance) = update_touch_reference_position(touch_data, delta_time.seconds);
// Check for direction based on updated reference position
if distance >= TOUCH_DIRECTION_THRESHOLD {
@@ -341,7 +330,7 @@ pub fn input_system(
}
if let (false, CursorPosition::Some { remaining_time, .. }) = (cursor_seen, &mut *cursor) {
*remaining_time -= delta_time.0;
*remaining_time -= delta_time.seconds;
if *remaining_time <= 0.0 {
*cursor = CursorPosition::None;
}

View File

@@ -1,74 +1,137 @@
use bevy_ecs::{
entity::Entity,
event::{EventReader, EventWriter},
query::With,
system::{Commands, Query, ResMut},
event::Event,
observer::Trigger,
system::{Commands, NonSendMut, Res},
};
use strum_macros::IntoStaticStr;
use tracing::debug;
use crate::{
constants::animation::FRIGHTENED_FLASH_START_TICKS,
events::GameEvent,
systems::{AudioEvent, EntityType, GhostCollider, GhostState, ItemCollider, PacmanCollider, ScoreResource},
constants,
map::builder::Map,
systems::{common::bundles::ItemBundle, Collider, Position, Renderable, TimeToLive},
texture::{
sprite::SpriteAtlas,
sprites::{EffectSprite, GameSprite},
},
};
/// Determines if a collision between two entity types should be handled by the item system.
///
/// Returns `true` if one entity is a player and the other is a collectible item.
#[allow(dead_code)]
pub fn is_valid_item_collision(entity1: EntityType, entity2: EntityType) -> bool {
match (entity1, entity2) {
(EntityType::Player, entity) | (entity, EntityType::Player) => entity.is_collectible(),
_ => false,
use crate::{systems::common::components::EntityType, systems::ItemCollider};
use std::cmp::Ordering;
/// Tracks the number of pellets consumed by the player for fruit spawning mechanics.
#[derive(bevy_ecs::resource::Resource, Debug, Default)]
pub struct PelletCount(pub u32);
/// Represents the different fruit sprites that can appear as bonus items.
#[derive(IntoStaticStr, Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[strum(serialize_all = "snake_case")]
pub enum FruitType {
Cherry,
Strawberry,
Orange,
Apple,
Melon,
Galaxian,
Bell,
Key,
}
impl PartialOrd for FruitType {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
pub fn item_system(
impl Ord for FruitType {
fn cmp(&self, other: &Self) -> Ordering {
(self.score_value()).cmp(&other.score_value())
}
}
impl FruitType {
/// Returns the score value for this fruit type.
pub fn score_value(self) -> u32 {
match self {
FruitType::Cherry => 100,
FruitType::Strawberry => 300,
FruitType::Orange => 500,
FruitType::Apple => 700,
FruitType::Melon => 1000,
FruitType::Galaxian => 2000,
FruitType::Bell => 3000,
FruitType::Key => 5000,
}
}
pub fn from_index(index: u8) -> Self {
match index {
0 => FruitType::Cherry,
1 => FruitType::Strawberry,
2 => FruitType::Orange,
3 => FruitType::Apple,
4 => FruitType::Melon,
5 => FruitType::Galaxian,
6 => FruitType::Bell,
7 => FruitType::Key,
_ => panic!("Invalid fruit index: {}", index),
}
}
}
/// Trigger to spawn a fruit
#[derive(Event, Clone, Copy, Debug)]
pub enum SpawnTrigger {
Fruit,
Bonus { position: Position, value: u32, ttl: u32 },
}
pub fn spawn_fruit_observer(
trigger: Trigger<SpawnTrigger>,
mut commands: Commands,
mut collision_events: EventReader<GameEvent>,
mut score: ResMut<ScoreResource>,
pacman_query: Query<Entity, With<PacmanCollider>>,
item_query: Query<(Entity, &EntityType), With<ItemCollider>>,
mut ghost_query: Query<&mut GhostState, With<GhostCollider>>,
mut events: EventWriter<AudioEvent>,
atlas: NonSendMut<SpriteAtlas>,
map: Res<Map>,
) {
for event in collision_events.read() {
if let GameEvent::Collision(entity1, entity2) = event {
// Check if one is Pacman and the other is an item
let (_pacman_entity, item_entity) = if pacman_query.get(*entity1).is_ok() && item_query.get(*entity2).is_ok() {
(*entity1, *entity2)
} else if pacman_query.get(*entity2).is_ok() && item_query.get(*entity1).is_ok() {
(*entity2, *entity1)
} else {
continue;
let entity = match *trigger {
SpawnTrigger::Fruit => {
// Use cherry sprite as the default fruit (first fruit in original Pac-Man)
let sprite = &atlas
.get_tile(&GameSprite::Fruit(FruitType::from_index(0)).to_path())
.unwrap();
let bundle = ItemBundle {
position: map.start_positions.fruit_spawn,
sprite: Renderable {
sprite: *sprite,
layer: 1,
},
entity_type: EntityType::Fruit(FruitType::Cherry),
collider: Collider {
size: constants::collider::FRUIT_SIZE,
},
item_collider: ItemCollider,
};
// Get the item type and update score
if let Ok((item_ent, entity_type)) = item_query.get(item_entity) {
if let Some(score_value) = entity_type.score_value() {
score.0 += score_value;
commands.spawn(bundle)
}
SpawnTrigger::Bonus { position, value, ttl } => {
let sprite = &atlas
.get_tile(&GameSprite::Effect(EffectSprite::Bonus(value)).to_path())
.unwrap();
// Remove the collected item
commands.entity(item_ent).despawn();
let bundle = (
position,
TimeToLive::new(ttl),
Renderable {
sprite: *sprite,
layer: 1,
},
EntityType::Effect,
);
// Trigger audio if appropriate
if entity_type.is_collectible() {
events.write(AudioEvent::PlayEat);
commands.spawn(bundle)
}
};
// Make ghosts frightened when power pellet is collected
if *entity_type == EntityType::PowerPellet {
// Convert seconds to frames (assumes 60 FPS)
let total_ticks = 60 * 5; // 5 seconds total
// Set all ghosts to frightened state, except those in Eyes state
for mut ghost_state in ghost_query.iter_mut() {
if !matches!(*ghost_state, GhostState::Eyes) {
*ghost_state = GhostState::new_frightened(total_ticks, FRIGHTENED_FLASH_START_TICKS);
}
}
}
}
}
}
}
debug!(entity = ?entity.id(), "Entity spawned via trigger");
}

33
src/systems/lifetime.rs Normal file
View File

@@ -0,0 +1,33 @@
use bevy_ecs::{
component::Component,
entity::Entity,
system::{Commands, Query, Res},
};
use crate::systems::DeltaTime;
/// Component for entities that should be automatically deleted after a certain number of ticks
#[derive(Component, Debug, Clone, Copy)]
pub struct TimeToLive {
pub remaining_ticks: u32,
}
impl TimeToLive {
pub fn new(ticks: u32) -> Self {
Self { remaining_ticks: ticks }
}
}
/// System that manages entities with TimeToLive components, decrementing their remaining ticks
/// and despawning them when they expire
pub fn time_to_live_system(mut commands: Commands, dt: Res<DeltaTime>, mut query: Query<(Entity, &mut TimeToLive)>) {
for (entity, mut ttl) in query.iter_mut() {
if ttl.remaining_ticks <= dt.ticks {
// Entity has expired, despawn it
commands.entity(entity).despawn();
} else {
// Decrement remaining time
ttl.remaining_ticks = ttl.remaining_ticks.saturating_sub(dt.ticks);
}
}
}

View File

@@ -1,32 +1,41 @@
//! The Entity-Component-System (ECS) module.
//!
//! This module contains all the ECS-related logic, including components, systems,
//! and resources.
//! This module contains all the systems in the game.
// These modules are excluded from coverage.
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod audio;
pub mod blinking;
pub mod collision;
pub mod components;
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod debug;
pub mod ghost;
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod profiling;
#[cfg_attr(coverage_nightly, coverage(off))]
pub mod render;
mod animation;
mod collision;
pub mod common;
mod ghost;
mod hud;
pub mod input;
pub mod item;
pub mod lifetime;
pub mod movement;
pub mod player;
pub mod profiling;
pub mod render;
pub mod stage;
pub mod state;
// Re-export all the modules. Do not fine-tune the exports.
pub use self::animation::*;
pub use self::audio::*;
pub use self::blinking::*;
pub use self::collision::*;
pub use self::components::*;
pub use self::common::*;
pub use self::debug::*;
pub use self::ghost::*;
pub use self::hud::*;
pub use self::input::*;
pub use self::item::*;
pub use self::lifetime::*;
pub use self::movement::*;
pub use self::player::*;
pub use self::profiling::*;
pub use self::render::*;
pub use self::stage::*;
pub use self::state::*;

View File

@@ -1,21 +1,26 @@
use bevy_ecs::{
event::{EventReader, EventWriter},
component::Component,
event::EventReader,
query::{With, Without},
system::{Query, Res, ResMut},
system::{Query, Res, ResMut, Single},
};
use tracing::trace;
use crate::{
error::GameError,
events::{GameCommand, GameEvent},
map::{builder::Map, graph::Edge},
systems::{
components::{DeltaTime, EntityType, Frozen, GlobalState, MovementModifiers, PlayerControlled},
components::{DeltaTime, EntityType, Frozen, GlobalState, MovementModifiers},
debug::DebugState,
movement::{BufferedDirection, Position, Velocity},
AudioState,
},
};
/// A tag component for entities that are controlled by the player.
#[derive(Default, Component)]
pub struct PlayerControlled;
pub fn can_traverse(entity_type: EntityType, edge: Edge) -> bool {
let entity_flags = entity_type.traversal_flags();
edge.traversal_flags.contains(entity_flags)
@@ -27,36 +32,29 @@ pub fn can_traverse(entity_type: EntityType, edge: Edge) -> bool {
/// toggling, audio muting, and game exit requests. Movement commands are buffered
/// to allow direction changes before reaching intersections, improving gameplay
/// responsiveness. Non-movement commands immediately modify global game state.
#[allow(clippy::type_complexity)]
pub fn player_control_system(
mut events: EventReader<GameEvent>,
mut state: ResMut<GlobalState>,
mut debug_state: ResMut<DebugState>,
mut audio_state: ResMut<AudioState>,
mut players: Query<&mut BufferedDirection, (With<PlayerControlled>, Without<Frozen>)>,
mut errors: EventWriter<GameError>,
mut player: Option<Single<&mut BufferedDirection, (With<PlayerControlled>, Without<Frozen>)>>,
) {
// Handle events
for event in events.read() {
if let GameEvent::Command(command) = event {
let GameEvent::Command(command) = event;
match command {
GameCommand::MovePlayer(direction) => {
// Get the player's movable component (ensuring there is only one player)
let mut buffered_direction = match players.single_mut() {
Ok(tuple) => tuple,
Err(e) => {
errors.write(GameError::InvalidState(format!(
"No/multiple entities queried for player system: {}",
e
)));
return;
}
};
*buffered_direction = BufferedDirection::Some {
// Only handle movement if there's an unfrozen player
if let Some(player_single) = player.as_mut() {
trace!(direction = ?*direction, "Player direction buffered for movement");
***player_single = BufferedDirection::Some {
direction: *direction,
remaining_time: 0.25,
};
}
}
GameCommand::Exit => {
state.exit = true;
}
@@ -71,7 +69,6 @@ pub fn player_control_system(
}
}
}
}
/// Executes frame-by-frame movement for Pac-Man.
///
@@ -86,6 +83,7 @@ pub fn player_movement_system(
(&MovementModifiers, &mut Position, &mut Velocity, &mut BufferedDirection),
(With<PlayerControlled>, Without<Frozen>),
>,
mut last_stopped_node: bevy_ecs::system::Local<Option<crate::systems::movement::NodeId>>,
) {
for (modifiers, mut position, mut velocity, mut buffered_direction) in entities.iter_mut() {
// Decrement the buffered direction remaining time
@@ -95,16 +93,17 @@ pub fn player_movement_system(
} = *buffered_direction
{
if remaining_time <= 0.0 {
trace!("Buffered direction expired");
*buffered_direction = BufferedDirection::None;
} else {
*buffered_direction = BufferedDirection::Some {
direction,
remaining_time: remaining_time - delta_time.0,
remaining_time: remaining_time - delta_time.seconds,
};
}
}
let mut distance = velocity.speed * modifiers.speed_multiplier * 60.0 * delta_time.0;
let mut distance = velocity.speed * modifiers.speed_multiplier * 60.0 * delta_time.seconds;
loop {
match *position {
@@ -115,6 +114,8 @@ pub fn player_movement_system(
if let Some(edge) = map.graph.find_edge_in_direction(position.current_node(), direction) {
// If there is an edge in that direction (and it's traversable), start moving towards it and consume the buffered direction.
if can_traverse(EntityType::Player, edge) {
trace!(from = position.current_node(), to = edge.target, direction = ?direction, "Player started moving using buffered direction");
*last_stopped_node = None; // Reset stopped state when starting to move
velocity.direction = edge.direction;
*position = Position::Moving {
from: position.current_node(),
@@ -129,6 +130,8 @@ pub fn player_movement_system(
// If there is no buffered direction (or it's not yet valid), continue in the current direction.
if let Some(edge) = map.graph.find_edge_in_direction(position.current_node(), velocity.direction) {
if can_traverse(EntityType::Player, edge) {
trace!(from = position.current_node(), to = edge.target, direction = ?velocity.direction, "Player continued in current direction");
*last_stopped_node = None; // Reset stopped state when starting to move
velocity.direction = edge.direction;
*position = Position::Moving {
from: position.current_node(),
@@ -138,6 +141,11 @@ pub fn player_movement_system(
}
} else {
// No edge in our current direction either, erase the buffered direction and stop.
let current_node = position.current_node();
if *last_stopped_node != Some(current_node) {
trace!(node = current_node, direction = ?velocity.direction, "Player stopped - no valid edge in current direction");
*last_stopped_node = Some(current_node);
}
*buffered_direction = BufferedDirection::None;
break;
}
@@ -155,14 +163,23 @@ pub fn player_movement_system(
}
/// Applies tunnel slowdown based on the current node tile
pub fn player_tunnel_slowdown_system(map: Res<Map>, mut q: Query<(&Position, &mut MovementModifiers), With<PlayerControlled>>) {
if let Ok((position, mut modifiers)) = q.single_mut() {
pub fn player_tunnel_slowdown_system(map: Res<Map>, player: Single<(&Position, &mut MovementModifiers), With<PlayerControlled>>) {
let (position, mut modifiers) = player.into_inner();
let node = position.current_node();
let in_tunnel = map
.tile_at_node(node)
.map(|t| t == crate::constants::MapTile::Tunnel)
.unwrap_or(false);
if modifiers.tunnel_slowdown_active != in_tunnel {
trace!(
node,
in_tunnel,
speed_multiplier = if in_tunnel { 0.6 } else { 1.0 },
"Player tunnel slowdown state changed"
);
}
modifiers.tunnel_slowdown_active = in_tunnel;
modifiers.speed_multiplier = if in_tunnel { 0.6 } else { 1.0 };
}
}

View File

@@ -1,11 +1,11 @@
use bevy_ecs::system::IntoSystem;
use bevy_ecs::{resource::Resource, system::System};
use circular_buffer::CircularBuffer;
use micromap::Map;
use num_width::NumberWidth;
use parking_lot::Mutex;
use smallvec::SmallVec;
use std::fmt::Display;
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;
use strum::{EnumCount, IntoEnumIterator};
use strum_macros::{EnumCount, EnumIter, IntoStaticStr};
@@ -16,8 +16,132 @@ const MAX_SYSTEMS: usize = SystemId::COUNT;
/// The number of durations to keep in the circular buffer.
const TIMING_WINDOW_SIZE: usize = 30;
/// A timing buffer that tracks durations and automatically inserts zero durations for skipped ticks.
#[derive(Debug, Default)]
pub struct TimingBuffer {
/// Circular buffer storing timing durations
buffer: CircularBuffer<TIMING_WINDOW_SIZE, Duration>,
/// The last tick when this buffer was updated
last_tick: u64,
}
impl TimingBuffer {
/// Adds a timing duration for the current tick.
///
/// # Panics
///
/// Panics if `current_tick` is less than `last_tick`, indicating time went backwards.
pub fn add_timing(&mut self, duration: Duration, current_tick: u64) {
if current_tick < self.last_tick {
panic!(
"Time went backwards: current_tick ({}) < last_tick ({})",
current_tick, self.last_tick
);
}
// Insert zero durations for any skipped ticks (but not the current tick)
if current_tick > self.last_tick {
let skipped_ticks = current_tick - self.last_tick - 1;
for _ in 0..skipped_ticks {
self.buffer.push_back(Duration::ZERO);
}
}
// Add the actual timing
self.buffer.push_back(duration);
self.last_tick = current_tick;
}
/// Gets the most recent timing from the buffer.
pub fn get_most_recent_timing(&self) -> Duration {
self.buffer.back().copied().unwrap_or(Duration::ZERO)
}
/// Gets statistics for this timing buffer.
///
/// # Panics
///
/// Panics if `current_tick` is less than `last_tick`, indicating time went backwards.
pub fn get_stats(&mut self, current_tick: u64) -> (Duration, Duration) {
// Insert zero durations for any skipped ticks since last update (but not the current tick)
if current_tick > self.last_tick {
let skipped_ticks = current_tick - self.last_tick - 1;
for _ in 0..skipped_ticks {
self.buffer.push_back(Duration::ZERO);
}
self.last_tick = current_tick;
}
// Calculate statistics using Welford's algorithm
let mut sample_count = 0u16;
let mut running_mean = 0.0;
let mut sum_squared_diff = 0.0;
let skip = self.last_tick.saturating_sub(current_tick);
for duration in self.buffer.iter().skip(skip as usize) {
let duration_secs = duration.as_secs_f32();
sample_count += 1;
let diff_from_mean = duration_secs - running_mean;
running_mean += diff_from_mean / sample_count as f32;
let diff_from_new_mean = duration_secs - running_mean;
sum_squared_diff += diff_from_mean * diff_from_new_mean;
}
if sample_count > 0 {
let variance = if sample_count > 1 {
sum_squared_diff / (sample_count - 1) as f32
} else {
0.0
};
(
Duration::from_secs_f32(running_mean),
Duration::from_secs_f32(variance.sqrt()),
)
} else {
(Duration::ZERO, Duration::ZERO)
}
}
}
/// A resource that tracks the current game tick using an atomic counter.
/// This ensures thread-safe access to the tick counter across systems.
#[derive(Resource, Debug)]
pub struct Timing {
/// Atomic counter for the current game tick
current_tick: AtomicU64,
}
impl Timing {
/// Creates a new Timing resource starting at tick 0
pub fn new() -> Self {
Self {
current_tick: AtomicU64::new(0),
}
}
/// Gets the current tick value
pub fn get_current_tick(&self) -> u64 {
self.current_tick.load(Ordering::Relaxed)
}
/// Increments the tick counter and returns the new value
pub fn increment_tick(&self) -> u64 {
self.current_tick.fetch_add(1, Ordering::Relaxed) + 1
}
}
impl Default for Timing {
fn default() -> Self {
Self::new()
}
}
#[derive(EnumCount, EnumIter, IntoStaticStr, Debug, PartialEq, Eq, Hash, Copy, Clone)]
pub enum SystemId {
Total,
Input,
PlayerControls,
Ghost,
@@ -38,37 +162,29 @@ pub enum SystemId {
Stage,
GhostStateAnimation,
EatenGhost,
TimeToLive,
}
impl Display for SystemId {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// Use strum_macros::IntoStaticStr to get the static string
write!(f, "{}", Into::<&'static str>::into(self).to_ascii_lowercase())
}
}
#[derive(Resource, Debug)]
pub struct SystemTimings {
/// Map of system names to a queue of durations, using a circular buffer.
///
/// Uses a RwLock to allow multiple readers for the HashMap, and a Mutex on the circular buffer for exclusive access.
/// This is probably overkill, but it's fun to play with.
///
/// Also, we use a micromap::Map as the number of systems is generally quite small.
/// Just make sure to set the capacity appropriately, or it will panic.
///
/// Pre-populated with all SystemId variants during initialization to avoid runtime allocations
/// and allow systems to have default zero timings when they don't submit data.
pub timings: Map<SystemId, Mutex<CircularBuffer<TIMING_WINDOW_SIZE, Duration>>, MAX_SYSTEMS>,
/// Statically sized map of system names to timing buffers.
pub timings: micromap::Map<SystemId, Mutex<TimingBuffer>, MAX_SYSTEMS>,
}
impl Default for SystemTimings {
fn default() -> Self {
let mut timings = Map::new();
let mut timings = micromap::Map::new();
// Pre-populate with all SystemId variants to avoid runtime allocations
// and provide default zero timings for systems that don't submit data
for id in SystemId::iter() {
timings.insert(id, Mutex::new(CircularBuffer::new()));
timings.insert(id, Mutex::new(TimingBuffer::default()));
}
Self { timings }
@@ -76,100 +192,122 @@ impl Default for SystemTimings {
}
impl SystemTimings {
pub fn add_timing(&self, id: SystemId, duration: Duration) {
pub fn add_timing(&self, id: SystemId, duration: Duration, current_tick: u64) {
// Since all SystemId variants are pre-populated, we can use a simple read lock
let queue = self
let buffer = self
.timings
.get(&id)
.expect("SystemId not found in pre-populated map - this is a bug");
queue.lock().push_back(duration);
buffer.lock().add_timing(duration, current_tick);
}
pub fn get_stats(&self) -> Map<SystemId, (Duration, Duration), MAX_SYSTEMS> {
let mut stats = Map::new();
/// Add timing for the Total system (total frame time including scheduler.run)
pub fn add_total_timing(&self, duration: Duration, current_tick: u64) {
self.add_timing(SystemId::Total, duration, current_tick);
}
pub fn get_stats(&self, current_tick: u64) -> micromap::Map<SystemId, (Duration, Duration), MAX_SYSTEMS> {
let mut stats = micromap::Map::new();
// Iterate over all SystemId variants to ensure every system has an entry
for id in SystemId::iter() {
let queue = self
let buffer = self
.timings
.get(&id)
.expect("SystemId not found in pre-populated map - this is a bug");
let queue_guard = queue.lock();
if queue_guard.is_empty() {
// Return zero timing for systems that haven't submitted any data
stats.insert(id, (Duration::ZERO, Duration::ZERO));
continue;
}
let durations: Vec<f64> = queue_guard.iter().map(|d| d.as_secs_f64() * 1000.0).collect();
let count = durations.len() as f64;
let sum: f64 = durations.iter().sum();
let mean = sum / count;
let variance = durations.iter().map(|x| (x - mean).powi(2)).sum::<f64>() / (count - 1.0).max(1.0);
let std_dev = variance.sqrt();
stats.insert(
id,
(
Duration::from_secs_f64(mean / 1000.0),
Duration::from_secs_f64(std_dev / 1000.0),
),
);
let (average, standard_deviation) = buffer.lock().get_stats(current_tick);
stats.insert(id, (average, standard_deviation));
}
stats
}
pub fn get_total_stats(&self) -> (Duration, Duration) {
let duration_sums = {
self.timings
.iter()
.map(|(_, queue)| queue.lock().iter().sum::<Duration>())
.collect::<Vec<_>>()
};
pub fn format_timing_display(&self, current_tick: u64) -> SmallVec<[String; SystemId::COUNT]> {
let stats = self.get_stats(current_tick);
let mean = duration_sums.iter().sum::<Duration>() / duration_sums.len() as u32;
let variance = duration_sums
.iter()
.map(|x| {
let diff_secs = x.as_secs_f64() - mean.as_secs_f64();
diff_secs * diff_secs
})
.sum::<f64>()
/ (duration_sums.len() - 1).max(1) as f64;
let std_dev_secs = variance.sqrt();
(mean, Duration::from_secs_f64(std_dev_secs))
}
pub fn format_timing_display(&self) -> SmallVec<[String; SystemId::COUNT]> {
let stats = self.get_stats();
let (total_avg, total_std) = self.get_total_stats();
// Get the Total system metrics instead of averaging all systems
let (total_avg, total_std) = stats
.get(&SystemId::Total)
.copied()
.unwrap_or((Duration::ZERO, Duration::ZERO));
let effective_fps = match 1.0 / total_avg.as_secs_f64() {
f if f > 100.0 => (f as u32).separate_with_commas(),
f if f > 100.0 => format!("{:>5} FPS", (f as u32).separate_with_commas()),
f if f < 10.0 => format!("{:.1} FPS", f),
f => format!("{:.0} FPS", f),
f => format!("{:5.0} FPS", f),
};
// Collect timing data for formatting
let mut timing_data = vec![(effective_fps, total_avg, total_std)];
// Sort the stats by average duration
let mut sorted_stats: Vec<_> = stats.iter().collect();
// Sort the stats by average duration, excluding the Total system
let mut sorted_stats: Vec<_> = stats.iter().filter(|(id, _)| **id != SystemId::Total).collect();
sorted_stats.sort_by(|a, b| b.1 .0.cmp(&a.1 .0));
// Add the top 5 most expensive systems
for (name, (avg, std_dev)) in sorted_stats.iter().take(7) {
// Add the top 7 most expensive systems (excluding Total)
for (name, (avg, std_dev)) in sorted_stats.iter().take(9) {
timing_data.push((name.to_string(), *avg, *std_dev));
}
// Use the formatting module to format the data
format_timing_display(timing_data)
}
/// Returns a list of systems with their timings, likely responsible for slow frame timings.
///
/// First, checks if any systems took longer than 2ms on the most recent tick.
/// If none exceed 2ms, accumulates systems until the top 30% of total timing
/// is reached, stopping at 5 systems maximum.
///
/// Returns tuples of (SystemId, Duration) in a SmallVec capped at 5 items.
pub fn get_slowest_systems(&self) -> SmallVec<[(SystemId, Duration); 5]> {
let mut system_timings: Vec<(SystemId, Duration)> = Vec::new();
let mut total_duration = Duration::ZERO;
// Collect most recent timing for each system (excluding Total)
for id in SystemId::iter() {
if id == SystemId::Total {
continue;
}
if let Some(buffer) = self.timings.get(&id) {
let recent_timing = buffer.lock().get_most_recent_timing();
system_timings.push((id, recent_timing));
total_duration += recent_timing;
}
}
// Sort by duration (highest first)
system_timings.sort_by(|a, b| b.1.cmp(&a.1));
// Check for systems over 2ms threshold
let over_threshold: SmallVec<[(SystemId, Duration); 5]> = system_timings
.iter()
.filter(|(_, duration)| duration.as_millis() >= 2)
.copied()
.collect();
if !over_threshold.is_empty() {
return over_threshold;
}
// Accumulate top systems until 30% of total is reached (max 5 systems)
let threshold = total_duration.as_nanos() as f64 * 0.3;
let mut accumulated = 0u128;
let mut result = SmallVec::new();
for (id, duration) in system_timings.iter().take(5) {
result.push((*id, *duration));
accumulated += duration.as_nanos();
if accumulated as f64 >= threshold {
break;
}
}
result
}
}
pub fn profile<S, M>(id: SystemId, system: S) -> impl FnMut(&mut bevy_ecs::world::World)
@@ -188,8 +326,9 @@ where
system.run((), world);
let duration = start.elapsed();
if let Some(timings) = world.get_resource::<SystemTimings>() {
timings.add_timing(id, duration);
if let (Some(timings), Some(timing)) = (world.get_resource::<SystemTimings>(), world.get_resource::<Timing>()) {
let current_tick = timing.get_current_tick();
timings.add_timing(id, duration, current_tick);
}
}
}

View File

@@ -1,33 +1,85 @@
use crate::constants::CANVAS_SIZE;
use crate::error::{GameError, TextureError};
use crate::map::builder::Map;
use crate::systems::input::TouchState;
use crate::systems::{
debug_render_system, BatchedLinesResource, Collider, CursorPosition, DebugState, DebugTextureResource, DeltaTime,
DirectionalAnimation, LinearAnimation, Position, Renderable, ScoreResource, StartupSequence, SystemId, SystemTimings,
TtfAtlasResource, Velocity,
debug_render_system, BatchedLinesResource, Collider, CursorPosition, DebugState, DebugTextureResource, Position, SystemId,
SystemTimings, TtfAtlasResource,
};
use crate::texture::sprite::SpriteAtlas;
use crate::texture::text::TextTexture;
use crate::texture::sprite::{AtlasTile, SpriteAtlas};
use bevy_ecs::component::Component;
use bevy_ecs::entity::Entity;
use bevy_ecs::event::EventWriter;
use bevy_ecs::query::{Changed, Or, Without};
use bevy_ecs::query::{Changed, Or, With};
use bevy_ecs::removal_detection::RemovedComponents;
use bevy_ecs::resource::Resource;
use bevy_ecs::system::{NonSendMut, Query, Res, ResMut};
use sdl2::pixels::Color;
use glam::Vec2;
use sdl2::rect::{Point, Rect};
use sdl2::render::{BlendMode, Canvas, Texture};
use sdl2::video::Window;
use std::time::Instant;
/// A component for entities that have a sprite, with a layer for ordering.
///
/// This is intended to be modified by other entities allowing animation.
#[derive(Component)]
pub struct Renderable {
pub sprite: AtlasTile,
pub layer: u8,
}
#[derive(Resource, Default)]
pub struct RenderDirty(pub bool);
#[derive(Component)]
pub struct Hidden;
/// A component that controls entity visibility in the render system.
///
/// Entities without this component are considered visible by default.
/// This allows for efficient rendering where only entities that need
/// visibility control have this component.
#[derive(Component, Debug, Clone, Copy, PartialEq, Eq)]
pub struct Visibility(pub bool);
impl Default for Visibility {
fn default() -> Self {
Self(true) // Default to visible
}
}
impl Visibility {
/// Creates a visible Visibility component
pub fn visible() -> Self {
Self(true)
}
/// Creates a hidden Visibility component
pub fn hidden() -> Self {
Self(false)
}
/// Returns true if the entity is visible
pub fn is_visible(&self) -> bool {
self.0
}
/// Returns true if the entity is hidden
#[allow(dead_code)] // Used in tests
pub fn is_hidden(&self) -> bool {
!self.0
}
/// Makes the entity visible
pub fn show(&mut self) {
self.0 = true;
}
/// Toggles the visibility state
pub fn toggle(&mut self) {
self.0 = !self.0;
}
}
/// Enum to identify which texture is being rendered to in the combined render system
#[derive(Debug, Clone, Copy)]
enum RenderTarget {
@@ -38,75 +90,18 @@ enum RenderTarget {
#[allow(clippy::type_complexity)]
pub fn dirty_render_system(
mut dirty: ResMut<RenderDirty>,
changed: Query<(), Or<(Changed<Renderable>, Changed<Position>)>>,
removed_hidden: RemovedComponents<Hidden>,
changed: Query<(), Or<(Changed<Renderable>, Changed<Position>, Changed<Visibility>)>>,
removed_renderables: RemovedComponents<Renderable>,
) {
if !changed.is_empty() || !removed_hidden.is_empty() || !removed_renderables.is_empty() {
if changed.iter().count() > 0 || !removed_renderables.is_empty() {
dirty.0 = true;
}
}
/// Updates directional animated entities with synchronized timing across directions.
///
/// This runs before the render system to update sprites based on current direction and movement state.
/// All directions share the same frame timing to ensure perfect synchronization.
pub fn directional_render_system(
dt: Res<DeltaTime>,
mut query: Query<(&Position, &Velocity, &mut DirectionalAnimation, &mut Renderable)>,
) {
let ticks = (dt.0 * 60.0).round() as u16; // Convert from seconds to ticks at 60 ticks/sec
for (position, velocity, mut anim, mut renderable) in query.iter_mut() {
let stopped = matches!(position, Position::Stopped { .. });
// Only tick animation when moving to preserve stopped frame
if !stopped {
// Tick shared animation state
anim.time_bank += ticks;
while anim.time_bank >= anim.frame_duration {
anim.time_bank -= anim.frame_duration;
anim.current_frame += 1;
}
}
// Get tiles for current direction and movement state
let tiles = if stopped {
anim.stopped_tiles.get(velocity.direction)
} else {
anim.moving_tiles.get(velocity.direction)
};
if !tiles.is_empty() {
let new_tile = tiles.get_tile(anim.current_frame);
if renderable.sprite != new_tile {
renderable.sprite = new_tile;
}
}
}
}
/// Updates linear animated entities (used for non-directional animations like frightened ghosts).
///
/// This system handles entities that use LinearAnimation component for simple frame cycling.
pub fn linear_render_system(dt: Res<DeltaTime>, mut query: Query<(&mut LinearAnimation, &mut Renderable)>) {
let ticks = (dt.0 * 60.0).round() as u16; // Convert from seconds to ticks at 60 ticks/sec
for (mut anim, mut renderable) in query.iter_mut() {
// Tick animation
anim.time_bank += ticks;
while anim.time_bank >= anim.frame_duration {
anim.time_bank -= anim.frame_duration;
anim.current_frame += 1;
}
if !anim.tiles.is_empty() {
let new_tile = anim.tiles.get_tile(anim.current_frame);
if renderable.sprite != new_tile {
renderable.sprite = new_tile;
}
}
}
/// Component for Renderables to store an exact pixel position
#[derive(Component)]
pub struct PixelPosition {
pub pixel_position: Vec2,
}
/// A non-send resource for the map texture. This just wraps the texture with a type so it can be differentiated when exposed as a resource.
@@ -115,152 +110,24 @@ pub struct MapTextureResource(pub Texture);
/// A non-send resource for the backbuffer texture. This just wraps the texture with a type so it can be differentiated when exposed as a resource.
pub struct BackbufferResource(pub Texture);
/// Renders touch UI overlay for mobile/testing.
pub fn touch_ui_render_system(
mut backbuffer: NonSendMut<BackbufferResource>,
mut canvas: NonSendMut<&mut Canvas<Window>>,
touch_state: Res<TouchState>,
mut errors: EventWriter<GameError>,
) {
if let Some(ref touch_data) = touch_state.active_touch {
let _ = canvas.with_texture_canvas(&mut backbuffer.0, |canvas| {
// Set blend mode for transparency
canvas.set_blend_mode(BlendMode::Blend);
// Draw semi-transparent circle at touch start position
canvas.set_draw_color(Color::RGBA(255, 255, 255, 100));
let center = Point::new(touch_data.start_pos.x as i32, touch_data.start_pos.y as i32);
// Draw a simple circle by drawing filled rectangles (basic approach)
let radius = 30;
for dy in -radius..=radius {
for dx in -radius..=radius {
if dx * dx + dy * dy <= radius * radius {
let point = Point::new(center.x + dx, center.y + dy);
if let Err(e) = canvas.draw_point(point) {
errors.write(TextureError::RenderFailed(format!("Touch UI render error: {}", e)).into());
return;
}
}
}
}
// Draw direction indicator if we have a direction
if let Some(direction) = touch_data.current_direction {
canvas.set_draw_color(Color::RGBA(0, 255, 0, 150));
// Draw arrow indicating direction
let arrow_length = 40;
let (dx, dy) = match direction {
crate::map::direction::Direction::Up => (0, -arrow_length),
crate::map::direction::Direction::Down => (0, arrow_length),
crate::map::direction::Direction::Left => (-arrow_length, 0),
crate::map::direction::Direction::Right => (arrow_length, 0),
};
let end_point = Point::new(center.x + dx, center.y + dy);
if let Err(e) = canvas.draw_line(center, end_point) {
errors.write(TextureError::RenderFailed(format!("Touch arrow render error: {}", e)).into());
}
// Draw arrowhead (simple approach)
let arrow_size = 8;
match direction {
crate::map::direction::Direction::Up => {
let _ = canvas.draw_line(end_point, Point::new(end_point.x - arrow_size, end_point.y + arrow_size));
let _ = canvas.draw_line(end_point, Point::new(end_point.x + arrow_size, end_point.y + arrow_size));
}
crate::map::direction::Direction::Down => {
let _ = canvas.draw_line(end_point, Point::new(end_point.x - arrow_size, end_point.y - arrow_size));
let _ = canvas.draw_line(end_point, Point::new(end_point.x + arrow_size, end_point.y - arrow_size));
}
crate::map::direction::Direction::Left => {
let _ = canvas.draw_line(end_point, Point::new(end_point.x + arrow_size, end_point.y - arrow_size));
let _ = canvas.draw_line(end_point, Point::new(end_point.x + arrow_size, end_point.y + arrow_size));
}
crate::map::direction::Direction::Right => {
let _ = canvas.draw_line(end_point, Point::new(end_point.x - arrow_size, end_point.y - arrow_size));
let _ = canvas.draw_line(end_point, Point::new(end_point.x - arrow_size, end_point.y + arrow_size));
}
}
}
});
}
}
/// Renders the HUD (score, lives, etc.) on top of the game.
pub fn hud_render_system(
mut backbuffer: NonSendMut<BackbufferResource>,
mut canvas: NonSendMut<&mut Canvas<Window>>,
mut atlas: NonSendMut<SpriteAtlas>,
score: Res<ScoreResource>,
startup: Res<StartupSequence>,
mut errors: EventWriter<GameError>,
) {
let _ = canvas.with_texture_canvas(&mut backbuffer.0, |canvas| {
let mut text_renderer = TextTexture::new(1.0);
// Render lives and high score text in white
let lives = 3; // TODO: Get from actual lives resource
let lives_text = format!("{lives}UP HIGH SCORE ");
let lives_position = glam::UVec2::new(4 + 8 * 3, 2); // x_offset + lives_offset * 8, y_offset
if let Err(e) = text_renderer.render(canvas, &mut atlas, &lives_text, lives_position) {
errors.write(TextureError::RenderFailed(format!("Failed to render lives text: {}", e)).into());
}
// Render score text
let score_text = format!("{:02}", score.0);
let score_offset = 7 - (score_text.len() as i32);
let score_position = glam::UVec2::new(4 + 8 * score_offset as u32, 10); // x_offset + score_offset * 8, 8 + y_offset
if let Err(e) = text_renderer.render(canvas, &mut atlas, &score_text, score_position) {
errors.write(TextureError::RenderFailed(format!("Failed to render score text: {}", e)).into());
}
// Render high score text
let high_score_text = format!("{:02}", score.0);
let high_score_offset = 17 - (high_score_text.len() as i32);
let high_score_position = glam::UVec2::new(4 + 8 * high_score_offset as u32, 10); // x_offset + score_offset * 8, 8 + y_offset
if let Err(e) = text_renderer.render(canvas, &mut atlas, &high_score_text, high_score_position) {
errors.write(TextureError::RenderFailed(format!("Failed to render high score text: {}", e)).into());
}
// Render text based on StartupSequence stage
if matches!(
*startup,
StartupSequence::TextOnly { .. } | StartupSequence::CharactersVisible { .. }
) {
let ready_text = "READY!";
let ready_width = text_renderer.text_width(ready_text);
let ready_position = glam::UVec2::new((CANVAS_SIZE.x - ready_width) / 2, 160);
if let Err(e) = text_renderer.render_with_color(canvas, &mut atlas, ready_text, ready_position, Color::YELLOW) {
errors.write(TextureError::RenderFailed(format!("Failed to render READY text: {}", e)).into());
}
if matches!(*startup, StartupSequence::TextOnly { .. }) {
let player_one_text = "PLAYER ONE";
let player_one_width = text_renderer.text_width(player_one_text);
let player_one_position = glam::UVec2::new((CANVAS_SIZE.x - player_one_width) / 2, 113);
if let Err(e) =
text_renderer.render_with_color(canvas, &mut atlas, player_one_text, player_one_position, Color::CYAN)
{
errors.write(TextureError::RenderFailed(format!("Failed to render PLAYER ONE text: {}", e)).into());
}
}
}
});
}
#[allow(clippy::too_many_arguments)]
#[allow(clippy::type_complexity)]
pub fn render_system(
canvas: &mut Canvas<Window>,
map_texture: &NonSendMut<MapTextureResource>,
atlas: &mut SpriteAtlas,
map: &Res<Map>,
dirty: &Res<RenderDirty>,
renderables: &Query<(Entity, &Renderable, &Position), Without<Hidden>>,
renderables: &Query<
(
Entity,
&Renderable,
Option<&Position>,
Option<&PixelPosition>,
Option<&Visibility>,
),
Or<(With<Position>, With<PixelPosition>)>,
>,
errors: &mut EventWriter<GameError>,
) {
if !dirty.0 {
@@ -276,13 +143,25 @@ pub fn render_system(
errors.write(TextureError::RenderFailed(e.to_string()).into());
}
// Render all entities to the backbuffer
for (_, renderable, position) in renderables
// Collect and filter visible entities, then sort by layer
let mut visible_entities: Vec<_> = renderables
.iter()
.sort_by_key::<(Entity, &Renderable, &Position), _>(|(_, renderable, _)| renderable.layer)
.rev()
{
let pos = position.get_pixel_position(&map.graph);
.filter(|(_, _, _, _, visibility)| visibility.copied().unwrap_or_default().is_visible())
.collect();
visible_entities.sort_by_key(|(_, renderable, _, _, _)| renderable.layer);
visible_entities.reverse();
// Render all visible entities to the backbuffer
for (_entity, renderable, position, pixel_position, _visibility) in visible_entities {
let pos = if let Some(position) = position {
position.get_pixel_position(&map.graph)
} else {
Ok(pixel_position
.expect("Pixel position should be present via query filtering, but got None on both")
.pixel_position)
};
match pos {
Ok(pos) => {
let dest = Rect::from_center(
@@ -307,6 +186,7 @@ pub fn render_system(
/// Combined render system that renders to both backbuffer and debug textures in a single
/// with_multiple_texture_canvas call for reduced overhead
#[allow(clippy::too_many_arguments)]
#[allow(clippy::type_complexity)]
pub fn combined_render_system(
mut canvas: NonSendMut<&mut Canvas<Window>>,
map_texture: NonSendMut<MapTextureResource>,
@@ -317,9 +197,19 @@ pub fn combined_render_system(
batched_lines: Res<BatchedLinesResource>,
debug_state: Res<DebugState>,
timings: Res<SystemTimings>,
timing: Res<crate::systems::profiling::Timing>,
map: Res<Map>,
dirty: Res<RenderDirty>,
renderables: Query<(Entity, &Renderable, &Position), Without<Hidden>>,
renderables: Query<
(
Entity,
&Renderable,
Option<&Position>,
Option<&PixelPosition>,
Option<&Visibility>,
),
Or<(With<Position>, With<PixelPosition>)>,
>,
colliders: Query<(&Collider, &Position)>,
cursor: Res<CursorPosition>,
mut errors: EventWriter<GameError>,
@@ -367,6 +257,7 @@ pub fn combined_render_system(
&batched_lines,
&debug_state,
&timings,
&timing,
&map,
&colliders,
&cursor,
@@ -381,11 +272,13 @@ pub fn combined_render_system(
}
// Record timings for each system independently
let current_tick = timing.get_current_tick();
if let Some(duration) = render_duration {
timings.add_timing(SystemId::Render, duration);
timings.add_timing(SystemId::Render, duration, current_tick);
}
if let Some(duration) = debug_render_duration {
timings.add_timing(SystemId::DebugRender, duration);
timings.add_timing(SystemId::DebugRender, duration, current_tick);
}
}

View File

@@ -1,101 +0,0 @@
use bevy_ecs::{
entity::Entity,
query::With,
resource::Resource,
system::{Commands, Query, ResMut},
};
use tracing::debug;
use crate::systems::{Blinking, Frozen, GhostCollider, Hidden, PlayerControlled};
#[derive(Resource, Debug, Clone, Copy)]
pub enum StartupSequence {
/// Stage 1: Text-only stage
/// - Player & ghosts are hidden
/// - READY! and PLAYER ONE text are shown
/// - Energizers do not blink
TextOnly {
/// Remaining ticks in this stage
remaining_ticks: u32,
},
/// Stage 2: Characters visible stage
/// - PLAYER ONE text is hidden, READY! text remains
/// - Ghosts and Pac-Man are now shown
CharactersVisible {
/// Remaining ticks in this stage
remaining_ticks: u32,
},
/// Stage 3: Game begins
/// - Final state, game is fully active
GameActive,
}
impl StartupSequence {
/// Creates a new StartupSequence with the specified duration in ticks
pub fn new(text_only_ticks: u32, _characters_visible_ticks: u32) -> Self {
Self::TextOnly {
remaining_ticks: text_only_ticks,
}
}
/// Ticks the timer by one frame, returning transition information if state changes
pub fn tick(&mut self) -> Option<(StartupSequence, StartupSequence)> {
match self {
StartupSequence::TextOnly { remaining_ticks } => {
if *remaining_ticks > 0 {
*remaining_ticks -= 1;
None
} else {
let from = *self;
*self = StartupSequence::CharactersVisible {
remaining_ticks: 60, // 1 second at 60 FPS
};
Some((from, *self))
}
}
StartupSequence::CharactersVisible { remaining_ticks } => {
if *remaining_ticks > 0 {
*remaining_ticks -= 1;
None
} else {
let from = *self;
*self = StartupSequence::GameActive;
Some((from, *self))
}
}
StartupSequence::GameActive => None,
}
}
}
/// Handles startup sequence transitions and component management
pub fn startup_stage_system(
mut startup: ResMut<StartupSequence>,
mut commands: Commands,
mut blinking_query: Query<Entity, With<Blinking>>,
mut player_query: Query<Entity, With<PlayerControlled>>,
mut ghost_query: Query<Entity, With<GhostCollider>>,
) {
if let Some((from, to)) = startup.tick() {
debug!("StartupSequence transition from {from:?} to {to:?}");
match (from, to) {
(StartupSequence::TextOnly { .. }, StartupSequence::CharactersVisible { .. }) => {
// Unhide the player & ghosts
for entity in player_query.iter_mut().chain(ghost_query.iter_mut()) {
commands.entity(entity).remove::<Hidden>();
}
}
(StartupSequence::CharactersVisible { .. }, StartupSequence::GameActive) => {
// Unfreeze the player & ghosts & pellet blinking
for entity in player_query
.iter_mut()
.chain(ghost_query.iter_mut())
.chain(blinking_query.iter_mut())
{
commands.entity(entity).remove::<Frozen>();
}
}
_ => {}
}
}
}

449
src/systems/state.rs Normal file
View File

@@ -0,0 +1,449 @@
use std::mem::discriminant;
use tracing::{debug, info};
use crate::constants;
use crate::events::StageTransition;
use crate::map::direction::Direction;
use crate::systems::{EntityType, ItemCollider, SpawnTrigger, Velocity};
use crate::{
map::builder::Map,
systems::{
AudioEvent, Blinking, DirectionalAnimation, Dying, Frozen, Ghost, GhostCollider, GhostState, LinearAnimation, Looping,
NodeId, PlayerControlled, Position, Visibility,
},
};
use bevy_ecs::{
entity::Entity,
event::{EventReader, EventWriter},
query::{With, Without},
resource::Resource,
system::{Commands, Query, Res, ResMut, Single},
};
use crate::events::{GameCommand, GameEvent};
#[derive(Resource, Clone)]
pub struct PlayerAnimation(pub DirectionalAnimation);
#[derive(Resource, Clone)]
pub struct PlayerDeathAnimation(pub LinearAnimation);
/// Tracks whether the beginning sound has been played for the current startup sequence
#[derive(Resource, Debug, Default, Clone, Copy)]
pub struct IntroPlayed(pub bool);
/// A resource to track the overall stage of the game from a high-level perspective.
#[derive(Resource, Debug, PartialEq, Eq, Clone, Copy)]
pub enum GameStage {
Starting(StartupSequence),
/// The main gameplay loop is active.
Playing,
/// Short freeze after Pac-Man eats a ghost to display bonus score
GhostEatenPause {
remaining_ticks: u32,
ghost_entity: Entity,
ghost_type: Ghost,
node: NodeId,
},
/// The player has died and the death sequence is in progress. At the end, the player will return to the startup sequence or game over.
PlayerDying(DyingSequence),
/// The game has ended.
GameOver,
}
#[derive(Resource, Debug, Default)]
pub struct Paused(pub bool);
pub fn handle_pause_command(
mut events: EventReader<GameEvent>,
mut paused: ResMut<Paused>,
mut audio_events: EventWriter<AudioEvent>,
) {
for event in events.read() {
if let GameEvent::Command(GameCommand::TogglePause) = event {
paused.0 = !paused.0;
if paused.0 {
info!("Game paused");
audio_events.write(AudioEvent::Pause);
} else {
info!("Game resumed");
audio_events.write(AudioEvent::Resume);
}
}
}
}
pub trait TooSimilar {
fn too_similar(&self, other: &Self) -> bool;
}
impl TooSimilar for GameStage {
fn too_similar(&self, other: &Self) -> bool {
discriminant(self) == discriminant(other) && {
// These states are very simple, so they're 'too similar' automatically
if matches!(self, GameStage::Playing | GameStage::GameOver) {
return true;
}
// Since the discriminant is the same but the values are different, it's the interior value that is somehow different
match (self, other) {
// These states are similar if their interior values are similar as well
(GameStage::Starting(startup), GameStage::Starting(other)) => startup.too_similar(other),
(GameStage::PlayerDying(dying), GameStage::PlayerDying(other)) => dying.too_similar(other),
(
GameStage::GhostEatenPause {
ghost_entity,
ghost_type,
node,
..
},
GameStage::GhostEatenPause {
ghost_entity: other_ghost_entity,
ghost_type: other_ghost_type,
node: other_node,
..
},
) => ghost_entity == other_ghost_entity && ghost_type == other_ghost_type && node == other_node,
// Already handled, but kept to properly exhaust the match
(GameStage::Playing, _) | (GameStage::GameOver, _) => unreachable!(),
_ => unreachable!(),
}
}
}
}
/// A resource that manages the multi-stage startup sequence of the game.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum StartupSequence {
/// Stage 1: Text-only stage
/// - Player & ghosts are hidden
/// - READY! and PLAYER ONE text are shown
/// - Energizers do not blink
TextOnly {
/// Remaining ticks in this stage
remaining_ticks: u32,
},
/// Stage 2: Characters visible stage
/// - PLAYER ONE text is hidden, READY! text remains
/// - Ghosts and Pac-Man are now shown
CharactersVisible {
/// Remaining ticks in this stage
remaining_ticks: u32,
},
}
impl Default for GameStage {
fn default() -> Self {
Self::Playing
}
}
impl TooSimilar for StartupSequence {
fn too_similar(&self, other: &Self) -> bool {
discriminant(self) == discriminant(other)
}
}
/// The state machine for the multi-stage death sequence.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum DyingSequence {
/// Initial stage: entities are frozen, waiting for a delay.
Frozen { remaining_ticks: u32 },
/// Second stage: Pac-Man's death animation is playing.
Animating { remaining_ticks: u32 },
/// Third stage: Pac-Man is now gone, waiting a moment before the level restarts.
Hidden { remaining_ticks: u32 },
}
impl TooSimilar for DyingSequence {
fn too_similar(&self, other: &Self) -> bool {
discriminant(self) == discriminant(other)
}
}
/// A resource to store the number of player lives.
#[derive(Resource, Debug)]
pub struct PlayerLives(pub u8);
impl Default for PlayerLives {
fn default() -> Self {
Self(3)
}
}
/// Handles startup sequence transitions and component management
#[allow(clippy::too_many_arguments)]
#[allow(clippy::type_complexity)]
pub fn stage_system(
mut game_state: ResMut<GameStage>,
player_death_animation: Res<PlayerDeathAnimation>,
player_animation: Res<PlayerAnimation>,
mut player_lives: ResMut<PlayerLives>,
map: Res<Map>,
mut commands: Commands,
mut audio_events: EventWriter<AudioEvent>,
mut stage_event_reader: EventReader<StageTransition>,
mut blinking_query: Query<Entity, With<Blinking>>,
player: Single<(Entity, &mut Position), With<PlayerControlled>>,
mut item_query: Query<(Entity, &EntityType), With<ItemCollider>>,
mut ghost_query: Query<(Entity, &Ghost, &mut Position, &mut GhostState), (With<GhostCollider>, Without<PlayerControlled>)>,
mut intro_played: ResMut<IntroPlayed>,
) {
let old_state = *game_state;
let mut new_state_opt: Option<GameStage> = None;
// Handle stage transition requests before normal ticking
for event in stage_event_reader.read() {
let StageTransition::GhostEatenPause {
ghost_entity,
ghost_type,
} = *event;
let pac_node = player.1.current_node();
debug!(ghost = ?ghost_type, node = pac_node, "Ghost eaten, entering pause state");
new_state_opt = Some(GameStage::GhostEatenPause {
remaining_ticks: 30,
ghost_entity,
ghost_type,
node: pac_node,
});
}
let new_state: GameStage = new_state_opt.unwrap_or_else(|| match *game_state {
GameStage::Playing => {
// This is the default state, do nothing
*game_state
}
GameStage::GhostEatenPause {
remaining_ticks,
ghost_entity,
ghost_type,
node,
} => {
if remaining_ticks > 0 {
GameStage::GhostEatenPause {
remaining_ticks: remaining_ticks.saturating_sub(1),
ghost_entity,
ghost_type,
node,
}
} else {
debug!("Ghost eaten pause ended, resuming gameplay");
GameStage::Playing
}
}
GameStage::Starting(sequence) => match sequence {
StartupSequence::TextOnly { remaining_ticks } => {
// Play the beginning sound once at the start of TextOnly stage
if !intro_played.0 {
audio_events.write(AudioEvent::PlaySound(crate::audio::Sound::Beginning));
intro_played.0 = true;
}
if remaining_ticks > 0 {
GameStage::Starting(StartupSequence::TextOnly {
remaining_ticks: remaining_ticks.saturating_sub(1),
})
} else {
GameStage::Starting(StartupSequence::CharactersVisible { remaining_ticks: 60 })
}
}
StartupSequence::CharactersVisible { remaining_ticks } => {
if remaining_ticks > 0 {
GameStage::Starting(StartupSequence::CharactersVisible {
remaining_ticks: remaining_ticks.saturating_sub(1),
})
} else {
info!("Startup sequence completed, beginning gameplay");
GameStage::Playing
}
}
},
GameStage::PlayerDying(sequence) => match sequence {
DyingSequence::Frozen { remaining_ticks } => {
if remaining_ticks > 0 {
GameStage::PlayerDying(DyingSequence::Frozen {
remaining_ticks: remaining_ticks.saturating_sub(1),
})
} else {
let death_animation = &player_death_animation.0;
let remaining_ticks = (death_animation.tiles.len() * death_animation.frame_duration as usize) as u32;
debug!(animation_frames = remaining_ticks, "Starting player death animation");
GameStage::PlayerDying(DyingSequence::Animating { remaining_ticks })
}
}
DyingSequence::Animating { remaining_ticks } => {
if remaining_ticks > 0 {
GameStage::PlayerDying(DyingSequence::Animating {
remaining_ticks: remaining_ticks.saturating_sub(1),
})
} else {
GameStage::PlayerDying(DyingSequence::Hidden { remaining_ticks: 60 })
}
}
DyingSequence::Hidden { remaining_ticks } => {
if remaining_ticks > 0 {
GameStage::PlayerDying(DyingSequence::Hidden {
remaining_ticks: remaining_ticks.saturating_sub(1),
})
} else {
player_lives.0 = player_lives.0.saturating_sub(1);
if player_lives.0 > 0 {
info!(remaining_lives = player_lives.0, "Player died, returning to startup sequence");
GameStage::Starting(StartupSequence::CharactersVisible { remaining_ticks: 60 })
} else {
info!("All lives lost, game over");
GameStage::GameOver
}
}
}
},
GameStage::GameOver => *game_state,
});
if old_state == new_state {
return;
}
if !old_state.too_similar(&new_state) {
debug!(old_state = ?old_state, new_state = ?new_state, "Game stage transition");
}
match (old_state, new_state) {
(GameStage::Playing, GameStage::GhostEatenPause { ghost_entity, node, .. }) => {
// Freeze the player & non-eaten ghosts
commands.entity(player.0).insert(Frozen);
commands.entity(ghost_entity).insert(Frozen);
for (entity, _, _, state) in ghost_query.iter_mut() {
// Only freeze ghosts that are not currently eaten
if *state != GhostState::Eyes {
debug!(ghost = ?entity, "Freezing ghost");
commands.entity(entity).insert(Frozen);
}
}
// Hide the player & eaten ghost
commands.entity(player.0).insert(Visibility::hidden());
commands.entity(ghost_entity).insert(Visibility::hidden());
// Spawn bonus points entity at Pac-Man's position
commands.trigger(SpawnTrigger::Bonus {
position: Position::Stopped { node },
// TODO: Doubling score value for each consecutive ghost eaten
value: 200,
ttl: 30,
});
}
(GameStage::GhostEatenPause { ghost_entity, .. }, GameStage::Playing) => {
// Unfreeze and reveal the player & all ghosts
commands.entity(player.0).remove::<Frozen>().insert(Visibility::visible());
for (entity, _, _, _) in ghost_query.iter_mut() {
commands.entity(entity).remove::<Frozen>().insert(Visibility::visible());
}
// Reveal the eaten ghost and switch it to Eyes state
commands.entity(ghost_entity).insert(GhostState::Eyes);
}
(_, GameStage::PlayerDying(DyingSequence::Frozen { .. })) => {
// Freeze the player & ghosts
commands.entity(player.0).insert(Frozen);
for (entity, _, _, _) in ghost_query.iter_mut() {
commands.entity(entity).insert(Frozen);
}
}
(GameStage::PlayerDying(DyingSequence::Frozen { .. }), GameStage::PlayerDying(DyingSequence::Animating { .. })) => {
// Hide the ghosts
for (entity, _, _, _) in ghost_query.iter_mut() {
commands.entity(entity).insert(Visibility::hidden());
}
// Start Pac-Man's death animation
commands
.entity(player.0)
.remove::<DirectionalAnimation>()
.insert((Dying, player_death_animation.0.clone()));
// Play the death sound
audio_events.write(AudioEvent::PlaySound(crate::audio::Sound::PacmanDeath));
}
(_, GameStage::PlayerDying(DyingSequence::Hidden { .. })) => {
// Pac-Man's death animation is complete, so he should be hidden just like the ghosts.
// Then, we reset them all back to their original positions and states.
// Freeze the blinking power pellets, force them to be visible (if they were hidden by blinking)
for entity in blinking_query.iter_mut() {
commands.entity(entity).insert(Frozen).insert(Visibility::visible());
}
// Delete any fruit entities
for (entity, _) in item_query
.iter_mut()
.filter(|(_, entity_type)| matches!(entity_type, EntityType::Fruit(_)))
{
commands.entity(entity).despawn();
}
// Reset the player animation
commands
.entity(player.0)
.remove::<(Dying, LinearAnimation, Looping)>()
.insert((
Velocity {
speed: constants::mechanics::PLAYER_SPEED,
direction: Direction::Left,
},
Position::Stopped {
node: map.start_positions.pacman,
},
player_animation.0.clone(),
Visibility::hidden(),
Frozen,
));
// Reset ghost positions and state
for (ghost_entity, ghost, _, _) in ghost_query.iter_mut() {
commands.entity(ghost_entity).insert((
GhostState::Normal,
Position::Stopped {
node: match ghost {
Ghost::Blinky => map.start_positions.blinky,
Ghost::Pinky => map.start_positions.pinky,
Ghost::Inky => map.start_positions.inky,
Ghost::Clyde => map.start_positions.clyde,
},
},
Frozen,
Visibility::hidden(),
));
}
}
(_, GameStage::Starting(StartupSequence::CharactersVisible { .. })) => {
// Unhide the player & ghosts
commands.entity(player.0).insert(Visibility::visible());
for (entity, _, _, _) in ghost_query.iter_mut() {
commands.entity(entity).insert(Visibility::visible());
}
}
(GameStage::Starting(StartupSequence::CharactersVisible { .. }), GameStage::Playing) => {
// Unfreeze the player & ghosts & blinking
commands.entity(player.0).remove::<Frozen>();
for (entity, _, _, _) in ghost_query.iter_mut() {
commands.entity(entity).remove::<Frozen>();
}
for entity in blinking_query.iter_mut() {
commands.entity(entity).remove::<Frozen>();
}
// Reset intro flag for the next round
intro_played.0 = false;
}
(_, GameStage::GameOver) => {
// Freeze blinking
for entity in blinking_query.iter_mut() {
commands.entity(entity).insert(Frozen);
}
}
_ => {}
}
*game_state = new_state;
}

View File

@@ -1,53 +1,45 @@
use crate::map::direction::Direction;
use crate::texture::sprite::AtlasTile;
use glam::U16Vec2;
/// Fixed-size tile sequence that avoids heap allocation
#[derive(Clone, Copy, Debug)]
use crate::{map::direction::Direction, texture::sprite::AtlasTile};
/// A sequence of tiles for animation, backed by a vector.
#[derive(Debug, Clone)]
pub struct TileSequence {
tiles: [AtlasTile; 4], // Fixed array, max 4 frames
count: usize, // Actual number of frames used
tiles: Vec<AtlasTile>,
}
impl TileSequence {
/// Creates a new tile sequence from a slice of tiles
/// Creates a new tile sequence from a slice of tiles.
pub fn new(tiles: &[AtlasTile]) -> Self {
let mut tile_array = [AtlasTile {
pos: glam::U16Vec2::ZERO,
size: glam::U16Vec2::ZERO,
color: None,
}; 4];
let count = tiles.len().min(4);
tile_array[..count].copy_from_slice(&tiles[..count]);
Self {
tiles: tile_array,
count,
}
Self { tiles: tiles.to_vec() }
}
/// Returns the tile at the given frame index, wrapping if necessary
pub fn get_tile(&self, frame: usize) -> AtlasTile {
if self.count == 0 {
// Return a default empty tile if no tiles
AtlasTile {
pos: glam::U16Vec2::ZERO,
size: glam::U16Vec2::ZERO,
if self.tiles.is_empty() {
// Return a default or handle the error appropriately
// For now, let's return a default tile, assuming it's a sensible default
return AtlasTile {
pos: U16Vec2::ZERO,
size: U16Vec2::ZERO,
color: None,
};
}
} else {
self.tiles[frame % self.count]
}
self.tiles[frame % self.tiles.len()]
}
/// Returns true if this sequence has no tiles
pub fn len(&self) -> usize {
self.tiles.len()
}
/// Checks if the sequence contains any tiles.
pub fn is_empty(&self) -> bool {
self.count == 0
self.tiles.is_empty()
}
}
/// Type-safe directional tile storage with named fields
#[derive(Clone, Copy, Debug)]
/// A collection of tile sequences for each cardinal direction.
#[derive(Debug, Clone)]
pub struct DirectionalTiles {
pub up: TileSequence,
pub down: TileSequence,

View File

@@ -1,46 +0,0 @@
#![allow(dead_code)]
use crate::texture::sprite::AtlasTile;
#[derive(Clone)]
pub struct BlinkingTexture {
tile: AtlasTile,
blink_duration: f32,
time_bank: f32,
is_on: bool,
}
impl BlinkingTexture {
pub fn new(tile: AtlasTile, blink_duration: f32) -> Self {
Self {
tile,
blink_duration,
time_bank: 0.0,
is_on: true,
}
}
pub fn tick(&mut self, dt: f32) {
self.time_bank += dt;
if self.time_bank >= self.blink_duration {
self.time_bank -= self.blink_duration;
self.is_on = !self.is_on;
}
}
pub fn is_on(&self) -> bool {
self.is_on
}
pub fn tile(&self) -> &AtlasTile {
&self.tile
}
// Helper methods for testing
pub fn time_bank(&self) -> f32 {
self.time_bank
}
pub fn blink_duration(&self) -> f32 {
self.blink_duration
}
}

View File

@@ -1,5 +1,5 @@
pub mod animated;
pub mod blinking;
pub mod sprite;
pub mod sprites;
pub mod text;
pub mod ttf;

View File

@@ -4,6 +4,7 @@ use sdl2::pixels::Color;
use sdl2::rect::Rect;
use sdl2::render::{Canvas, RenderTarget, Texture};
use std::collections::HashMap;
use tracing::debug;
use crate::error::TextureError;
@@ -20,7 +21,8 @@ pub struct MapperFrame {
pub size: U16Vec2,
}
#[derive(Copy, Clone, Debug, PartialEq)]
/// A single tile within a sprite atlas, defined by its position and size.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub struct AtlasTile {
pub pos: U16Vec2,
pub size: U16Vec2,
@@ -56,19 +58,6 @@ impl AtlasTile {
canvas.copy(&atlas.texture, src, dest).map_err(TextureError::RenderFailed)?;
Ok(())
}
/// Creates a new atlas tile.
#[allow(dead_code)]
pub fn new(pos: U16Vec2, size: U16Vec2, color: Option<Color>) -> Self {
Self { pos, size, color }
}
/// Sets the color of the tile.
#[allow(dead_code)]
pub fn with_color(mut self, color: Color) -> Self {
self.color = Some(color);
self
}
}
/// High-performance sprite atlas providing fast texture region lookups and rendering.
@@ -89,9 +78,13 @@ pub struct SpriteAtlas {
impl SpriteAtlas {
pub fn new(texture: Texture, mapper: AtlasMapper) -> Self {
let tile_count = mapper.frames.len();
let tiles = mapper.frames.into_iter().collect();
debug!(tile_count, "Created sprite atlas");
Self {
texture,
tiles: mapper.frames,
tiles,
default_color: None,
last_modulation: None,
}
@@ -103,39 +96,15 @@ impl SpriteAtlas {
/// for the named sprite, or `None` if the sprite name is not found in the
/// atlas. The returned tile can be used for immediate rendering or stored
/// for repeated use in animations and entity sprites.
pub fn get_tile(&self, name: &str) -> Option<AtlasTile> {
self.tiles.get(name).map(|frame| AtlasTile {
pub fn get_tile(&self, name: &str) -> Result<AtlasTile, TextureError> {
let frame = self.tiles.get(name).ok_or_else(|| {
debug!(tile_name = name, "Atlas tile not found");
TextureError::AtlasTileNotFound(name.to_string())
})?;
Ok(AtlasTile {
pos: frame.pos,
size: frame.size,
color: None,
color: self.default_color,
})
}
#[allow(dead_code)]
pub fn set_color(&mut self, color: Color) {
self.default_color = Some(color);
}
#[allow(dead_code)]
pub fn texture(&self) -> &Texture {
&self.texture
}
/// Returns the number of tiles in the atlas.
#[allow(dead_code)]
pub fn tiles_count(&self) -> usize {
self.tiles.len()
}
/// Returns true if the atlas has a tile with the given name.
#[allow(dead_code)]
pub fn has_tile(&self, name: &str) -> bool {
self.tiles.contains_key(name)
}
/// Returns the default color of the atlas.
#[allow(dead_code)]
pub fn default_color(&self) -> Option<Color> {
self.default_color
}
}

133
src/texture/sprites.rs Normal file
View File

@@ -0,0 +1,133 @@
//! A structured representation of all sprite assets in the game.
//!
//! This module provides a set of enums to represent every sprite, allowing for
//! type-safe access to asset paths and avoiding the use of raw strings.
//! The `GameSprite` enum is the main entry point, and its `to_path` method
//! generates the correct path for a given sprite in the texture atlas.
use crate::{
map::direction::Direction,
systems::{FruitType, Ghost},
};
/// Represents the different sprites for Pac-Man.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum PacmanSprite {
/// A moving Pac-Man sprite for a given direction and animation frame.
Moving(Direction, u8),
/// The full, closed-mouth Pac-Man sprite.
Full,
/// A single frame of the dying animation.
Dying(u8),
}
/// Represents the color of a frightened ghost.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum FrightenedColor {
Blue,
White,
}
/// Represents the different sprites for ghosts.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum GhostSprite {
/// The normal appearance of a ghost for a given type, direction, and animation frame.
Normal(Ghost, Direction, u8),
/// The frightened appearance of a ghost, with a specific color and animation frame.
Frightened(FrightenedColor, u8),
/// The "eyes only" appearance of a ghost after being eaten.
Eyes(Direction),
}
/// Represents the different sprites for the maze and collectibles.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum MazeSprite {
/// A specific tile of the maze.
Tile(u8),
/// A standard pellet.
Pellet,
/// An energizer/power pellet.
Energizer,
}
/// Represents the different effect sprites that can appear as bonus items.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum EffectSprite {
Bonus(u32),
}
/// A top-level enum that encompasses all game sprites.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum GameSprite {
Pacman(PacmanSprite),
Ghost(GhostSprite),
Maze(MazeSprite),
Fruit(FruitType),
Effect(EffectSprite),
}
impl GameSprite {
/// Generates the asset path for the sprite.
///
/// This path corresponds to the filename in the texture atlas JSON file.
pub fn to_path(self) -> String {
match self {
GameSprite::Pacman(PacmanSprite::Moving(dir, frame)) => format!(
"pacman/{}_{}.png",
dir.as_ref(),
match frame {
0 => "a",
1 => "b",
_ => panic!("Invalid animation frame"),
}
),
GameSprite::Pacman(PacmanSprite::Full) => "pacman/full.png".to_string(),
GameSprite::Pacman(PacmanSprite::Dying(frame)) => format!("pacman/death/{}.png", frame),
// Ghost sprites
GameSprite::Ghost(GhostSprite::Normal(ghost_type, dir, frame)) => {
let frame_char = match frame {
0 => 'a',
1 => 'b',
_ => panic!("Invalid animation frame"),
};
format!(
"ghost/{}/{}_{}.png",
ghost_type.as_str(),
dir.as_ref().to_lowercase(),
frame_char
)
}
GameSprite::Ghost(GhostSprite::Frightened(color, frame)) => {
let frame_char = match frame {
0 => 'a',
1 => 'b',
_ => panic!("Invalid animation frame"),
};
let color_str = match color {
FrightenedColor::Blue => "blue",
FrightenedColor::White => "white",
};
format!("ghost/frightened/{}_{}.png", color_str, frame_char)
}
GameSprite::Ghost(GhostSprite::Eyes(dir)) => format!("ghost/eyes/{}.png", dir.as_ref().to_lowercase()),
// Maze sprites
GameSprite::Maze(MazeSprite::Tile(index)) => format!("maze/tiles/{}.png", index),
GameSprite::Maze(MazeSprite::Pellet) => "maze/pellet.png".to_string(),
GameSprite::Maze(MazeSprite::Energizer) => "maze/energizer.png".to_string(),
// Fruit sprites
GameSprite::Fruit(fruit) => format!("edible/{}.png", Into::<&'static str>::into(fruit)),
// Effect sprites
GameSprite::Effect(EffectSprite::Bonus(value)) => match value {
100 | 200 | 300 | 400 | 700 | 800 | 1000 | 2000 | 3000 | 5000 => format!("effects/{}.png", value),
_ => {
tracing::warn!("Invalid bonus value: {}", value);
"effects/100.png".to_string()
}
},
}
}
}

View File

@@ -1,5 +1,3 @@
#![allow(dead_code)]
//! This module provides text rendering using the texture atlas.
//!
//! The TextTexture system renders text from the atlas using character mapping.
@@ -60,10 +58,7 @@ use sdl2::pixels::Color;
use sdl2::render::{Canvas, RenderTarget};
use std::collections::HashMap;
use crate::{
error::{GameError, TextureError},
texture::sprite::{AtlasTile, SpriteAtlas},
};
use crate::texture::sprite::{AtlasTile, SpriteAtlas};
/// Converts a character to its tile name in the atlas.
fn char_to_tile_name(c: char) -> Option<String> {
@@ -112,6 +107,7 @@ impl TextTexture {
}
}
#[allow(dead_code)]
pub fn get_char_map(&self) -> &HashMap<char, AtlasTile> {
&self.char_map
}
@@ -122,9 +118,7 @@ impl TextTexture {
}
if let Some(tile_name) = char_to_tile_name(c) {
let tile = atlas
.get_tile(&tile_name)
.ok_or(GameError::Texture(TextureError::AtlasTileNotFound(tile_name)))?;
let tile = atlas.get_tile(&tile_name)?;
self.char_map.insert(c, tile);
Ok(self.char_map.get(&c))
} else {
@@ -172,26 +166,6 @@ impl TextTexture {
Ok(())
}
/// Sets the default color for text rendering.
pub fn set_color(&mut self, color: Color) {
self.default_color = Some(color);
}
/// Gets the current default color.
pub fn color(&self) -> Option<Color> {
self.default_color
}
/// Sets the scale for text rendering.
pub fn set_scale(&mut self, scale: f32) {
self.scale = scale;
}
/// Gets the current scale.
pub fn scale(&self) -> f32 {
self.scale
}
/// Calculates the width of a string in pixels at the current scale.
pub fn text_width(&self, text: &str) -> u32 {
let char_width = (8.0 * self.scale) as u32;

View File

@@ -31,6 +31,8 @@ pub struct TtfAtlas {
char_tiles: HashMap<char, TtfCharTile>,
/// Cached color modulation state to avoid redundant SDL2 calls
last_modulation: Option<Color>,
/// Cached maximum character height
max_char_height: u32,
}
const TTF_CHARS: &str = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz.,:-/()ms μµ%± ";
@@ -101,6 +103,7 @@ impl TtfAtlas {
texture: atlas_texture,
char_tiles,
last_modulation: None,
max_char_height: max_height,
})
}
@@ -261,12 +264,6 @@ impl TtfRenderer {
/// Calculate the height of text in pixels
pub fn text_height(&self, atlas: &TtfAtlas) -> u32 {
// Find the maximum height among all characters
atlas
.char_tiles
.values()
.map(|tile| tile.size.y)
.max()
.unwrap_or(0)
.saturating_mul(self.scale as u32)
(atlas.max_char_height as f32 * self.scale) as u32
}
}

16
tests/asset.rs Normal file
View File

@@ -0,0 +1,16 @@
use pacman::asset::Asset;
use speculoos::prelude::*;
#[test]
fn all_asset_paths_exist() {
for asset in Asset::into_iter() {
let path = asset.path();
let full_path = format!("assets/game/{}", path);
let metadata = std::fs::metadata(&full_path)
.map_err(|e| format!("Error getting metadata for {}: {}", full_path, e))
.unwrap();
assert_that(&metadata.is_file()).is_true();
assert_that(&metadata.len()).is_greater_than(1024);
}
}

View File

@@ -1,40 +1,327 @@
use pacman::texture::blinking::BlinkingTexture;
use bevy_ecs::{entity::Entity, system::RunSystemOnce, world::World};
use pacman::systems::{blinking_system, Blinking, DeltaTime, Frozen, Renderable, Visibility};
use speculoos::prelude::*;
mod common;
#[test]
fn test_blinking_texture() {
let tile = common::mock_atlas_tile(1);
let mut texture = BlinkingTexture::new(tile, 0.5);
/// Creates a test world with blinking system resources
fn create_blinking_test_world() -> World {
let mut world = World::new();
world.insert_resource(DeltaTime::from_ticks(1));
world
}
assert!(texture.is_on());
/// Spawns a test entity with blinking and renderable components
fn spawn_blinking_entity(world: &mut World, interval_ticks: u32) -> Entity {
world
.spawn((
Blinking::new(interval_ticks),
Renderable {
sprite: common::mock_atlas_tile(1),
layer: 0,
},
Visibility::visible(),
))
.id()
}
texture.tick(0.5);
assert!(!texture.is_on());
/// Spawns a test entity with blinking, renderable, and hidden visibility
fn spawn_hidden_blinking_entity(world: &mut World, interval_ticks: u32) -> Entity {
world
.spawn((
Blinking::new(interval_ticks),
Renderable {
sprite: common::mock_atlas_tile(1),
layer: 0,
},
Visibility::hidden(),
))
.id()
}
texture.tick(0.5);
assert!(texture.is_on());
/// Spawns a test entity with blinking, renderable, and frozen components
fn spawn_frozen_blinking_entity(world: &mut World, interval_ticks: u32) -> Entity {
world
.spawn((
Blinking::new(interval_ticks),
Renderable {
sprite: common::mock_atlas_tile(1),
layer: 0,
},
Visibility::visible(),
Frozen,
))
.id()
}
texture.tick(0.5);
assert!(!texture.is_on());
/// Spawns a test entity with blinking, renderable, hidden visibility, and frozen components
fn spawn_frozen_hidden_blinking_entity(world: &mut World, interval_ticks: u32) -> Entity {
world
.spawn((
Blinking::new(interval_ticks),
Renderable {
sprite: common::mock_atlas_tile(1),
layer: 0,
},
Visibility::hidden(),
Frozen,
))
.id()
}
/// Runs the blinking system with the given delta time
fn run_blinking_system(world: &mut World, delta_ticks: u32) {
world.resource_mut::<DeltaTime>().ticks = delta_ticks;
world.run_system_once(blinking_system).unwrap();
}
/// Checks if an entity is visible
fn is_entity_visible(world: &World, entity: Entity) -> bool {
world
.entity(entity)
.get::<Visibility>()
.map(|v| v.is_visible())
.unwrap_or(true) // Default to visible if no Visibility component
}
/// Checks if an entity is hidden
fn is_entity_hidden(world: &World, entity: Entity) -> bool {
world
.entity(entity)
.get::<Visibility>()
.map(|v| v.is_hidden())
.unwrap_or(false) // Default to visible if no Visibility component
}
/// Checks if an entity has the Frozen component
fn has_frozen_component(world: &World, entity: Entity) -> bool {
world.entity(entity).contains::<Frozen>()
}
#[test]
fn test_blinking_texture_partial_duration() {
let tile = common::mock_atlas_tile(1);
let mut texture = BlinkingTexture::new(tile, 0.5);
fn test_blinking_component_creation() {
let blinking = Blinking::new(10);
texture.tick(0.625);
assert!(!texture.is_on());
assert_eq!(texture.time_bank(), 0.125);
assert_that(&blinking.tick_timer).is_equal_to(0);
assert_that(&blinking.interval_ticks).is_equal_to(10);
}
#[test]
fn test_blinking_texture_negative_time() {
let tile = common::mock_atlas_tile(1);
let mut texture = BlinkingTexture::new(tile, 0.5);
fn test_blinking_system_normal_interval_no_toggle() {
let mut world = create_blinking_test_world();
let entity = spawn_blinking_entity(&mut world, 5);
texture.tick(-0.1);
assert!(texture.is_on());
assert_eq!(texture.time_bank(), -0.1);
// Run system with 3 ticks (less than interval)
run_blinking_system(&mut world, 3);
// Entity should not be hidden yet
assert_that(&is_entity_visible(&world, entity)).is_true();
// Check that timer was updated
let blinking = world.entity(entity).get::<Blinking>().unwrap();
assert_that(&blinking.tick_timer).is_equal_to(3);
}
#[test]
fn test_blinking_system_normal_interval_first_toggle() {
let mut world = create_blinking_test_world();
let entity = spawn_blinking_entity(&mut world, 5);
// Run system with 5 ticks (exactly one interval)
run_blinking_system(&mut world, 5);
// Entity should now be hidden
assert_that(&is_entity_hidden(&world, entity)).is_true();
// Check that timer was reset
let blinking = world.entity(entity).get::<Blinking>().unwrap();
assert_that(&blinking.tick_timer).is_equal_to(0);
}
#[test]
fn test_blinking_system_normal_interval_second_toggle() {
let mut world = create_blinking_test_world();
let entity = spawn_blinking_entity(&mut world, 5);
// First toggle: 5 ticks
run_blinking_system(&mut world, 5);
assert_that(&is_entity_hidden(&world, entity)).is_true();
// Second toggle: another 5 ticks
run_blinking_system(&mut world, 5);
assert_that(&is_entity_visible(&world, entity)).is_true();
}
#[test]
fn test_blinking_system_normal_interval_multiple_intervals() {
let mut world = create_blinking_test_world();
let entity = spawn_blinking_entity(&mut world, 3);
// Run system with 7 ticks (2 complete intervals + 1 remainder)
run_blinking_system(&mut world, 7);
// Should toggle twice (even number), so back to original state (not hidden)
assert_that(&is_entity_visible(&world, entity)).is_true();
// Check that timer was updated to remainder
let blinking = world.entity(entity).get::<Blinking>().unwrap();
assert_that(&blinking.tick_timer).is_equal_to(1);
}
#[test]
fn test_blinking_system_normal_interval_odd_intervals() {
let mut world = create_blinking_test_world();
let entity = spawn_blinking_entity(&mut world, 2);
// Run system with 5 ticks (2 complete intervals + 1 remainder)
run_blinking_system(&mut world, 5);
// Should toggle twice (even number), so back to original state (not hidden)
assert_that(&is_entity_visible(&world, entity)).is_true();
// Check that timer was updated to remainder
let blinking = world.entity(entity).get::<Blinking>().unwrap();
assert_that(&blinking.tick_timer).is_equal_to(1);
}
#[test]
fn test_blinking_system_zero_interval_with_ticks() {
let mut world = create_blinking_test_world();
let entity = spawn_blinking_entity(&mut world, 0);
// Run system with any positive ticks
run_blinking_system(&mut world, 1);
// Entity should be hidden immediately
assert_that(&is_entity_hidden(&world, entity)).is_true();
}
#[test]
fn test_blinking_system_zero_interval_no_ticks() {
let mut world = create_blinking_test_world();
let entity = spawn_blinking_entity(&mut world, 0);
// Run system with 0 ticks
run_blinking_system(&mut world, 0);
// Entity should not be hidden (no time passed)
assert_that(&is_entity_visible(&world, entity)).is_true();
}
#[test]
fn test_blinking_system_zero_interval_toggle_back() {
let mut world = create_blinking_test_world();
let entity = spawn_hidden_blinking_entity(&mut world, 0);
// Run system with any positive ticks
run_blinking_system(&mut world, 1);
// Entity should be unhidden
assert_that(&is_entity_visible(&world, entity)).is_true();
}
#[test]
fn test_blinking_system_frozen_entity_unhidden() {
let mut world = create_blinking_test_world();
let entity = spawn_frozen_hidden_blinking_entity(&mut world, 5);
// Run system with ticks
run_blinking_system(&mut world, 10);
// Frozen entity should be unhidden and stay unhidden
assert_that(&is_entity_visible(&world, entity)).is_true();
assert_that(&has_frozen_component(&world, entity)).is_true();
}
#[test]
fn test_blinking_system_frozen_entity_no_blinking() {
let mut world = create_blinking_test_world();
let entity = spawn_frozen_blinking_entity(&mut world, 5);
// Run system with ticks
run_blinking_system(&mut world, 10);
// Frozen entity should not be hidden (blinking disabled)
assert_that(&is_entity_visible(&world, entity)).is_true();
assert_that(&has_frozen_component(&world, entity)).is_true();
}
#[test]
fn test_blinking_system_frozen_entity_timer_not_updated() {
let mut world = create_blinking_test_world();
let entity = spawn_frozen_blinking_entity(&mut world, 5);
// Run system with ticks
run_blinking_system(&mut world, 10);
// Timer should not be updated for frozen entities
let blinking = world.entity(entity).get::<Blinking>().unwrap();
assert_that(&blinking.tick_timer).is_equal_to(0);
}
#[test]
fn test_blinking_system_entity_without_renderable_ignored() {
let mut world = create_blinking_test_world();
// Spawn entity with only Blinking component (no Renderable)
let entity = world.spawn(Blinking::new(5)).id();
// Run system
run_blinking_system(&mut world, 10);
// Entity should not be affected (not in query)
assert_that(&is_entity_visible(&world, entity)).is_true();
}
#[test]
fn test_blinking_system_entity_without_blinking_ignored() {
let mut world = create_blinking_test_world();
// Spawn entity with only Renderable component (no Blinking)
let entity = world
.spawn(Renderable {
sprite: common::mock_atlas_tile(1),
layer: 0,
})
.id();
// Run system
run_blinking_system(&mut world, 10);
// Entity should not be affected (not in query)
assert_that(&is_entity_visible(&world, entity)).is_true();
}
#[test]
fn test_blinking_system_large_interval() {
let mut world = create_blinking_test_world();
let entity = spawn_blinking_entity(&mut world, 1000);
// Run system with 500 ticks (less than interval)
run_blinking_system(&mut world, 500);
// Entity should not be hidden yet
assert_that(&is_entity_visible(&world, entity)).is_true();
// Check that timer was updated
let blinking = world.entity(entity).get::<Blinking>().unwrap();
assert_that(&blinking.tick_timer).is_equal_to(500);
}
#[test]
fn test_blinking_system_very_small_interval() {
let mut world = create_blinking_test_world();
let entity = spawn_blinking_entity(&mut world, 1);
// Run system with 1 tick
run_blinking_system(&mut world, 1);
// Entity should be hidden
assert_that(&is_entity_hidden(&world, entity)).is_true();
// Run system with another 1 tick
run_blinking_system(&mut world, 1);
// Entity should be unhidden
assert_that(&is_entity_visible(&world, entity)).is_true();
}

View File

@@ -1,5 +1,6 @@
use bevy_ecs::system::RunSystemOnce;
use pacman::systems::{check_collision, collision_system, Collider, EntityType, GhostState, Position};
use speculoos::prelude::*;
mod common;
@@ -9,8 +10,8 @@ fn test_collider_collision_detection() {
let collider2 = Collider { size: 8.0 };
// Test collision detection
assert!(collider1.collides_with(collider2.size, 5.0)); // Should collide (distance < 9.0)
assert!(!collider1.collides_with(collider2.size, 15.0)); // Should not collide (distance > 9.0)
assert_that(&collider1.collides_with(collider2.size, 5.0)).is_true(); // Should collide (distance < 9.0)
assert_that(&collider1.collides_with(collider2.size, 15.0)).is_false(); // Should not collide (distance > 9.0)
}
#[test]
@@ -23,31 +24,29 @@ fn test_check_collision_helper() {
// Test collision at same position
let result = check_collision(&pos1, &collider1, &pos2, &collider2, &map);
assert!(result.is_ok());
assert!(result.unwrap()); // Should collide at same position
assert_that(&result.is_ok()).is_true();
assert_that(&result.unwrap()).is_true(); // Should collide at same position
// Test collision at different positions
let pos3 = Position::Stopped { node: 1 }; // Different position
let result = check_collision(&pos1, &collider1, &pos3, &collider2, &map);
assert!(result.is_ok());
assert_that(&result.is_ok()).is_true();
// May or may not collide depending on actual node positions
}
#[test]
fn test_collision_system_pacman_item() {
let mut world = common::create_test_world();
let (mut world, mut schedule) = common::create_test_world();
let _pacman = common::spawn_test_pacman(&mut world, 0);
let _item = common::spawn_test_item(&mut world, 0, EntityType::Pellet);
// Run collision system - should not panic
world
.run_system_once(collision_system)
.expect("System should run successfully");
schedule.run(&mut world);
}
#[test]
fn test_collision_system_pacman_ghost() {
let mut world = common::create_test_world();
let (mut world, _) = common::create_test_world();
let _pacman = common::spawn_test_pacman(&mut world, 0);
let _ghost = common::spawn_test_ghost(&mut world, 0, GhostState::Normal);
@@ -59,19 +58,17 @@ fn test_collision_system_pacman_ghost() {
#[test]
fn test_collision_system_no_collision() {
let mut world = common::create_test_world();
let (mut world, mut schedule) = common::create_test_world();
let _pacman = common::spawn_test_pacman(&mut world, 0);
let _ghost = common::spawn_test_ghost(&mut world, 1, GhostState::Normal); // Different node
// Run collision system - should not panic
world
.run_system_once(collision_system)
.expect("System should run successfully");
schedule.run(&mut world);
}
#[test]
fn test_collision_system_multiple_entities() {
let mut world = common::create_test_world();
let (mut world, _) = common::create_test_world();
let _pacman = common::spawn_test_pacman(&mut world, 0);
let _item = common::spawn_test_item(&mut world, 0, EntityType::Pellet);
let _ghost = common::spawn_test_ghost(&mut world, 0, GhostState::Normal);

View File

@@ -1,11 +1,11 @@
#![allow(dead_code)]
use bevy_ecs::{entity::Entity, event::Events, world::World};
use bevy_ecs::{entity::Entity, event::Events, schedule::Schedule, world::World};
use glam::{U16Vec2, Vec2};
use pacman::{
asset::{get_asset_bytes, Asset},
asset::Asset,
constants::RAW_BOARD,
events::GameEvent,
events::{CollisionTrigger, GameEvent},
game::ATLAS_FRAMES,
map::{
builder::Map,
@@ -13,8 +13,9 @@ use pacman::{
graph::{Graph, Node},
},
systems::{
AudioEvent, AudioState, BufferedDirection, Collider, DebugState, DeltaTime, EntityType, Ghost, GhostCollider, GhostState,
GlobalState, ItemCollider, MovementModifiers, PacmanCollider, PlayerControlled, Position, ScoreResource, Velocity,
item_collision_observer, AudioEvent, AudioState, BufferedDirection, Collider, DebugState, DeltaTime, EntityType,
FruitSprites, Ghost, GhostCollider, GhostState, GlobalState, ItemCollider, MovementModifiers, PacmanCollider,
PelletCount, PlayerControlled, Position, ScoreResource, Velocity,
},
texture::sprite::{AtlasMapper, AtlasTile, SpriteAtlas},
};
@@ -42,7 +43,7 @@ pub fn setup_sdl() -> Result<(Canvas<Window>, TextureCreator<WindowContext>, Sdl
pub fn create_atlas(canvas: &mut sdl2::render::Canvas<sdl2::video::Window>) -> SpriteAtlas {
let texture_creator = canvas.texture_creator();
let atlas_bytes = get_asset_bytes(Asset::AtlasImage).unwrap();
let atlas_bytes = Asset::AtlasImage.get_bytes().unwrap();
let texture = texture_creator.load_texture_bytes(&atlas_bytes).unwrap();
@@ -74,7 +75,7 @@ pub fn create_test_graph() -> Graph {
}
/// Creates a basic test world with required resources for ECS systems
pub fn create_test_world() -> World {
pub fn create_test_world() -> (World, Schedule) {
let mut world = World::new();
// Add required resources
@@ -82,13 +83,22 @@ pub fn create_test_world() -> World {
world.insert_resource(Events::<pacman::error::GameError>::default());
world.insert_resource(Events::<AudioEvent>::default());
world.insert_resource(ScoreResource(0));
world.insert_resource(FruitSprites::default());
world.insert_resource(AudioState::default());
world.insert_resource(GlobalState { exit: false });
world.insert_resource(DebugState::default());
world.insert_resource(DeltaTime(1.0 / 60.0)); // 60 FPS
world.insert_resource(PelletCount(0));
world.insert_resource(DeltaTime {
seconds: 1.0 / 60.0,
ticks: 1,
}); // 60 FPS
world.insert_resource(create_test_map());
world
let schedule = Schedule::default();
world.add_observer(item_collision_observer);
(world, schedule)
}
/// Creates a test map using the default RAW_BOARD
@@ -158,9 +168,8 @@ pub fn send_game_event(world: &mut World, event: GameEvent) {
}
/// Sends a collision event between two entities
pub fn send_collision_event(world: &mut World, entity1: Entity, entity2: Entity) {
let mut events = world.resource_mut::<Events<GameEvent>>();
events.send(GameEvent::Collision(entity1, entity2));
pub fn trigger_collision(world: &mut World, event: CollisionTrigger) {
world.trigger(event);
}
/// Creates a mock atlas tile for testing

View File

@@ -1,35 +0,0 @@
use pacman::constants::*;
#[test]
fn test_raw_board_structure() {
// Test board dimensions match expected size
assert_eq!(RAW_BOARD.len(), BOARD_CELL_SIZE.y as usize);
for row in RAW_BOARD.iter() {
assert_eq!(row.len(), BOARD_CELL_SIZE.x as usize);
}
// Test boundaries are properly walled
assert!(RAW_BOARD[0].chars().all(|c| c == '#'));
assert!(RAW_BOARD[RAW_BOARD.len() - 1].chars().all(|c| c == '#'));
}
#[test]
fn test_raw_board_contains_required_elements() {
// Test that essential game elements are present
assert!(
RAW_BOARD.iter().any(|row| row.contains('X')),
"Board should contain Pac-Man start position"
);
assert!(
RAW_BOARD.iter().any(|row| row.contains("==")),
"Board should contain ghost house door"
);
assert!(
RAW_BOARD.iter().any(|row| row.chars().any(|c| c == 'T')),
"Board should contain tunnel entrances"
);
assert!(
RAW_BOARD.iter().any(|row| row.chars().any(|c| c == 'o')),
"Board should contain power pellets"
);
}

View File

@@ -1,5 +1,5 @@
use glam::I8Vec2;
use pacman::map::direction::*;
use speculoos::prelude::*;
#[test]
fn test_direction_opposite() {
@@ -11,21 +11,47 @@ fn test_direction_opposite() {
];
for (dir, expected) in test_cases {
assert_eq!(dir.opposite(), expected);
assert_that(&dir.opposite()).is_equal_to(expected);
}
}
#[test]
fn test_direction_as_ivec2() {
let test_cases = [
(Direction::Up, -I8Vec2::Y),
(Direction::Down, I8Vec2::Y),
(Direction::Left, -I8Vec2::X),
(Direction::Right, I8Vec2::X),
];
fn test_direction_opposite_symmetry() {
// Test that opposite() is symmetric: opposite(opposite(d)) == d
for &dir in &Direction::DIRECTIONS {
assert_that(&dir.opposite().opposite()).is_equal_to(dir);
}
}
for (dir, expected) in test_cases {
assert_eq!(dir.as_ivec2(), expected);
assert_eq!(I8Vec2::from(dir), expected);
#[test]
fn test_direction_opposite_exhaustive() {
// Test that every direction has a unique opposite
let mut opposites = std::collections::HashSet::new();
for &dir in &Direction::DIRECTIONS {
let opposite = dir.opposite();
assert_that(&opposites.insert(opposite)).is_true();
}
assert_that(&opposites).has_length(4);
}
#[test]
fn test_direction_as_usize_exhaustive() {
// Test that as_usize() returns unique values for all directions
let mut usizes = std::collections::HashSet::new();
for &dir in &Direction::DIRECTIONS {
let usize_val = dir.as_usize();
assert_that(&usizes.insert(usize_val)).is_true();
}
assert_that(&usizes).has_length(4);
}
#[test]
fn test_direction_as_ivec2_exhaustive() {
// Test that as_ivec2() returns unique values for all directions
let mut ivec2s = std::collections::HashSet::new();
for &dir in &Direction::DIRECTIONS {
let ivec2_val = dir.as_ivec2();
assert_that(&ivec2s.insert(ivec2_val)).is_true();
}
assert_that(&ivec2s).has_length(4);
}

View File

@@ -1,134 +0,0 @@
use pacman::error::{
AssetError, EntityError, GameError, GameResult, IntoGameError, MapError, OptionExt, ParseError, ResultExt, TextureError,
};
use std::io;
#[test]
fn test_game_error_from_asset_error() {
let asset_error = AssetError::NotFound("test.png".to_string());
let game_error: GameError = asset_error.into();
assert!(matches!(game_error, GameError::Asset(_)));
}
#[test]
fn test_game_error_from_parse_error() {
let parse_error = ParseError::UnknownCharacter('Z');
let game_error: GameError = parse_error.into();
assert!(matches!(game_error, GameError::MapParse(_)));
}
#[test]
fn test_game_error_from_map_error() {
let map_error = MapError::NodeNotFound(42);
let game_error: GameError = map_error.into();
assert!(matches!(game_error, GameError::Map(_)));
}
#[test]
fn test_game_error_from_texture_error() {
let texture_error = TextureError::LoadFailed("Failed to load".to_string());
let game_error: GameError = texture_error.into();
assert!(matches!(game_error, GameError::Texture(_)));
}
#[test]
fn test_game_error_from_entity_error() {
let entity_error = EntityError::NodeNotFound(10);
let game_error: GameError = entity_error.into();
assert!(matches!(game_error, GameError::Entity(_)));
}
#[test]
fn test_game_error_from_io_error() {
let io_error = io::Error::new(io::ErrorKind::NotFound, "File not found");
let game_error: GameError = io_error.into();
assert!(matches!(game_error, GameError::Io(_)));
}
#[test]
fn test_asset_error_from_io_error() {
let io_error = io::Error::new(io::ErrorKind::PermissionDenied, "Permission denied");
let asset_error: AssetError = io_error.into();
assert!(matches!(asset_error, AssetError::Io(_)));
}
#[test]
fn test_parse_error_display() {
let error = ParseError::UnknownCharacter('!');
assert_eq!(error.to_string(), "Unknown character in board: !");
let error = ParseError::InvalidHouseDoorCount(3);
assert_eq!(error.to_string(), "House door must have exactly 2 positions, found 3");
}
#[test]
fn test_entity_error_display() {
let error = EntityError::NodeNotFound(42);
assert_eq!(error.to_string(), "Node not found in graph: 42");
let error = EntityError::EdgeNotFound { from: 1, to: 2 };
assert_eq!(error.to_string(), "Edge not found: from 1 to 2");
}
#[test]
fn test_into_game_error_trait() {
let result: Result<i32, io::Error> = Err(io::Error::new(io::ErrorKind::Other, "test error"));
let game_result: GameResult<i32> = result.into_game_error();
assert!(game_result.is_err());
if let Err(GameError::InvalidState(msg)) = game_result {
assert!(msg.contains("test error"));
} else {
panic!("Expected InvalidState error");
}
}
#[test]
fn test_into_game_error_trait_success() {
let result: Result<i32, io::Error> = Ok(42);
let game_result: GameResult<i32> = result.into_game_error();
assert_eq!(game_result.unwrap(), 42);
}
#[test]
fn test_option_ext_some() {
let option: Option<i32> = Some(42);
let result: GameResult<i32> = option.ok_or_game_error(|| GameError::InvalidState("Not found".to_string()));
assert_eq!(result.unwrap(), 42);
}
#[test]
fn test_option_ext_none() {
let option: Option<i32> = None;
let result: GameResult<i32> = option.ok_or_game_error(|| GameError::InvalidState("Not found".to_string()));
assert!(result.is_err());
if let Err(GameError::InvalidState(msg)) = result {
assert_eq!(msg, "Not found");
} else {
panic!("Expected InvalidState error");
}
}
#[test]
fn test_result_ext_success() {
let result: Result<i32, io::Error> = Ok(42);
let game_result: GameResult<i32> = result.with_context(|_| GameError::InvalidState("Context".to_string()));
assert_eq!(game_result.unwrap(), 42);
}
#[test]
fn test_result_ext_error() {
let result: Result<i32, io::Error> = Err(io::Error::new(io::ErrorKind::Other, "original error"));
let game_result: GameResult<i32> = result.with_context(|_| GameError::InvalidState("Context error".to_string()));
assert!(game_result.is_err());
if let Err(GameError::InvalidState(msg)) = game_result {
assert_eq!(msg, "Context error");
} else {
panic!("Expected InvalidState error");
}
}

View File

@@ -1,8 +1,7 @@
use pacman::systems::profiling::format_timing_display;
use speculoos::prelude::*;
use std::time::Duration;
use pretty_assertions::assert_eq;
fn get_timing_data() -> Vec<(String, Duration, Duration)> {
vec![
("total".to_string(), Duration::from_micros(1234), Duration::from_micros(570)),
@@ -53,45 +52,25 @@ fn test_complex_formatting_alignment() {
});
// Assert that all positions were found
assert_eq!(
[
assert_that(
&[
&colon_positions,
&first_decimal_positions,
&second_decimal_positions,
&first_unit_positions,
&second_unit_positions
&second_unit_positions,
]
.iter()
.all(|p| p.len() == 6),
true
);
)
.is_true();
// Assert that all positions are the same
assert!(
colon_positions.iter().all(|&p| p == colon_positions[0]),
"colon positions are not the same {:?}",
colon_positions
);
assert!(
first_decimal_positions.iter().all(|&p| p == first_decimal_positions[0]),
"first decimal positions are not the same {:?}",
first_decimal_positions
);
assert!(
second_decimal_positions.iter().all(|&p| p == second_decimal_positions[0]),
"second decimal positions are not the same {:?}",
second_decimal_positions
);
assert!(
first_unit_positions.iter().all(|&p| p == first_unit_positions[0]),
"first unit positions are not the same {:?}",
first_unit_positions
);
assert!(
second_unit_positions.iter().all(|&p| p == second_unit_positions[0]),
"second unit positions are not the same {:?}",
second_unit_positions
);
assert_that(&colon_positions.iter().all(|&p| p == colon_positions[0])).is_true();
assert_that(&first_decimal_positions.iter().all(|&p| p == first_decimal_positions[0])).is_true();
assert_that(&second_decimal_positions.iter().all(|&p| p == second_decimal_positions[0])).is_true();
assert_that(&first_unit_positions.iter().all(|&p| p == first_unit_positions[0])).is_true();
assert_that(&second_unit_positions.iter().all(|&p| p == second_unit_positions[0])).is_true();
}
#[test]
@@ -105,17 +84,17 @@ fn test_format_timing_display_basic() {
let formatted = format_timing_display(timing_data);
// Should have 3 lines (one for each system)
assert_eq!(formatted.len(), 3);
assert_that(&formatted.len()).is_equal_to(3);
// Each line should contain the system name
assert!(formatted.iter().any(|line| line.contains("render")));
assert!(formatted.iter().any(|line| line.contains("input")));
assert!(formatted.iter().any(|line| line.contains("physics")));
assert_that(&formatted.iter().any(|line| line.contains("render"))).is_true();
assert_that(&formatted.iter().any(|line| line.contains("input"))).is_true();
assert_that(&formatted.iter().any(|line| line.contains("physics"))).is_true();
// Each line should contain timing information with proper units
for line in formatted.iter() {
assert!(line.contains(":"), "Line should contain colon separator: {}", line);
assert!(line.contains("±"), "Line should contain ± symbol: {}", line);
assert_that(&line.contains(":")).is_true();
assert_that(&line.contains("±")).is_true();
}
}
@@ -132,10 +111,10 @@ fn test_format_timing_display_units() {
// Check that appropriate units are used
let all_lines = formatted.join(" ");
assert!(all_lines.contains("s"), "Should contain seconds unit");
assert!(all_lines.contains("ms"), "Should contain milliseconds unit");
assert!(all_lines.contains("µs"), "Should contain microseconds unit");
assert!(all_lines.contains("ns"), "Should contain nanoseconds unit");
assert_that(&all_lines.contains("s")).is_true();
assert_that(&all_lines.contains("ms")).is_true();
assert_that(&all_lines.contains("µs")).is_true();
assert_that(&all_lines.contains("ns")).is_true();
}
#[test]
@@ -157,9 +136,6 @@ fn test_format_timing_display_alignment() {
// All colons should be at the same position (aligned)
if colon_positions.len() > 1 {
let first_pos = colon_positions[0];
assert!(
colon_positions.iter().all(|&pos| pos == first_pos),
"Colons should be aligned at the same position"
);
assert_that(&colon_positions.iter().all(|&pos| pos == first_pos)).is_true();
}
}

79
tests/game.rs Normal file
View File

@@ -0,0 +1,79 @@
use pacman::error::{GameError, GameResult};
use pacman::game::Game;
use speculoos::prelude::*;
mod common;
use common::setup_sdl;
#[test]
fn test_game_30_seconds_60fps() -> GameResult<()> {
let (canvas, texture_creator, _sdl_context) = setup_sdl().map_err(GameError::Sdl)?;
let ttf_context = sdl2::ttf::init().map_err(GameError::Sdl)?;
let event_pump = _sdl_context
.event_pump()
.map_err(|e| pacman::error::GameError::Sdl(e.to_string()))?;
let mut game = Game::new(canvas, ttf_context, texture_creator, event_pump)?;
// Run for 30 seconds at 60 FPS = 1800 frames
let frame_time = 1.0 / 60.0;
let total_frames = 1800;
let mut frame_count = 0;
for _ in 0..total_frames {
let should_exit = game.tick(frame_time);
if should_exit {
break;
}
frame_count += 1;
}
assert_eq!(
frame_count, total_frames,
"Should have processed exactly {} frames",
total_frames
);
Ok(())
}
/// Test that runs the game for 30 seconds with variable frame timing
#[test]
fn test_game_30_seconds_variable_timing() -> GameResult<()> {
let (canvas, texture_creator, _sdl_context) = setup_sdl().map_err(GameError::Sdl)?;
let ttf_context = sdl2::ttf::init().map_err(|e| GameError::Sdl(e.to_string()))?;
let event_pump = _sdl_context
.event_pump()
.map_err(|e| pacman::error::GameError::Sdl(e.to_string()))?;
let mut game = Game::new(canvas, ttf_context, texture_creator, event_pump)?;
// Simulate 30 seconds with variable frame timing
let mut total_time = 0.0;
let target_time = 30.0;
let mut frame_count = 0;
while total_time < target_time {
// Alternate between different frame rates to simulate real gameplay
let frame_time = match frame_count % 4 {
0 => 1.0 / 60.0, // 60 FPS
1 => 1.0 / 30.0, // 30 FPS (lag spike)
2 => 1.0 / 120.0, // 120 FPS (very fast)
_ => 1.0 / 60.0, // 60 FPS
};
let should_exit = game.tick(frame_time);
if should_exit {
break;
}
total_time += frame_time;
frame_count += 1;
}
assert_that(&total_time).is_greater_than_or_equal_to(target_time);
Ok(())
}

View File

@@ -1,5 +1,6 @@
use pacman::map::direction::Direction;
use pacman::map::graph::{Graph, Node, TraversalFlags};
use speculoos::prelude::*;
mod common;
@@ -13,10 +14,10 @@ fn test_graph_basic_operations() {
position: glam::Vec2::new(16.0, 0.0),
});
assert_eq!(graph.nodes().count(), 2);
assert!(graph.get_node(node1).is_some());
assert!(graph.get_node(node2).is_some());
assert!(graph.get_node(999).is_none());
assert_that(&graph.nodes().count()).is_equal_to(2);
assert_that(&graph.get_node(node1).is_some()).is_true();
assert_that(&graph.get_node(node2).is_some()).is_true();
assert_that(&graph.get_node(999).is_none()).is_true();
}
#[test]
@@ -29,15 +30,15 @@ fn test_graph_connect() {
position: glam::Vec2::new(16.0, 0.0),
});
assert!(graph.connect(node1, node2, false, None, Direction::Right).is_ok());
assert_that(&graph.connect(node1, node2, false, None, Direction::Right).is_ok()).is_true();
let edge1 = graph.find_edge_in_direction(node1, Direction::Right);
let edge2 = graph.find_edge_in_direction(node2, Direction::Left);
assert!(edge1.is_some());
assert!(edge2.is_some());
assert_eq!(edge1.unwrap().target, node2);
assert_eq!(edge2.unwrap().target, node1);
assert_that(&edge1.is_some()).is_true();
assert_that(&edge2.is_some()).is_true();
assert_that(&edge1.unwrap().target).is_equal_to(node2);
assert_that(&edge2.unwrap().target).is_equal_to(node1);
}
#[test]
@@ -47,8 +48,8 @@ fn test_graph_connect_errors() {
position: glam::Vec2::new(0.0, 0.0),
});
assert!(graph.connect(node1, 999, false, None, Direction::Right).is_err());
assert!(graph.connect(999, node1, false, None, Direction::Right).is_err());
assert_that(&graph.connect(node1, 999, false, None, Direction::Right).is_err()).is_true();
assert_that(&graph.connect(999, node1, false, None, Direction::Right).is_err()).is_true();
}
#[test]
@@ -66,7 +67,7 @@ fn test_graph_edge_permissions() {
.unwrap();
let edge = graph.find_edge_in_direction(node1, Direction::Right).unwrap();
assert_eq!(edge.traversal_flags, TraversalFlags::GHOST);
assert_that(&edge.traversal_flags).is_equal_to(TraversalFlags::GHOST);
}
#[test]
@@ -86,10 +87,10 @@ fn should_add_connected_node() {
)
.unwrap();
assert_eq!(graph.nodes().count(), 2);
assert_that(&graph.nodes().count()).is_equal_to(2);
let edge = graph.find_edge(node1, node2);
assert!(edge.is_some());
assert_eq!(edge.unwrap().direction, Direction::Right);
assert_that(&edge.is_some()).is_true();
assert_that(&edge.unwrap().direction).is_equal_to(Direction::Right);
}
#[test]
@@ -103,33 +104,33 @@ fn should_error_on_negative_edge_distance() {
});
let result = graph.add_edge(node1, node2, false, Some(-1.0), Direction::Right, TraversalFlags::ALL);
assert!(result.is_err());
assert_that(&result.is_err()).is_true();
}
#[test]
fn should_error_on_duplicate_edge_without_replace() {
let mut graph = common::create_test_graph();
let result = graph.add_edge(0, 1, false, None, Direction::Right, TraversalFlags::ALL);
assert!(result.is_err());
assert_that(&result.is_err()).is_true();
}
#[test]
fn should_allow_replacing_an_edge() {
let mut graph = common::create_test_graph();
let result = graph.add_edge(0, 1, true, Some(42.0), Direction::Right, TraversalFlags::ALL);
assert!(result.is_ok());
assert_that(&result.is_ok()).is_true();
let edge = graph.find_edge(0, 1).unwrap();
assert_eq!(edge.distance, 42.0);
assert_that(&edge.distance).is_equal_to(42.0);
}
#[test]
fn should_find_edge_between_nodes() {
let graph = common::create_test_graph();
let edge = graph.find_edge(0, 1);
assert!(edge.is_some());
assert_eq!(edge.unwrap().target, 1);
assert_that(&edge.is_some()).is_true();
assert_that(&edge.unwrap().target).is_equal_to(1);
let non_existent_edge = graph.find_edge(0, 99);
assert!(non_existent_edge.is_none());
assert_that(&non_existent_edge.is_none()).is_true();
}

View File

@@ -1,38 +1,321 @@
use glam::Vec2;
use pacman::events::{GameCommand, GameEvent};
use pacman::map::direction::Direction;
use pacman::systems::input::{process_simple_key_events, Bindings, SimpleKeyEvent};
use pacman::systems::input::{
calculate_direction_from_delta, process_simple_key_events, update_touch_reference_position, Bindings, CursorPosition,
SimpleKeyEvent, TouchData, TouchState, TOUCH_DIRECTION_THRESHOLD, TOUCH_EASING_DISTANCE_THRESHOLD,
};
use sdl2::keyboard::Keycode;
use speculoos::prelude::*;
// Test modules for better organization
mod keyboard_tests {
use super::*;
#[test]
fn resumes_previous_direction_when_secondary_key_released() {
fn key_down_emits_bound_command() {
let mut bindings = Bindings::default();
// Frame 1: Press W (Up) => emits Move Up
let events = process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyDown(Keycode::W)]);
assert!(events.contains(&GameEvent::Command(GameCommand::MovePlayer(Direction::Up))));
// Frame 2: Press D (Right) => emits Move Right
let events = process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyDown(Keycode::D)]);
assert!(events.contains(&GameEvent::Command(GameCommand::MovePlayer(Direction::Right))));
// Frame 3: Release D, no new key this frame => should continue previous key W (Up)
let events = process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyUp(Keycode::D)]);
assert!(events.contains(&GameEvent::Command(GameCommand::MovePlayer(Direction::Up))));
assert_that(&events).contains(GameEvent::Command(GameCommand::MovePlayer(Direction::Up)));
}
#[test]
fn holds_last_pressed_key_across_frames_when_no_new_input() {
fn key_down_emits_non_movement_commands() {
let mut bindings = Bindings::default();
// Frame 1: Press Left
let events = process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyDown(Keycode::Left)]);
assert!(events.contains(&GameEvent::Command(GameCommand::MovePlayer(Direction::Left))));
// Frame 2: No input => continues Left
let events = process_simple_key_events(&mut bindings, &[]);
assert!(events.contains(&GameEvent::Command(GameCommand::MovePlayer(Direction::Left))));
// Frame 3: Release Left, no input remains => nothing emitted
let events = process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyUp(Keycode::Left)]);
assert!(events.is_empty());
let events = process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyDown(Keycode::P)]);
assert_that(&events).contains(GameEvent::Command(GameCommand::TogglePause));
}
#[test]
fn unbound_key_emits_nothing() {
let mut bindings = Bindings::default();
let events = process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyDown(Keycode::Z)]);
assert_that(&events).is_empty();
}
#[test]
fn movement_key_held_continues_across_frames() {
let mut bindings = Bindings::default();
process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyDown(Keycode::Left)]);
let events = process_simple_key_events(&mut bindings, &[]);
assert_that(&events).contains(GameEvent::Command(GameCommand::MovePlayer(Direction::Left)));
}
#[test]
fn releasing_movement_key_stops_continuation() {
let mut bindings = Bindings::default();
process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyDown(Keycode::Up)]);
let events = process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyUp(Keycode::Up)]);
assert_that(&events).is_empty();
}
#[test]
fn multiple_movement_keys_resumes_previous_when_current_released() {
let mut bindings = Bindings::default();
process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyDown(Keycode::W)]);
process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyDown(Keycode::D)]);
let events = process_simple_key_events(&mut bindings, &[SimpleKeyEvent::KeyUp(Keycode::D)]);
assert_that(&events).contains(GameEvent::Command(GameCommand::MovePlayer(Direction::Up)));
}
}
mod direction_calculation_tests {
use super::*;
#[test]
fn prioritizes_horizontal_movement() {
let test_cases = vec![
(Vec2::new(6.0, 5.0), Direction::Right),
(Vec2::new(-6.0, 5.0), Direction::Left),
];
for (delta, expected) in test_cases {
assert_that(&calculate_direction_from_delta(delta)).is_equal_to(expected);
}
}
#[test]
fn uses_vertical_when_dominant() {
let test_cases = vec![
(Vec2::new(3.0, 10.0), Direction::Down),
(Vec2::new(3.0, -10.0), Direction::Up),
];
for (delta, expected) in test_cases {
assert_that(&calculate_direction_from_delta(delta)).is_equal_to(expected);
}
}
#[test]
fn handles_zero_delta() {
let delta = Vec2::ZERO;
// Should default to Up when both components are zero
assert_that(&calculate_direction_from_delta(delta)).is_equal_to(Direction::Up);
}
#[test]
fn handles_equal_magnitudes() {
// When x and y have equal absolute values, should prioritize vertical
let delta = Vec2::new(5.0, 5.0);
assert_that(&calculate_direction_from_delta(delta)).is_equal_to(Direction::Down);
let delta = Vec2::new(-5.0, 5.0);
assert_that(&calculate_direction_from_delta(delta)).is_equal_to(Direction::Down);
}
}
mod touch_easing_tests {
use super::*;
#[test]
fn easing_within_threshold_does_nothing() {
let mut touch_data = TouchData::new(0, Vec2::new(100.0, 100.0));
touch_data.current_pos = Vec2::new(100.0 + TOUCH_EASING_DISTANCE_THRESHOLD - 0.1, 100.0);
let (_delta, distance) = update_touch_reference_position(&mut touch_data, 0.016);
assert_that(&distance).is_less_than(TOUCH_EASING_DISTANCE_THRESHOLD);
assert_that(&touch_data.start_pos).is_equal_to(Vec2::new(100.0, 100.0));
}
#[test]
fn easing_beyond_threshold_moves_towards_target() {
let mut touch_data = TouchData::new(0, Vec2::new(100.0, 100.0));
touch_data.current_pos = Vec2::new(150.0, 100.0);
let original_start_pos = touch_data.start_pos;
let (_delta, distance) = update_touch_reference_position(&mut touch_data, 0.016);
assert_that(&distance).is_greater_than(TOUCH_EASING_DISTANCE_THRESHOLD);
assert_that(&touch_data.start_pos.x).is_greater_than(original_start_pos.x);
assert_that(&touch_data.start_pos.x).is_less_than(touch_data.current_pos.x);
}
#[test]
fn easing_overshoot_sets_to_target() {
let mut touch_data = TouchData::new(0, Vec2::new(100.0, 100.0));
touch_data.current_pos = Vec2::new(101.0, 100.0);
let (_delta, _distance) = update_touch_reference_position(&mut touch_data, 10.0);
assert_that(&touch_data.start_pos).is_equal_to(touch_data.current_pos);
}
#[test]
fn easing_returns_correct_delta() {
let mut touch_data = TouchData::new(0, Vec2::new(100.0, 100.0));
touch_data.current_pos = Vec2::new(120.0, 110.0);
let (delta, distance) = update_touch_reference_position(&mut touch_data, 0.016);
let expected_delta = Vec2::new(20.0, 10.0);
let expected_distance = expected_delta.length();
assert_that(&delta).is_equal_to(expected_delta);
assert_that(&distance).is_equal_to(expected_distance);
}
}
// Integration tests for the full input system
mod integration_tests {
use super::*;
fn mouse_motion_event(x: i32, y: i32) -> sdl2::event::Event {
sdl2::event::Event::MouseMotion {
x,
y,
xrel: 0,
yrel: 0,
mousestate: sdl2::mouse::MouseState::from_sdl_state(0),
which: 0,
window_id: 0,
timestamp: 0,
}
}
fn mouse_button_down_event(x: i32, y: i32) -> sdl2::event::Event {
sdl2::event::Event::MouseButtonDown {
x,
y,
mouse_btn: sdl2::mouse::MouseButton::Left,
clicks: 1,
which: 0,
window_id: 0,
timestamp: 0,
}
}
fn mouse_button_up_event(x: i32, y: i32) -> sdl2::event::Event {
sdl2::event::Event::MouseButtonUp {
x,
y,
mouse_btn: sdl2::mouse::MouseButton::Left,
clicks: 1,
which: 0,
window_id: 0,
timestamp: 0,
}
}
// Simplified helper for testing SDL integration
fn run_input_system_with_events(events: Vec<sdl2::event::Event>, delta_time: f32) -> (CursorPosition, TouchState) {
use bevy_ecs::{event::Events, system::RunSystemOnce, world::World};
use pacman::systems::components::DeltaTime;
use pacman::systems::input::input_system;
let sdl_context = sdl2::init().expect("Failed to initialize SDL");
let event_subsystem = sdl_context.event().expect("Failed to get event subsystem");
let event_pump = sdl_context.event_pump().expect("Failed to create event pump");
let mut world = World::new();
world.insert_resource(Events::<GameEvent>::default());
world.insert_resource(DeltaTime {
seconds: delta_time,
ticks: 1,
});
world.insert_resource(Bindings::default());
world.insert_resource(CursorPosition::None);
world.insert_resource(TouchState::default());
world.insert_non_send_resource(event_pump);
// Inject events into SDL's event queue
for event in events {
event_subsystem.push_event(event).expect("Failed to push event");
}
// Run the real input system
world
.run_system_once(input_system)
.expect("Input system should run successfully");
let cursor = *world.resource::<CursorPosition>();
let touch_state = world.resource::<TouchState>().clone();
(cursor, touch_state)
}
#[test]
fn mouse_motion_updates_cursor_position() {
let events = vec![mouse_motion_event(100, 200)];
let (cursor, _touch_state) = run_input_system_with_events(events, 0.016);
match cursor {
CursorPosition::Some {
position,
remaining_time,
} => {
assert_that(&position).is_equal_to(Vec2::new(100.0, 200.0));
assert_that(&remaining_time).is_equal_to(0.20);
}
CursorPosition::None => panic!("Expected cursor position to be set"),
}
}
#[test]
fn mouse_button_down_starts_touch() {
let events = vec![mouse_button_down_event(150, 250)];
let (_cursor, touch_state) = run_input_system_with_events(events, 0.016);
assert_that(&touch_state.active_touch).is_some();
if let Some(touch_data) = &touch_state.active_touch {
assert_that(&touch_data.finger_id).is_equal_to(0);
assert_that(&touch_data.start_pos).is_equal_to(Vec2::new(150.0, 250.0));
}
}
#[test]
fn mouse_button_up_ends_touch() {
let events = vec![mouse_button_down_event(150, 250), mouse_button_up_event(150, 250)];
let (_cursor, touch_state) = run_input_system_with_events(events, 0.016);
assert_that(&touch_state.active_touch).is_none();
}
}
// Touch direction tests
mod touch_direction_tests {
use super::*;
#[test]
fn movement_above_threshold_emits_direction() {
let mut touch_data = TouchData::new(1, Vec2::new(100.0, 100.0));
touch_data.current_pos = Vec2::new(100.0 + TOUCH_DIRECTION_THRESHOLD + 5.0, 100.0);
let (delta, distance) = update_touch_reference_position(&mut touch_data, 0.016);
assert_that(&distance).is_greater_than_or_equal_to(TOUCH_DIRECTION_THRESHOLD);
let direction = calculate_direction_from_delta(delta);
assert_that(&direction).is_equal_to(Direction::Right);
}
#[test]
fn movement_below_threshold_no_direction() {
let mut touch_data = TouchData::new(1, Vec2::new(100.0, 100.0));
touch_data.current_pos = Vec2::new(100.0 + TOUCH_DIRECTION_THRESHOLD - 1.0, 100.0);
let (_delta, distance) = update_touch_reference_position(&mut touch_data, 0.016);
assert_that(&distance).is_less_than(TOUCH_DIRECTION_THRESHOLD);
}
#[test]
fn all_directions_work_correctly() {
let test_cases = vec![
(Vec2::new(TOUCH_DIRECTION_THRESHOLD + 5.0, 0.0), Direction::Right),
(Vec2::new(-TOUCH_DIRECTION_THRESHOLD - 5.0, 0.0), Direction::Left),
(Vec2::new(0.0, TOUCH_DIRECTION_THRESHOLD + 5.0), Direction::Down),
(Vec2::new(0.0, -TOUCH_DIRECTION_THRESHOLD - 5.0), Direction::Up),
];
for (offset, expected_direction) in test_cases {
let mut touch_data = TouchData::new(1, Vec2::new(100.0, 100.0));
touch_data.current_pos = Vec2::new(100.0, 100.0) + offset;
let (delta, distance) = update_touch_reference_position(&mut touch_data, 0.016);
assert_that(&distance).is_greater_than_or_equal_to(TOUCH_DIRECTION_THRESHOLD);
let direction = calculate_direction_from_delta(delta);
assert_that(&direction).is_equal_to(expected_direction);
}
}
}

View File

@@ -1,58 +1,45 @@
use bevy_ecs::{entity::Entity, system::RunSystemOnce};
use pacman::systems::{is_valid_item_collision, item_system, EntityType, GhostState, Position, ScoreResource};
use bevy_ecs::entity::Entity;
use pacman::{
events::CollisionTrigger,
systems::{EntityType, GhostState, Position, ScoreResource},
};
use speculoos::prelude::*;
mod common;
#[test]
fn test_calculate_score_for_item() {
assert!(EntityType::Pellet.score_value() < EntityType::PowerPellet.score_value());
assert!(EntityType::Pellet.score_value().is_some());
assert!(EntityType::PowerPellet.score_value().is_some());
assert!(EntityType::Player.score_value().is_none());
assert!(EntityType::Ghost.score_value().is_none());
assert_that(&(EntityType::Pellet.score_value() < EntityType::PowerPellet.score_value())).is_true();
assert_that(&EntityType::Pellet.score_value().is_some()).is_true();
assert_that(&EntityType::PowerPellet.score_value().is_some()).is_true();
assert_that(&EntityType::Player.score_value().is_none()).is_true();
assert_that(&EntityType::Ghost.score_value().is_none()).is_true();
}
#[test]
fn test_is_collectible_item() {
// Collectible
assert!(EntityType::Pellet.is_collectible());
assert!(EntityType::PowerPellet.is_collectible());
assert_that(&EntityType::Pellet.is_collectible()).is_true();
assert_that(&EntityType::PowerPellet.is_collectible()).is_true();
// Non-collectible
assert!(!EntityType::Player.is_collectible());
assert!(!EntityType::Ghost.is_collectible());
}
#[test]
fn test_is_valid_item_collision() {
// Player-item collisions should be valid
assert!(is_valid_item_collision(EntityType::Player, EntityType::Pellet));
assert!(is_valid_item_collision(EntityType::Player, EntityType::PowerPellet));
assert!(is_valid_item_collision(EntityType::Pellet, EntityType::Player));
assert!(is_valid_item_collision(EntityType::PowerPellet, EntityType::Player));
// Non-player-item collisions should be invalid
assert!(!is_valid_item_collision(EntityType::Player, EntityType::Ghost));
assert!(!is_valid_item_collision(EntityType::Ghost, EntityType::Pellet));
assert!(!is_valid_item_collision(EntityType::Pellet, EntityType::PowerPellet));
assert!(!is_valid_item_collision(EntityType::Player, EntityType::Player));
assert_that(&EntityType::Player.is_collectible()).is_false();
assert_that(&EntityType::Ghost.is_collectible()).is_false();
}
#[test]
fn test_item_system_pellet_collection() {
let mut world = common::create_test_world();
let pacman = common::spawn_test_pacman(&mut world, 0);
let (mut world, mut _schedule) = common::create_test_world();
let pellet = common::spawn_test_item(&mut world, 1, EntityType::Pellet);
// Send collision event
common::send_collision_event(&mut world, pacman, pellet);
common::trigger_collision(&mut world, CollisionTrigger::ItemCollision { item: pellet });
// Run the item system
world.run_system_once(item_system).expect("System should run successfully");
world.flush();
// Check that score was updated
let score = world.resource::<ScoreResource>();
assert_eq!(score.0, 10);
let score = world.resource_mut::<ScoreResource>();
assert_that(&score.0).is_equal_to(10);
// Check that the pellet was despawned (query should return empty)
let item_count = world
@@ -60,22 +47,21 @@ fn test_item_system_pellet_collection() {
.iter(&world)
.filter(|&entity_type| matches!(entity_type, EntityType::Pellet))
.count();
assert_eq!(item_count, 0);
assert_that(&item_count).is_equal_to(0);
}
#[test]
fn test_item_system_power_pellet_collection() {
let mut world = common::create_test_world();
let pacman = common::spawn_test_pacman(&mut world, 0);
let (mut world, mut _schedule) = common::create_test_world();
let power_pellet = common::spawn_test_item(&mut world, 1, EntityType::PowerPellet);
common::send_collision_event(&mut world, pacman, power_pellet);
common::trigger_collision(&mut world, CollisionTrigger::ItemCollision { item: power_pellet });
world.run_system_once(item_system).expect("System should run successfully");
world.flush();
// Check that score was updated with power pellet value
let score = world.resource::<ScoreResource>();
assert_eq!(score.0, 50);
assert_that(&score.0).is_equal_to(50);
// Check that the power pellet was despawned (query should return empty)
let item_count = world
@@ -83,27 +69,26 @@ fn test_item_system_power_pellet_collection() {
.iter(&world)
.filter(|&entity_type| matches!(entity_type, EntityType::PowerPellet))
.count();
assert_eq!(item_count, 0);
assert_that(&item_count).is_equal_to(0);
}
#[test]
fn test_item_system_multiple_collections() {
let mut world = common::create_test_world();
let pacman = common::spawn_test_pacman(&mut world, 0);
let (mut world, mut _schedule) = common::create_test_world();
let pellet1 = common::spawn_test_item(&mut world, 1, EntityType::Pellet);
let pellet2 = common::spawn_test_item(&mut world, 2, EntityType::Pellet);
let power_pellet = common::spawn_test_item(&mut world, 3, EntityType::PowerPellet);
// Send multiple collision events
common::send_collision_event(&mut world, pacman, pellet1);
common::send_collision_event(&mut world, pacman, pellet2);
common::send_collision_event(&mut world, pacman, power_pellet);
common::trigger_collision(&mut world, CollisionTrigger::ItemCollision { item: pellet1 });
common::trigger_collision(&mut world, CollisionTrigger::ItemCollision { item: pellet2 });
common::trigger_collision(&mut world, CollisionTrigger::ItemCollision { item: power_pellet });
world.run_system_once(item_system).expect("System should run successfully");
world.flush();
// Check final score: 2 pellets (20) + 1 power pellet (50) = 70
let score = world.resource::<ScoreResource>();
assert_eq!(score.0, 70);
assert_that(&score.0).is_equal_to(70);
// Check that all items were despawned
let pellet_count = world
@@ -116,14 +101,13 @@ fn test_item_system_multiple_collections() {
.iter(&world)
.filter(|&entity_type| matches!(entity_type, EntityType::PowerPellet))
.count();
assert_eq!(pellet_count, 0);
assert_eq!(power_pellet_count, 0);
assert_that(&pellet_count).is_equal_to(0);
assert_that(&power_pellet_count).is_equal_to(0);
}
#[test]
fn test_item_system_ignores_non_item_collisions() {
let mut world = common::create_test_world();
let pacman = common::spawn_test_pacman(&mut world, 0);
let (mut world, mut _schedule) = common::create_test_world();
// Create a ghost entity (not an item)
let ghost = world.spawn((Position::Stopped { node: 2 }, EntityType::Ghost)).id();
@@ -132,13 +116,13 @@ fn test_item_system_ignores_non_item_collisions() {
let initial_score = world.resource::<ScoreResource>().0;
// Send collision event between pacman and ghost
common::send_collision_event(&mut world, pacman, ghost);
common::trigger_collision(&mut world, CollisionTrigger::ItemCollision { item: ghost });
world.run_system_once(item_system).expect("System should run successfully");
world.flush();
// Score should remain unchanged
let score = world.resource::<ScoreResource>();
assert_eq!(score.0, initial_score);
assert_that(&score.0).is_equal_to(initial_score);
// Ghost should still exist (not despawned)
let ghost_count = world
@@ -146,74 +130,68 @@ fn test_item_system_ignores_non_item_collisions() {
.iter(&world)
.filter(|&entity_type| matches!(entity_type, EntityType::Ghost))
.count();
assert_eq!(ghost_count, 1);
assert_that(&ghost_count).is_equal_to(1);
}
#[test]
fn test_item_system_no_collision_events() {
let mut world = common::create_test_world();
let (mut world, mut _schedule) = common::create_test_world();
let _pacman = common::spawn_test_pacman(&mut world, 0);
let _pellet = common::spawn_test_item(&mut world, 1, EntityType::Pellet);
let initial_score = world.resource::<ScoreResource>().0;
// Run system without any collision events
world.run_system_once(item_system).expect("System should run successfully");
world.flush();
// Nothing should change
let score = world.resource::<ScoreResource>();
assert_eq!(score.0, initial_score);
assert_that(&score.0).is_equal_to(initial_score);
let pellet_count = world
.query::<&EntityType>()
.iter(&world)
.filter(|&entity_type| matches!(entity_type, EntityType::Pellet))
.count();
assert_eq!(pellet_count, 1);
assert_that(&pellet_count).is_equal_to(1);
}
#[test]
fn test_item_system_collision_with_missing_entity() {
let mut world = common::create_test_world();
let pacman = common::spawn_test_pacman(&mut world, 0);
let (mut world, mut _schedule) = common::create_test_world();
// Create a fake entity ID that doesn't exist
let fake_entity = Entity::from_raw(999);
common::send_collision_event(&mut world, pacman, fake_entity);
common::trigger_collision(&mut world, CollisionTrigger::ItemCollision { item: fake_entity });
// System should handle gracefully and not crash
world
.run_system_once(item_system)
.expect("System should handle missing entities gracefully");
world.flush();
// Score should remain unchanged
let score = world.resource::<ScoreResource>();
assert_eq!(score.0, 0);
assert_that(&score.0).is_equal_to(0);
}
#[test]
fn test_item_system_preserves_existing_score() {
let mut world = common::create_test_world();
let (mut world, mut _schedule) = common::create_test_world();
// Set initial score
world.insert_resource(ScoreResource(100));
let pacman = common::spawn_test_pacman(&mut world, 0);
let pellet = common::spawn_test_item(&mut world, 1, EntityType::Pellet);
common::send_collision_event(&mut world, pacman, pellet);
common::trigger_collision(&mut world, CollisionTrigger::ItemCollision { item: pellet });
world.run_system_once(item_system).expect("System should run successfully");
world.flush();
// Score should be initial + pellet value
let score = world.resource::<ScoreResource>();
assert_eq!(score.0, 110);
assert_that(&score.0).is_equal_to(110);
}
#[test]
fn test_power_pellet_does_not_affect_ghosts_in_eyes_state() {
let mut world = common::create_test_world();
let pacman = common::spawn_test_pacman(&mut world, 0);
let (mut world, mut _schedule) = common::create_test_world();
let power_pellet = common::spawn_test_item(&mut world, 1, EntityType::PowerPellet);
// Spawn a ghost in Eyes state (returning to ghost house)
@@ -222,13 +200,13 @@ fn test_power_pellet_does_not_affect_ghosts_in_eyes_state() {
// Spawn a ghost in Normal state
let normal_ghost = common::spawn_test_ghost(&mut world, 3, GhostState::Normal);
common::send_collision_event(&mut world, pacman, power_pellet);
common::trigger_collision(&mut world, CollisionTrigger::ItemCollision { item: power_pellet });
world.run_system_once(item_system).expect("System should run successfully");
world.flush();
// Check that the power pellet was collected and score updated
let score = world.resource::<ScoreResource>();
assert_eq!(score.0, 50);
assert_that(&score.0).is_equal_to(50);
// Check that the power pellet was despawned
let power_pellet_count = world
@@ -236,13 +214,13 @@ fn test_power_pellet_does_not_affect_ghosts_in_eyes_state() {
.iter(&world)
.filter(|&entity_type| matches!(entity_type, EntityType::PowerPellet))
.count();
assert_eq!(power_pellet_count, 0);
assert_that(&power_pellet_count).is_equal_to(0);
// Check that the Eyes ghost state was not changed
let eyes_ghost_state = world.entity(eyes_ghost).get::<GhostState>().unwrap();
assert!(matches!(*eyes_ghost_state, GhostState::Eyes));
assert_that(&matches!(*eyes_ghost_state, GhostState::Eyes)).is_true();
// Check that the Normal ghost state was changed to Frightened
let normal_ghost_state = world.entity(normal_ghost).get::<GhostState>().unwrap();
assert!(matches!(*normal_ghost_state, GhostState::Frightened { .. }));
assert_that(&matches!(*normal_ghost_state, GhostState::Frightened { .. })).is_true();
}

Some files were not shown because too many files have changed in this diff Show More