diff --git a/README.md b/README.md index 8f5c3d3..f35b008 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,56 @@ # TINS 2020 +## Content + +- [Introduction](##Introduction) +- [Additional Rules](##Additional-Rules) + * [Implementation](###Implementation) + * [Definition](###Definition) +- [Building](##Building) +- [Sources](##Sources) +- [Licenses (third party)](##Licenses) + * [Go-SDL2](###Go-SDL2) + * [SDL 2.0](###SDL-2.0) + * [Fira Mono font](###Fira-Mono-font) + * [Open Sans font](###Open-Sans-font) + +## Introduction + +**Welcome to Botanim!** + +In Botanim you play the role of botanist and your goal is to cultivate flowers in an open landscape. + +Flowers can only grow (well) in certain climates based on two properties: humidity and temperature. Watch out for existing vegetation to get an idea how humid the land is and check the appearance of the tile to see how hot it is. When well placed your planted flower will spread soon but an odd choice might kill your flower almost instantly. So choose carefully. When the flower spread significantly you can dig up flowers again to collect more money. + +**Controls:** + - D: Selects shovel + - R: Selects research + - Spacebar: pauses game + - 1: runs game at normal speed + - 2: runs game extra fast + - Mouse wheel or plus/minus: zooms landscape + - CTRL + left mouse button or middle mouse button: pans landscape + +Have fun playing! + ## Additional Rules +### Implementation + +**genre rule #130** +This rule is the most obvious. The goal of the game is to grow flowers so given enough time and a bit of luck your screen will be full of flowers. + +**artistical rule #60** +The least obvious and not finished within the time contraint: when researching you'll have to dial a phone number like you used to do with an old rotary dial (works by repeating the number on the keyboard an exact number of times). + +**technical rule #10** +The terrain is based on (several: humidity, temperature, placement of props, variants of props) perlin noise functions. + +**technical rule #68** +The description of the flowers will scroll below the icon of the "buy flower" buttons when hovered. + +### Definition + ### Genre requirement **** There will be 1 genre rule @@ -15,7 +64,7 @@ Comments: This rule just reminds me of my favourite platformer, Super Mario Worl **artistical rule #60** make fun of old-fashioned things. -Comments:E.g. have a mode in which the game plays in black and white, featuring an old granny in the corner saying "I didn't pay my colour television license for this", or occasionally "I was in a war" Some more inspirations [here](https://www.youtube.com/watch?v=67OPI3cXAaE) and [here](https://twitter.com/Bill_Gross/status/920406104911233024) +Comments: e.g. have a mode in which the game plays in black and white, featuring an old granny in the corner saying "I didn't pay my colour television license for this", or occasionally "I was in a war" Some more inspirations [here](https://www.youtube.com/watch?v=67OPI3cXAaE) and [here](https://twitter.com/Bill_Gross/status/920406104911233024) ### Technical requirement **** There will be 2 technical rules @@ -45,16 +94,22 @@ Comments: Lots of wiggle room here. For example, you could revert the last techn ## Building Prerequisites: -- [SDL 2.0](https://www.libsdl.org/) (SDL2, SDL2_image, SDL2_ttf and SDL2_gfx development libraries are required). +- [SDL 2.0](https://www.libsdl.org/) (SDL2, SDL2_image, SDL2_ttf and SDL2_gfx development libraries are required; for [more information](https://github.com/veandco/go-sdl2)). - [Go](https://golang.org/dl/) 1.12 or later. -- GCC. -- Git. +- GCC or a compatible compiler. +- [Git](https://git-scm.com/download). With all prequisites installed you can run: ``` go get -u opslag.de/schobers/tins2020/cmd/tins2020 ``` +This will create the binary `$HOME/go/bin/tins2020`. Additionally you can embed the resources and build a static release with the following commands (this assumes `$HOME/go/bin` is available in the `PATH`): +``` +go generate opslag.de/schobers/tins2020/cmd/tins2020 +go install opslag.de/schobers/tins2020/cmd/tins2020 -tags static -ldflags "-s -w" +``` + ## Sources Can be found at https://opslag.de/schobers/tins2020 (Git repository).