streuner-game/README.md

75 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2016-06-20 17:28:56 +00:00
[![build status](https://gitlab.com/thallian/streuner-game/badges/master/build.svg)](https://gitlab.com/thallian/streuner-game/commits/master)
2015-08-20 14:55:45 +00:00
# A Game About a Band
And this band is called [Die Streuner](http://www.streuner.de/) ([*The Strays*](https://en.wikipedia.org/wiki/Die_Streuner) in English).
I am a big fan ever since I've discovered them in 2007 and I had the opportunity to get to know the different people better over the years.
2016-06-24 07:29:02 +00:00
So why not try and create a little game about them and at the same time learn a bit about game development.
Maybe I'll even manage to create a playable version.
2015-08-20 14:55:45 +00:00
At the moment it is more of a very simple techdemo but I hope to change that in the near future.
In the meantime take a moment to listen to the music of *Die Streuner*:
- [Gotta get it Home (Live)](https://www.youtube.com/watch?v=kNxE7Jxk1DY)
- [Scherenschleiferweise (Knife Grinder's Tune)](https://www.youtube.com/watch?v=Zo7Ckd1Lrmo)
2015-08-20 15:24:02 +00:00
![Screenshot](screenshot.png)
2015-08-20 15:23:26 +00:00
2016-06-21 12:57:55 +00:00
# Usage
2016-06-20 17:23:40 +00:00
Use arrow keys for movement and enter to get rid of dialogs (for movement w, a, s, d & h, j, k, l works too).
2016-06-21 12:57:55 +00:00
# Downloads
2016-06-20 17:25:13 +00:00
You can download the automatic builds from the [Pipeline](https://gitlab.com/thallian/streuner-game/pipelines) section.
2016-06-21 12:57:55 +00:00
# Building
2016-06-21 12:56:31 +00:00
You can either build it locally (mostly for development) or with docker (for distribution).
2016-06-21 12:57:55 +00:00
## Local Building
### Prerequisites
2015-08-20 14:55:45 +00:00
- [Löve](https://love2d.org/)
2016-06-21 12:56:31 +00:00
- make
- zip
- kill
- grep
- awk
- ps
2015-08-20 14:55:45 +00:00
2016-06-21 12:57:55 +00:00
### Usage
2015-08-20 14:55:45 +00:00
```
make run
```
2016-06-21 12:57:55 +00:00
## Docker Building
2016-06-21 12:56:31 +00:00
Uses [docker](https://hub.docker.com/r/thallian/love-release/) with [love-release](https://github.com/MisterDA/love-release) to build the different OS packages.
2016-06-21 12:57:55 +00:00
### Prerequisites
2016-06-20 17:23:40 +00:00
- [Docker](https://www.docker.com/)
2016-06-21 12:56:31 +00:00
- make
2016-06-20 17:23:40 +00:00
2016-06-21 12:57:55 +00:00
### Usage
2016-06-20 17:23:40 +00:00
```
make docker
```
Or you can look up the exact command in the [Makefile](Makefile)
2015-08-20 15:02:09 +00:00
2015-08-20 15:20:38 +00:00
# Licensation
All original code is licensed under the [MPL 2.0](https://www.mozilla.org/MPL/2.0/index.txt).
2016-06-21 12:57:55 +00:00
# Libraries
2015-08-20 15:20:38 +00:00
- [30log](https://github.com/Yonaba/30log): [MIT](http://opensource.org/licenses/mit-license.php)
- [anim8](https://github.com/kikito/anim8): [MIT](http://opensource.org/licenses/mit-license.php)
2016-03-15 12:41:39 +00:00
- [bump](https://github.com/kikito/bump.lua): [MIT](http://opensource.org/licenses/mit-license.php)
2015-08-20 15:20:38 +00:00
- [sti](https://github.com/karai17/Simple-Tiled-Implementation): [MIT](http://opensource.org/licenses/mit-license.php)
The tiles and character images are from the [liberated pixel cup](http://lpc.opengameart.org/) and are under a [cc-by.sa 3.0](http://creativecommons.org/licenses/by-sa/3.0/) license.
2016-06-22 07:51:23 +00:00
# History
I started a first version of this in ~2008 with the [RPG Maker](http://www.rpgmakerweb.com/) (no idea which version), back when I had even less an idea of software development than today :)
2016-06-22 07:53:12 +00:00
The only thing surviving is the following screenshot:
2016-06-22 07:51:23 +00:00
2016-06-22 07:52:11 +00:00
![history](history.jpg)