breakhack/README.md

69 lines
3.6 KiB
Markdown
Raw Normal View History

2018-10-02 23:27:24 +02:00
[![Build Status](https://travis-ci.org/Oliveshark/breakhack.svg?branch=master)](https://travis-ci.org/Oliveshark/breakhack)
2018-10-02 23:34:02 +02:00
[![Build status](https://ci.appveyor.com/api/projects/status/2a18npdntkmlx3dc?svg=true)](https://ci.appveyor.com/project/LiquidityC/breakhack)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/fc02d56fa7194e61b2c7d260fd2e4186)](https://www.codacy.com/app/LiquidityC/breakhack?utm_source=github.com&utm_medium=referral&utm_content=Oliveshark/breakhack&utm_campaign=Badge_Grade)
[![CodeFactor](https://www.codefactor.io/repository/github/oliveshark/breakhack/badge/dev)](https://www.codefactor.io/repository/github/oliveshark/breakhack/overview/master)
2018-10-02 23:27:24 +02:00
<!--[![Coverity Scan](https://scan.coverity.com/projects/15218/badge.svg)](https://scan.coverity.com/projects/oliveshark-breakhack)-->
[![GitHub issues](https://img.shields.io/github/issues/oliveshark/breakhack.svg)](https://github.com/oliveshark/breakhack/issues)
[![GitHub closed issues](https://img.shields.io/github/issues-closed/oliveshark/breakhack.svg)](https://github.com/oliveshark/breakhack/issues)
![GitHub (pre-)release](https://img.shields.io/github/release/oliveshark/breakhack/all.svg)
[![Github All Releases](https://img.shields.io/github/downloads/oliveshark/breakhack/total.svg)](https://github.com/oliveshark/breakhack/releases)
[![HitCount](http://hits.dwyl.io/oliveshark/breakhack.svg)](http://hits.dwyl.io/oliveshark/breakhack)
2017-12-01 00:01:51 +01:00
2018-08-05 13:00:32 +02:00
Something in the ways of a roguelike
2017-11-30 21:00:47 +01:00
================================
2018-08-05 13:00:32 +02:00
A simple roguelike written in C using SDL2.
2017-11-30 21:00:47 +01:00
Idea
----
Randomly generated maps/rooms. Leveling system, permadeath,
2018-03-25 23:57:28 +02:00
multiple classes. Casual and fun for 10-20 minutes during a break
2017-11-30 21:00:47 +01:00
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.
2018-03-25 23:57:28 +02:00
2018-08-28 16:23:39 +02:00
Download
2018-09-14 08:47:41 +02:00
--------
2018-08-28 16:23:39 +02:00
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.
2018-03-25 23:57:28 +02:00
2018-09-14 08:47:41 +02:00
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.
2018-10-02 23:27:24 +02:00
- The source code is released under [GPLv3](https://github.com/oliveshark/breakhack/blob/master/LICENSE.txt)
2018-09-14 08:47:41 +02:00
- The Steam release is released under the [Steam subscriber agreement](https://store.steampowered.com/subscriber_agreement/)
Compile
-------
2019-04-23 16:06:20 +02:00
* [Linux](LINUX_BUILD_INSTRUCTIONS.md)
* [Windows (Visual Studio)](MSVC_BUILD_INSTRUCTIONS.md)
2019-04-21 08:24:47 +02:00
2018-03-25 23:57:28 +02:00
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).
2018-10-10 23:40:36 +02:00
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.
2018-03-25 23:57:28 +02:00
Links
-----
2018-10-02 23:27:24 +02:00
- [Itch.io](https://store.steampowered.com/app/931040/BreakHack/)
- [Steam](https://liquidityc.itch.io/breakhack)