aboutsummaryrefslogtreecommitdiff
path: root/kscurses/readme.md
diff options
context:
space:
mode:
authordam <dam@gudinoff>2023-08-17 20:28:47 +0100
committerdam <dam@gudinoff>2023-08-17 20:28:47 +0100
commit709879ee56d31fe543a0ad882713bd4e3d17d2d2 (patch)
tree12a35282bdd0f1f8a2159ade147944c89254db24 /kscurses/readme.md
parentfa1b8ea54646f1a0f3eadef33e3a660b875cc1ff (diff)
downloadtask-time-tracker-709879ee56d31fe543a0ad882713bd4e3d17d2d2.tar.zst
task-time-tracker-709879ee56d31fe543a0ad882713bd4e3d17d2d2.zip
Added kscurses and testing program.
Diffstat (limited to 'kscurses/readme.md')
-rw-r--r--kscurses/readme.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/kscurses/readme.md b/kscurses/readme.md
new file mode 100644
index 0000000..7a2f6fc
--- /dev/null
+++ b/kscurses/readme.md
@@ -0,0 +1,43 @@
+# kscurses
+## _Curses replacement on jai for my needs. Use at your own risk._
+
+`tested on version 0.1.073`
+
+# setup & build
+1. download extra-containers module https://github.com/CyanMARgh/extra-containers
+2. move it to your extra modules folder
+3. specify this foder on top of demos/first.jai
+4. compile first.jai
+
+Currently works only on linux (tested on gnome terminal).
+
+# features list
+- character input
+- window resize handle
+- text modifiers (bold, italic, underline, blinking, inverse, strikethrough), color256 support
+- text/background color.
+- arrows, escape key and some
+- saving and restoring the terminal
+- exit with and crtl+C (optional).
+- ui elements (empty, button, text block, selection list)
+- multiple scenes and popups support
+- events (ticks, input, window resize and user-defined events)
+- ui can work both in single-thread mode and multi-thread mode
+- 4 print modes:
+- - ks_**method** : method prints directly terminal
+- - t_**method** : method returns temporary string or string from constant data section
+- - b_**method** : method prints to builder
+- - c_**method**: method prints to canvas
+
+# demos list
+- basic print methods, canvas and graphic modes usage
+- video (now uses events and color256 approximation with semi-transparent characters)
+- shorter canvas usage
+- ui : progress bars and extra events handler
+- ui : text buffer, buttons, selection list, groups, scenes
+- ui : popup
+- ui : line input
+- events processing without default ui
+- snake minigame
+- ui : table
+- ui : scalable group and anchors