11[ ![ maintenance] ( https://img.shields.io/badge/maintenance-passively--maintained-orange )] ( https://img.shields.io/badge/maintenance-passively--maintained-orange )
22[ ![ CMake on multiple platforms] ( https://github.com/Oliveshark/breakhack/actions/workflows/cmake-multi-platform.yml/badge.svg )] ( https://github.com/Oliveshark/breakhack/actions/workflows/cmake-multi-platform.yml )
33
4- Something in the ways of a roguelike
5- ================================
4+ ![ ] ( header.jpg )
65
7- A simple roguelike written in C using SDL2.
6+ ---
7+
8+ A simple roguelike written in C using SDL
9+
10+ ## Idea
811
9- Idea
10- ----
1112Randomly generated maps/rooms. Leveling system, permadeath,
1213multiple classes. Casual and fun for 10-20 minutes during a break
1314from regular work/play.
@@ -16,35 +17,41 @@ I wanted to practice C and I'm comfortable using SDL2. The assets
1617are graciously taken from the web. More info in the README in the
1718assets folder.
1819
19- Download
20- --------
20+ ## Download
21+
2122This game is available in the [ steam store] ( https://store.steampowered.com/app/931040/BreakHack/ ) (release Okt 2018).
2223If you enjoy the game and want a properly installed, signed copy of the game with achievements and
2324global highscores you are most welcome to purchase it there.
2425If you feel like getting a free copy you can download and compile from here.
2526
26- Issues
27- ------
27+ ## Issues
28+
2829I'd prefer if issues could be handled here on github. Either check the list if your particular problem is reported
2930otherwise create a new issue. Support questions can be submitted as issues as well, I haven't figured out how I want to
3031work with support yet since I haven't received any questions.
3132
32- License
33- -------
33+ ## License
34+
3435BreakHack is released under two different licenses.
3536
3637- The source code is released under [ GPLv3] ( https://github.com/oliveshark/breakhack/blob/master/LICENSE.txt )
3738- The Steam release is released under the [ Steam subscriber agreement] ( https://store.steampowered.com/subscriber_agreement/ )
3839
39- Compile
40- -------
41- * [ Linux] ( LINUX_BUILD_INSTRUCTIONS.md )
42- * [ Windows (Visual Studio)] ( MSVC_BUILD_INSTRUCTIONS.md )
40+ ## Compiling
41+
42+ 1 . Ensure you have build tools installed. Git, gcc/clang, make/ninja, cmake.
43+ 2 . Checkout the repository (recursive): ` git clone --recursive https://github.com/oliveshark/breakhack `
44+ 3 . Prepare build dir with cmake: ` cmake -B build . `
45+ 4 . Build the project: ` cmake --build build `
46+
47+ Naturally if you have some experience with cmake you can configure and setup
48+ the build as you like. The above should be enough for anyone to copy/paste and
49+ get things running.
50+
51+ ## Contribute
4352
44- Contribute
45- ----------
4653Have an idea and able to implement it? Fork and send me a pull request and
47- I'll check it out. If I like it I will add it. If it's a big thing I'll add
54+ I'll check it out. If I like it I will add it. If it's a big thing I'll add
4855your name to the credits list (once I add it in game).
4956
5057If you do contribute something you should be aware that if your PR is merged
@@ -53,8 +60,7 @@ of the game. I don't make any revenue from those sales so don't expect any other
5360than a "I have code on Steam" feeling. Which is quite nice and also why I decided to release
5461on Steam.
5562
56- Links
57- -----
63+ ## Links
5864
5965- [ Steam] ( https://store.steampowered.com/app/931040/BreakHack/ )
6066- [ Itch.io] ( https://liquidityc.itch.io/breakhack )
0 commit comments