twitchapon-anim

commit 00c3d0895e0907dec293cf28e7f9676887bfc941
parent 108e6d333581e777eaa20616d3737b84735021cf
Author: bsandro <brian.drosan@gmail.com>
Date:   Sun,  9 May 2021 17:01:14 +0300

Added licence, brief todo and readme files.

Diffstat:
A
LICENSE
 | 
24
++++++++++++++++++++++++
A
README
 | 
15
+++++++++++++++
A
TODO
 | 
8
++++++++

3 files changed, 47 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2021, bsandro. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. 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.
diff --git a/README b/README
@@ -0,0 +1,15 @@
+twitchapon-anim - listener for the events that come from the twitchapon
+
+Built with the ebiten(1) framework with an addition of "native" x/image
+from golang repositories.
+
+Main purpose is to listen for events coming from the twitchapon service
+and react to them visually.
+That being said, it is mainly a playground for now that does nothing
+meaningful yet apart from spawning a (hardcoded) picture at the center
+of the screen. Spawn is triggered by a http request to the port 2345
+(another hardcoded value, subject to be changed).
+
+See TODO for some planned features, fixes and general ideas.
+
+1. https://github.com/hajimehoshi/ebiten
diff --git a/TODO b/TODO
@@ -0,0 +1,8 @@
+twitchapon-anim brief TODO list
+
+- general code cleanup
+- make it configurable
+- distinct different type of messages and react to them differently
+- some GIF animation support
+- sound support
+- use native go 1.16 embeddable binaries feature