From 04d2feb86e174861ee8454346f3aaa10b4263b28 Mon Sep 17 00:00:00 2001 From: Sofia Date: Fri, 31 Jul 2026 00:15:22 +0300 Subject: [PATCH] Add readme --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e1ce3e1 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# SkullBall + +SkullBall is a boomer-shooter with the additional flavour of American Football +in the sense that in the middle of the map there is a ball which you must carry +to the opposing team's goal in order to win. + +In SkullBall additionally you have two weapons: The reliable Raygun, and the +Shotgun. No other weapons are planned at the moment. Additionally you're able to +punch with melee, and throw a telegrenade, which teleports you to the place +where it collided (or where it was when you re-activated the telegrenade using +the same button). + +## Itch.io +Pre-built binaries for running this game directly can be bought from +[itch.io](https://teascade.itch.io/skullball), but you are free to compile this +project yourself if you really want a free copy. + +## Compiling +As mentioned above, you're free to compile this project yourself if you want, +although purchases at the itch.io page are greatly appreciated! + +Some dependencies for building this project are: +- Rust Compiler 1.97 or higher +- Godot 4.7 or higher + +Then in order to compile the project you will need some additional assets for +sound effects, which are not included in this repository due to some of them +having licensing restrictions to redistribute them as-is. These are not +absolutely necessary, but should be placed under `godot/raw_assets/sfx`. + +Finally, in order to compile this project: +1. Enter the project root folder +2. Run `cargo build --release` +3. Open the project in Godot +4. Build! + +## Credits + +SkullBall was developed by [Teascade](https://teascade.net), with +[neon](https://neon.moe/) doing level design. + +Many assets have also been used externally, credits for which can be found in +[credits.toml](./credits.toml) (or in-game via the Credits-menu). \ No newline at end of file