GoFerari v1.0.0-v2.0.0

.github/workflows/ci.yml

@@ -46,7 +46,7 @@ jobs:
       run: cargo install cargo-tarpaulin
 
     - name: Generate coverage
-      run: cargo tarpaulin --verbose --workspace --out Lcov --output-dir ./coverage
+      run: cargo tarpaulin --verbose --workspace --out Lcov --output-dir ./coverage --exclude-files "game/src/main.rs"
 
     - name: Upload coverage
       uses: codecov/codecov-action@v3

Cargo.toml

@@ -1,18 +1,3 @@
-[package]
-name = "ferari"
-version = "0.1.0"
-edition = "2021"
-description = "Fast Engine for Rendering Axonometric Rust-based Isometry"
-authors = ["Rodion Suvorov <rodion.suvorov.94@mail.ru>, Ilhom Kombaev <kombaev02@gmail.com>, Vyacheslav Kochergin <vyacheslav.kochergin1@gmail.com>, Dmitri Kuznetsov <dmitrvlkuznetsov@gmail.com>"]
-license = "MIT"
-repository = "https://github.com/suvorovrain/Ferari"
-readme = "README.md"
-
-[dependencies]
-minifb = "0.28"
-serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0"
-image = "0.25"
-crossbeam-channel = "0.5.15"
-
-[dev-dependencies]
+[workspace]
+members = ["engine", "game"]
+resolver = "2"

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Rodion Suvorov, Ilhom Kombaev, Vyacheslav Kochergin, Dmitri Kuznetsov
+Copyright (c) 2025 21pack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,20 +1,52 @@
-# Ferari
-![CI Status](https://github.com/suvorovrain/Ferari/actions/workflows/ci.yml/badge.svg)
+# GoFerari
+
+![CI Status](https://github.com/21pack/GoFerari/actions/workflows/ci.yml/badge.svg)
+
+Game on [Ferari](https://github.com/suvorovrain/Ferari) (Fast Engine for Rendering Axonometric Rust-based Isometry).
+
+Currently, x86_64 Linux and ARM64 macOS platforms are supported.
+
+![demo](/demo.gif)
 
-Fast Engine for Rendering Axonometric Rust-based Isometry.
 ## Description
-An isometric engine that allows you to create simple games with static objects and mobs.
-## Authors
-* Rodion Suvorov. [GitHub](https://github.com/suvorovrain), [Contact](https://t.me/suvorovrain).
-* Ilhom Kombaev. [GitHub](https://github.com/homka122), [Contact](https://t.me/homka122).
-* Vyacheslav Kochergin. [GitHub](https://github.com/VyacheslavIurevich), [Contact](https://t.me/se4life).
-* Dmitri Kuznetsov. [GitHub](https://github.com/f1i3g3), [Contact](https://t.me/f1i3g3).
-## Platforms
-Currently, x86_64 Linux and Windows platforms are supported
+
+An isometric game in puzzle genre such as [Sokoban](https://en.wikipedia.org/wiki/Sokoban). The aim of the game is to get the boxes onto storage locations.
+
+### Mechanics
+
+* Player: You control the worker. Move up, down, left, or right.
+* Boxes: Push the boxes, one at a time. You cannot pull them or push two boxes at once.
+* Walls: Solid grey blocks form the immovable barriers. They confine your and boxes movement.
+* Target Docks: Indented floor tiles mark the delivery targets where the boxes must be placed.
+* Box States:
+  * Light Box: A box that is not yet on a target.
+  * Dark Box: A box that has been successfully pushed onto a target dock.
+
 ## Usage
-* Download release archive from GitHub releases page
-* Put your custom map information into `input.json` file in the root of unpacked archive, according format from example in the root of repository
+
+### Install
+
+* Download release archive from GitHub releases page.
+* Clone and build this repo.
+
+### Play
+
+```shell
+./play.sh
+```
+
+### Control
+
+The player moves on a grid-based system with fixed-direction controls. This means each key consistently moves the character in one cardinal direction, regardless of the on-screen perspective.
+
+* `WASD` or `arrow control`: movement;
+* `<-`(`A`) + `->`(`D`): go to menu;
+* `esc`: close game.
+
 ## Dependencies
+
+### Linux
+
 ```shell
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 sudo apt install cargo
@@ -23,23 +55,29 @@ rustup component add rustfmt
 rustup component add clippy
 cargo install cargo-tarpaulin
 ```
-## Development
+
+### macOS
+
+```shell
+brew install rustup
+rustup-init
+```
+
+## Development (Ferari)
+
 * See [CONTRIBUTING.md](./CONTRIBUTING.md)
-* Compile & run via `cargo run`
+* Compile & run game via `cargo run -p game --release`
 * View docs via `cargo doc` (use  --document-private-items if you want)
 * Format your code via `cargo fmt`
 * Everything else - in CI
 
-## Benchmark
-
-### Machine info:
-OS: Kubuntu 24.04
-CPU: Intel Core i7-12700H
-RAM: 16 GB
-| Mobs Count | Average FPS |
-|-------------|-------------|
-| 500         |    40       |
-| 5000         |       15      |
-| 10000        |      10       |
-| 100000        |      4       |
-| 1000000        |      0.7       |
+## Authors
+
+* **Maxim Rodionov:** [GitHub](https://github.com/RodionovMaxim05), [Telegram](https://t.me/Maxoon22)
+* **Dmitri Chirkov:** [GitHub](https://github.com/kinokotakenoko9), [Telegram](https://t.me/chdmitri)
+* **Nikita Shchutskii:** [GitHub](https://github.com/ns-58), [Telegram](https://t.me/szcz00)
+* **Vladimir Zaikin:** [GitHub](https://github.com/Friend-zva), [Telegram](https://t.me/vo_va_w)
+
+## License
+
+Distributed under the [MIT License](https://choosealicense.com/licenses/mit/). See [`LICENSE`](LICENSE) for more information.

assets/assetsgen.py

@@ -0,0 +1,109 @@
+from PIL import Image
+import json
+
+
+SIZE_TILE = 256
+
+
+def create_scaled_atlas_alphabet(atlas_path, json_data, output_path, scale=4):
+    atlas = Image.open(atlas_path)
+    with open(json_data, "r") as f:
+        data_tiles = json.load(f)
+
+    tile_size = data_tiles["meta"]["tile_size"]
+    tile_size_new = tile_size * scale
+
+    width_new, height_new = SIZE_TILE * 4, SIZE_TILE * 9
+    atlas_new = Image.new("RGBA", (width_new, height_new))
+
+    tiles_data_new = {}
+    tiles_data_new["frames"] = {}
+    tiles_data_new["meta"] = {
+        "image": "atlas_x2.png",
+        "tile_size": SIZE_TILE,
+        "version": 1,
+    }
+
+    for i, (tile_name, coords) in enumerate(data_tiles["frames"].items()):
+        x, y, w, h = coords["x"], coords["y"], coords["w"], coords["h"]
+        tile = atlas.crop((x, y, x + w, y + h))
+
+        resized_tile = tile.resize(
+            (tile_size_new, tile_size_new), Image.Resampling.NEAREST
+        )
+
+        col, row = i % 4, i // 4
+        x_new = col * SIZE_TILE + 60
+        y_new = row * SIZE_TILE + 20
+
+        atlas_new.paste(resized_tile, (x_new, y_new))
+
+        tiles_data_new["frames"][tile_name] = {
+            "x": col * SIZE_TILE,
+            "y": row * SIZE_TILE,
+            "w": SIZE_TILE,
+            "h": SIZE_TILE,
+        }
+
+    atlas_new.save(output_path)
+
+    new_json_path = output_path.replace(".png", ".json")
+    with open(new_json_path, "w") as f:
+        json.dump(tiles_data_new, f, indent=2)
+
+
+def create_atlas_ground(atlas_path, json_data, output_path):
+    atlas = Image.open(atlas_path)
+    with open(json_data, "r") as f:
+        data_tiles = json.load(f)
+
+    tile_size = data_tiles["meta"]["tile_size"]
+
+    width_new, height_new = tile_size * 4, tile_size * 2
+    atlas_new = Image.new("RGBA", (width_new, height_new))
+
+    tiles_data_new = {}
+    tiles_data_new["frames"] = {}
+    tiles_data_new["meta"] = {
+        "image": "atlas_x2.png",
+        "tile_size": SIZE_TILE,
+        "version": 1,
+    }
+
+    for i, (tile_name, coords) in enumerate(data_tiles["frames"].items()):
+        x, y, w, h = coords["x"], coords["y"], coords["w"], coords["h"]
+        tile = atlas.crop((x, y, x + w, y + h))
+
+        resized_tile = tile
+
+        col, row = i % 4, i // 4
+        x_new = col * SIZE_TILE
+        y_new = row * SIZE_TILE
+
+        tile_size_new = SIZE_TILE
+
+        if tile_name == "wall_tile":
+            x_new += 22
+            y_new -= 14
+            tile_size_new = tile_size - 48
+            resized_tile = tile.resize(
+                (tile_size_new, tile_size_new), Image.Resampling.NEAREST
+            )
+
+        atlas_new.paste(resized_tile, (x_new, y_new))
+
+        tiles_data_new["frames"][tile_name] = {
+            "x": col * SIZE_TILE,
+            "y": row * SIZE_TILE,
+            "w": SIZE_TILE,
+            "h": SIZE_TILE,
+        }
+
+    atlas_new.save(output_path)
+
+    new_json_path = output_path.replace(".png", ".json")
+    with open(new_json_path, "w") as f:
+        json.dump(tiles_data_new, f, indent=2)
+
+
+create_atlas_ground("assets/atlas.png", "assets/atlas.json", "assets/atlas_x2.png")