95 lines
4.8 KiB
Markdown
95 lines
4.8 KiB
Markdown
[](https://travis-ci.org/Oliveshark/breakhack)
|
|
[](https://ci.appveyor.com/project/LiquidityC/breakhack)
|
|
[](https://www.codacy.com/app/LiquidityC/breakhack?utm_source=github.com&utm_medium=referral&utm_content=Oliveshark/breakhack&utm_campaign=Badge_Grade)
|
|
[](https://www.codefactor.io/repository/github/oliveshark/breakhack/overview/master)
|
|
<!--[](https://scan.coverity.com/projects/oliveshark-breakhack)-->
|
|
[](https://github.com/oliveshark/breakhack/issues)
|
|
[](https://github.com/oliveshark/breakhack/issues)
|
|
|
|
[](https://github.com/oliveshark/breakhack/releases)
|
|
[](http://hits.dwyl.io/oliveshark/breakhack)
|
|
|
|
Something in the ways of a roguelike
|
|
================================
|
|
|
|
A simple roguelike written in C using SDL2.
|
|
|
|
Idea
|
|
----
|
|
Randomly generated maps/rooms. Leveling system, permadeath,
|
|
multiple classes. Casual and fun for 10-20 minutes during a break
|
|
from regular work/play.
|
|
|
|
I wanted to practice C and I'm comfortable using SDL2. The assets
|
|
are graciously taken from the web. More info in the README in the
|
|
assets folder.
|
|
|
|
Download
|
|
--------
|
|
This game is available in the [steam store](https://store.steampowered.com/app/931040/BreakHack/) (release Okt 2018).
|
|
If you enjoy the game and want a properly installed, signed copy of the game with achievements and
|
|
global highscores you are most welcome to purchase it there.
|
|
If you feel like getting a free copy you can download and compile from here.
|
|
|
|
Issues
|
|
------
|
|
I'd prefer if issues could be handled here on github. Either check the list if your particular problem is reported
|
|
otherwise create a new issue. Support questions can be submitted as issues as well, I haven't figured out how I want to
|
|
work with support yet since I haven't received any questions.
|
|
|
|
License
|
|
-------
|
|
BreakHack is released under two different licenses.
|
|
|
|
- The source code is released under [GPLv3](https://github.com/oliveshark/breakhack/blob/master/LICENSE.txt)
|
|
- The Steam release is released under the [Steam subscriber agreement](https://store.steampowered.com/subscriber_agreement/)
|
|
|
|
Compile
|
|
-------
|
|
Apart from basic compile tools (*GCC/Clang, Make*) you'll also need to install **sdl2, sdl2-image, sdl2-ttf, sdl2-mixer** (If on a debian based dist you need to install the *dev* packages).
|
|
Optionally you can also install **cppcheck** and **physfs**
|
|
|
|
Once that is done run the following:
|
|
```bash
|
|
mkdir _build
|
|
cd _build
|
|
cmake -DCMAKE_BUILD_TYPE=Debug .. # Build type flag is optional
|
|
make
|
|
```
|
|
|
|
Compile on Windows
|
|
------------------
|
|
|
|
1. Install [Visual Studio Community 2019](https://visualstudio.microsoft.com/vs/community/) with the "Desktop development with C++" workload
|
|
2. Install [CMake](https://cmake.org/download/)
|
|
3. Install [NSIS](https://nsis.sourceforge.io/Download)
|
|
4. Download and unzip [SDL2-devel-2.x.x-VC.zip](https://www.libsdl.org/download-2.0.php), [SDL2_image-devel-2.x.x-VC.zip](https://www.libsdl.org/projects/SDL_image/), [SDL2_mixer-devel-2.x.x-VC.zip](https://www.libsdl.org/projects/SDL_mixer/), [SDL2_ttf-devel-2.x.x-VC.zip](https://www.libsdl.org/projects/SDL_ttf/)
|
|
5. Open Developer Command Prompt for VS 2019 and run the following, substituting paths as appropriate:
|
|
```batch
|
|
cd C:\repos\breakhack
|
|
SET SDL2DIR=C:/SDL2/SDL2-2.0.9
|
|
SET SDL2MIXERDIR=C:/SDL2/SDL2_mixer-2.0.4
|
|
SET SDL2_IMAGE=C:/SDL2/SDL2_image-2.0.4
|
|
SET SDLTTFDIR=C:/SDL2/SDL2_ttf-2.0.15
|
|
cmake .
|
|
cmake --build . --target package --config Release
|
|
```
|
|
|
|
Contribute
|
|
----------
|
|
Have an idea and able to implement it? Fork and send me a pull request and
|
|
I'll check it out. If I like it I will add it. If it's a big thing I'll add
|
|
your name to the credits list (once I add it in game).
|
|
|
|
If you do contribute something you should be aware that if your PR is merged
|
|
into the master code-base your code will eventually make it out with the Steam version
|
|
of the game. I don't make any revenue from those sales so don't expect any other compensation
|
|
than a "I have code on Steam" feeling. Which is quite nice and also why I decided to release
|
|
on Steam.
|
|
|
|
Links
|
|
-----
|
|
|
|
- [Itch.io](https://store.steampowered.com/app/931040/BreakHack/)
|
|
- [Steam](https://liquidityc.itch.io/breakhack)
|