diff --git a/README.md b/README.md index d37b2b7..0bc6190 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,25 @@ A memory like game which does allow you to side load custom decks. This game was developed as a hobby, mostly for my son. But feel free to test it out. The game can be played alone vs the AI or you can play against human players in a local coop mode. -The game is shipped with a build in deck, no need to create a custom one. +![game-image] -If you want to give it a try check it out on [Itch.io][itch-io]. You could also download the latest build on GitHub if you wish. +The game is shipped with some build in deck, no need to create a custom one. -## Installation from GitHub +If you want to give it a try check it out on [Itch.io][itch-io]. It is playable in your web browser +or you could download the latest build on Itch/GitHub if you like. + +## Installation + +### GitHub If you do want to download the game from GitHub go to [release][latest-release] page and download the zip file for your system. Unzip the content to your machine into an directory. Open up that directory and execute the `samory` binary. +### Itch.io + +I would recommend to install the game via the [Itch App][itch-app]. This does allow you to let the game be managed by the itch app. +The app also does allow to download older versions if you wish. +Otherwise if you download the zip files the installation is identical to the one on GitHub, the binaries are identical per version. + ### Arch Linux If you are on Arch you can get the game via the AUR. To do so head over to [samory-bin][samory-aur] or if you do have `yay` installed run @@ -29,14 +40,14 @@ yay samory-bin ### Requirements -- [Godot 4.4][godot4_4] +- [Godot 4.6][godot4_6] ### How to build the project -To build the project clone the repository to yout machine. After cloing start Godot and open the `project.godot` file. Use the -import button inside of the Godot project overview to do so. +To build the project clone the repository to your machine. After cloning start Godot and open the `project.godot` file. +Use the import button inside of the Godot project overview to do so. -Now you should be able to run the game by starting the debug. +Now you should be able to run the game by starting the debug. ## Special Thanks @@ -56,7 +67,8 @@ All assets contained inside of the [Axuree directory][axuree-directory] are lice [itch-io]: https://xanatos.itch.io/samory -[godot4_4]: https://godotengine.org/download/archive/4.4-stable/ +[itch-app]: https://itch.io/app +[godot4_6]: https://godotengine.org/download/archive/4.6-stable/ [latest-release]: https://github.com/D-Generation-S/Samory/releases/latest [samory-aur]: https://aur.archlinux.org/packages/samory-bin [kenney]: https://www.kenney.nl/ @@ -66,3 +78,4 @@ All assets contained inside of the [Axuree directory][axuree-directory] are lice [music]: https://tallbeard.itch.io/music-loop-bundle [license-code]: ./LICENSE +[game-image]: https://i.imgur.com/KGBoemJ.png \ No newline at end of file