410 lines
20 KiB
Markdown
410 lines
20 KiB
Markdown
# TINS 2021
|
||
|
||
## Content
|
||
|
||
- [Introduction](#introduction)
|
||
- [Additional Rules](#additional-rules)
|
||
* [Implementation](#implementation)
|
||
* [Definition](#definition)
|
||
- [Building](#building)
|
||
* [Using Allegro](#using-allegro)
|
||
- [Sources](#sources)
|
||
- [Licenses (third party)](#licenses)
|
||
* [Go-SDL2](#go-sdl2)
|
||
* [SDL 2.0](#sdl-2-0)
|
||
* [Allegro 5](#allegro-5)
|
||
* [Fira Mono font](#fira-mono-font)
|
||
* [Escher font](#escher-font)
|
||
* [Escheresk font](#escheresk-font)
|
||
* [fauxgl](#fauxgl)
|
||
* [draw2d](#draw2d)
|
||
* [go-colurful](#go-colurful)
|
||
* [resize](#resize)
|
||
* [testify](#testify)
|
||
|
||
## Introduction
|
||
|
||
**Welcome to Qbitter!**
|
||
|
||
Qbitter is a game loosly based on a work "LW305 Kringloop" of M.C. Escher where a gnome runs down a stairs and morphs into its 2D abstract shape. The game also lends ideas from _Q*Bert_, a game from the eighties that was itself based on the works of M.C. Escher. In the game you (represented as a gnome) have to collect stars while trying to avoid enemies (hexagons). Every level has increasing difficulty.
|
||
|
||
**Controls:**
|
||
|
||
W: move up (left) cube
|
||
A: move down (left) cube
|
||
S: move down (right) cube
|
||
D: move up (right) cube
|
||
|
||
## Additional Rules
|
||
|
||
### Implementation
|
||
|
||
**genre rule #143**
|
||
|
||
This rule has been omitted (too subjective) by applying the bonus rule. There is two elements that could be considered funny though:
|
||
- The gnome (player) is an character that is absurdly placed in this world, both style (hand drawn vs geometric) and color (gray vs colorful) are opposites of each other.
|
||
- In the credits my own libraries are blatantly mentioned first (yes I know, it could be considered arrogance or is it humorous as well?).
|
||
|
||
**artistical rule #147**
|
||
The game is based on a work of M.C. Escher "LW305 Kringloop" and it shows in different ways:
|
||
- The isometric cubes of the game try to mimic the style.
|
||
- The gnome featured as player is a loose interpretation of the gnome drawn by M.C. Escher.
|
||
- Geometric figures are used as game elements (stars, hearts, enemies).
|
||
* They are all based on a formula applied on a polar coordinate system (also the heart but this one isn't repeated).
|
||
|
||
**artistical rule #94**
|
||
|
||
In the credits some of the libraries I wrote (and used) are promoted (**Developed using** geom, zntg and allg5). To be sure that people notice this I put them on top of the list of credits.
|
||
|
||
**technical rule #113**
|
||
|
||
The main grid is made of cubes (faux 3D) that are regular hexagons in 2D. Additionaly the enemies of the player are made of wobbly hexagons.
|
||
|
||
**bonus rule #13**
|
||
|
||
Some functionality of the root package (tins2021) is unit tested (coverage is at time of writing 17% of the statements). You can find the tests in the files ending on `_test.go` (e.g. `level_test.go`).
|
||
|
||
### Definition
|
||
|
||
### Genre requirement
|
||
**** There will be 1 genre rule
|
||
|
||
**genre rule #143**
|
||
|
||
Humoristic/Funny. Make the player laugh out loud at least once by funny situations, dialogue, or anything else in your game.
|
||
|
||
Comments: If you need inspiriation take a look at [this list of 27 funniest video games of all time](https://www.theguardian.com/technology/2017/sep/07/the-27-funniest-video-games-of-all-time-hitman-grand-theft-auto) (Which includes some of my personal favorites, like monkey island or THHGTTG text adventure).
|
||
|
||
### Artistic requirements
|
||
**** There will be 2 artistical rules
|
||
|
||
**artistical rule #147**
|
||
|
||
Inspired by MC Escher
|
||
|
||
Comments: M.C. Escher created math-inspired graphical art. He created well known artworks that use impossible objects, symmetry and tesselations. One might say he was the very first creative coder. All his works can be browsed on this [online gallery](https://mcescher.com/).
|
||
|
||
**artistical rule #94**
|
||
|
||
The game should contain a plug for another program or thing you made.
|
||
|
||
Comments: It's not uncommon for a game to contain ads for other games by the same publisher. But you can get creative with it. Take for example Kings quest II. In that game you can find a complete [trailer for Space Quest](https://youtu.be/rKZwVQYV34g?t=1115) hidden as an easter egg.
|
||
|
||
### Technical requirement
|
||
**** There will be 1 technical rule
|
||
|
||
**technical rule #113**
|
||
|
||
Hexagonal - something in the game must be hexagonal
|
||
|
||
Comments: [Hexagons are the bestagons](https://www.youtube.com/watch?v=thOifuHs6eY).
|
||
|
||
### Bonus rule
|
||
**** There will be 1 bonus rule
|
||
|
||
**bonus rule #13**
|
||
|
||
Test of Might - you may skip another rule if your code contains automated test coverage (integration or unit tests).
|
||
|
||
Comments: You may use this as an escape clause to remove one of the other rules. Your automated test code should be included with your submission. For clarity, explain whether you applied this rule, and which rule you skipped, in the README of your game.
|
||
|
||
## Building
|
||
Prerequisites:
|
||
- [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 or a compatible compiler.
|
||
- [Git](https://git-scm.com/download).
|
||
|
||
**Note:** the SDL 2.0 dependency can be replaced with [Allegro 5](#Using-Allegro) as well.
|
||
|
||
With all prequisites installed you can run:
|
||
```
|
||
go get -u opslag.de/schobers/tins2021/cmd/tins2021
|
||
```
|
||
|
||
This will create the binary `$HOME/go/bin/tins2021`. 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/tins2021/cmd/tins2021
|
||
go install -tags static -ldflags "-s -w" opslag.de/schobers/tins2021/cmd/tins2021
|
||
```
|
||
|
||
### Using Allegro
|
||
|
||
If you want to use the Allegro backend you can add the build tag `allegro` to the `go install` command. E.g.:
|
||
```
|
||
go get -u opslag.de/schobers/allg5
|
||
go install -tags static,allegro -ldflags "-s -w" opslag.de/schobers/tins2021/cmd/tins2021
|
||
```
|
||
In this case the SDL 2.0 prerequisite is replaced by Allegro 5.2 (development libraries must be available for your C compiler).
|
||
|
||
## Command line interface
|
||
You can extract all resources embedded in the executable by running it from the command line with the `--extract` flag. The resources will be extract in the current working directory. Note that the game will use the resources on disk first if they are available.
|
||
|
||
## Sources
|
||
Can be found at https://opslag.de/schobers/tins2021 (Git repository).
|
||
|
||
## Licenses
|
||
|
||
### SDL 2.0
|
||
|
||
This software is provided 'as-is', without any express or implied
|
||
warranty. In no event will the authors be held liable for any damages
|
||
arising from the use of this software.
|
||
|
||
Permission is granted to anyone to use this software for any purpose,
|
||
including commercial applications, and to alter it and redistribute it
|
||
freely, subject to the following restrictions:
|
||
|
||
1. The origin of this software must not be misrepresented; you must not
|
||
claim that you wrote the original software. If you use this software
|
||
in a product, an acknowledgment in the product documentation would be
|
||
appreciated but is not required.
|
||
2. Altered source versions must be plainly marked as such, and must not be
|
||
misrepresented as being the original software.
|
||
3. This notice may not be removed or altered from any source distribution.
|
||
|
||
### Go-SDL2
|
||
|
||
Copyright (c) 2013, Go-SDL2 Authors
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without
|
||
modification, are permitted provided that the following conditions are met:
|
||
|
||
* Redistributions of source code must retain the above copyright notice,
|
||
this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright
|
||
notice, this list of conditions and the following disclaimer in the
|
||
documentation and/or other materials provided with the distribution.
|
||
* Neither the name of Go-SDL2 nor the names of its contributors may be
|
||
used to endorse or promote products derived from this software without specific
|
||
prior written permission.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
### Allegro 5
|
||
|
||
Copyright © 2008-2010 the Allegro 5 Development Team
|
||
|
||
This software is provided ‘as-is’, without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
|
||
|
||
Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
|
||
|
||
The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
|
||
|
||
Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
|
||
|
||
This notice may not be removed or altered from any source distribution.
|
||
|
||
### Fira Mono font
|
||
|
||
Copyright (c) 2012-2013, The Mozilla Corporation and Telefonica S.A.
|
||
|
||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||
This license is copied below, and is also available with a FAQ at:
|
||
http://scripts.sil.org/OFL
|
||
|
||
|
||
-----------------------------------------------------------
|
||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||
-----------------------------------------------------------
|
||
|
||
PREAMBLE
|
||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||
development of collaborative font projects, to support the font creation
|
||
efforts of academic and linguistic communities, and to provide a free and
|
||
open framework in which fonts may be shared and improved in partnership
|
||
with others.
|
||
|
||
The OFL allows the licensed fonts to be used, studied, modified and
|
||
redistributed freely as long as they are not sold by themselves. The
|
||
fonts, including any derivative works, can be bundled, embedded,
|
||
redistributed and/or sold with any software provided that any reserved
|
||
names are not used by derivative works. The fonts and derivatives,
|
||
however, cannot be released under any other type of license. The
|
||
requirement for fonts to remain under this license does not apply
|
||
to any document created using the fonts or their derivatives.
|
||
|
||
DEFINITIONS
|
||
"Font Software" refers to the set of files released by the Copyright
|
||
Holder(s) under this license and clearly marked as such. This may
|
||
include source files, build scripts and documentation.
|
||
|
||
"Reserved Font Name" refers to any names specified as such after the
|
||
copyright statement(s).
|
||
|
||
"Original Version" refers to the collection of Font Software components as
|
||
distributed by the Copyright Holder(s).
|
||
|
||
"Modified Version" refers to any derivative made by adding to, deleting,
|
||
or substituting -- in part or in whole -- any of the components of the
|
||
Original Version, by changing formats or by porting the Font Software to a
|
||
new environment.
|
||
|
||
"Author" refers to any designer, engineer, programmer, technical
|
||
writer or other person who contributed to the Font Software.
|
||
|
||
PERMISSION & CONDITIONS
|
||
Permission is hereby granted, free of charge, to any person obtaining
|
||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||
redistribute, and sell modified and unmodified copies of the Font
|
||
Software, subject to the following conditions:
|
||
|
||
1) Neither the Font Software nor any of its individual components,
|
||
in Original or Modified Versions, may be sold by itself.
|
||
|
||
2) Original or Modified Versions of the Font Software may be bundled,
|
||
redistributed and/or sold with any software, provided that each copy
|
||
contains the above copyright notice and this license. These can be
|
||
included either as stand-alone text files, human-readable headers or
|
||
in the appropriate machine-readable metadata fields within text or
|
||
binary files as long as those fields can be easily viewed by the user.
|
||
|
||
3) No Modified Version of the Font Software may use the Reserved Font
|
||
Name(s) unless explicit written permission is granted by the corresponding
|
||
Copyright Holder. This restriction only applies to the primary font name as
|
||
presented to the users.
|
||
|
||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||
Software shall not be used to promote, endorse or advertise any
|
||
Modified Version, except to acknowledge the contribution(s) of the
|
||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||
permission.
|
||
|
||
5) The Font Software, modified or unmodified, in part or in whole,
|
||
must be distributed entirely under this license, and must not be
|
||
distributed under any other license. The requirement for fonts to
|
||
remain under this license does not apply to any document created
|
||
using the Font Software.
|
||
|
||
TERMINATION
|
||
This license becomes null and void if any of the above conditions are
|
||
not met.
|
||
|
||
DISCLAIMER
|
||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||
|
||
### Escher font
|
||
|
||
Licensed under WTFPL (https://isene.org/2019/12/Escher.html)
|
||
|
||
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
||
Version 2, December 2004
|
||
|
||
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
|
||
|
||
Everyone is permitted to copy and distribute verbatim or modified
|
||
copies of this license document, and changing it is allowed as long
|
||
as the name is changed.
|
||
|
||
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||
|
||
0. You just DO WHAT THE FUCK YOU WANT TO.
|
||
|
||
### Escheresk font
|
||
|
||
**Note of the author**
|
||
|
||
If you want to use this for commercial projects, please contact me: tobias (dot) sommer (at) gmx (dot) ch
|
||
I also appreciate it if you send me links/images of your non-commercial work featuring this font.
|
||
Enjoy! :)
|
||
|
||
### fauxgl
|
||
|
||
Copyright (C) 2017 Michael Fogleman
|
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||
|
||
### draw2d
|
||
|
||
Copyright (c) 2010, Laurent Le Goff
|
||
All rights reserved.
|
||
|
||
Redistribution and use in source and binary forms, with or without modification,
|
||
are permitted provided that the following conditions are met:
|
||
|
||
* Redistributions of source code must retain the above copyright notice,
|
||
this list of conditions and the following disclaimer.
|
||
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
|
||
disclaimer in the documentation and/or other materials provided with the distribution.
|
||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
||
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
|
||
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
|
||
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
||
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
||
### go-colurful
|
||
|
||
Copyright (c) 2013 Lucas Beyer
|
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||
|
||
### resize
|
||
|
||
Copyright (c) 2012, Jan Schlicht <jan.schlicht@gmail.com>
|
||
|
||
Permission to use, copy, modify, and/or distribute this software for any purpose
|
||
with or without fee is hereby granted, provided that the above copyright notice
|
||
and this permission notice appear in all copies.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
||
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
||
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
||
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
|
||
THIS SOFTWARE.
|
||
|
||
### testify
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2012-2020 Mat Ryer, Tyler Bunnell and contributors.
|
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
of this software and associated documentation files (the "Software"), to deal
|
||
in the Software without restriction, including without limitation the rights
|
||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
copies of the Software, and to permit persons to whom the Software is
|
||
furnished to do so, subject to the following conditions:
|
||
|
||
The above copyright notice and this permission notice shall be included in all
|
||
copies or substantial portions of the Software.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||
SOFTWARE.
|