Skip to content

Commit 2415050

Browse files
committed
Added Readme.md file.
1 parent 1790fbf commit 2415050

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Dosktop
2+
3+
Dosktop is a package which allow users to easily create rich text-based terminal
4+
applications and games. Dosktop differs from other terminal packages by
5+
providing an extremely simple API that abstracts out all low-level terminal
6+
operations, while avoiding complicated event-driven TUI designs.
7+
8+
# Features
9+
10+
* Straight forward BASIC-like API and syntax!
11+
* Access to an unlimited number of independent text layers, allowing for modal dialogs, windows, parallax scrolling, forgrounds, backgrounds, and more!
12+
* Automatic calculation of shadows and colored transparencies effects!
13+
* High level support for buttons, selection menus, lines, frames, and other TUI controls!
14+
* Full manual and automatic mouse support with TUI integration!
15+
* Dialog text printing with automatic word wrapping, typewriter effects, and dynamic style markup!
16+
* Virtual File System (ZIP) support, with password protection to ensure resource integrity!
17+
* Automatic conversion and rendering of bitmap images directly to text layers in ansi graphics!
18+
19+
# Screenshots
20+
21+
Create windows and menus with full mouse support!
22+
23+
![alt text](https://raw.githubusercontent.com/supercom32/dosktop/main/docs/media/example_menu.gif)
24+
25+
Ability to scale and draw bitmapped images directly to terminal with dialog printing!
26+
27+
![alt text](https://raw.githubusercontent.com/supercom32/dosktop/main/docs/media/example_wave.gif)
28+
29+
Support for dynamic text layer transparencies!
30+
31+
![alt text](https://raw.githubusercontent.com/supercom32/dosktop/main/docs/media/example_sakura.gif)
32+
33+
Fully manipulable and independent text layers!
34+
35+
![alt text](https://raw.githubusercontent.com/supercom32/dosktop/main/docs/media/example_scope.gif)
36+
37+
# Project status
38+
39+
While Dosktop is currently being actively developed, it is at a point where practical use
40+
will determine further areas of usability, existing gaps, and deficiency improvements. If you
41+
like what this package has to offer, have ideas on how to improve it, or just want to
42+
experiment, consider giving Dosktop a try!
43+
44+
# Future Roadmap
45+
46+
* More examples and documentation.
47+
* More TUI controls (Progress bars, loading icons, etc).
48+
* Bulk addition of images and selections.
49+
* Saving and loading of terminal screenshots.
50+
* Fully text-based sprite system.
51+
* Digital audio and sound integration.

0 commit comments

Comments
 (0)