Commit | Line | Data |
---|---|---|
7d4115a5 KL |
1 | Jexer - Java Text User Interface library |
2 | ======================================== | |
3 | ||
3cb99336 | 4 | This library implements a text-based windowing system loosely |
a7f45950 KL |
5 | reminiscent of Borland's [Turbo |
6 | Vision](http://en.wikipedia.org/wiki/Turbo_Vision) system. It looks | |
7 | like this: | |
30bd4abd | 8 | |
a7f45950 | 9 | ![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal") |
1ac2ccb1 | 10 | |
a7f45950 KL |
11 | Jexer works on both Xterm-like terminals and Swing, and supports |
12 | images in both Xterm and Swing. On Swing, images are true color: | |
55b4f29b | 13 | |
a7f45950 | 14 | ![Swing Snake Image](/screenshots/snake_swing.png?raw=true "Swing Snake Image") |
1ac2ccb1 | 15 | |
a7f45950 | 16 | On Xterm, images are dithered to a common palette: |
1ac2ccb1 | 17 | |
a7f45950 | 18 | ![Xterm Snake Image](/screenshots/snake_xterm.png?raw=true "Xterm Snake Image") |
1c15371a | 19 | |
1ac2ccb1 | 20 | |
7d4115a5 KL |
21 | |
22 | License | |
23 | ------- | |
24 | ||
a7f45950 | 25 | Jexer is available to all under the MIT License. See the file LICENSE |
e16dda65 | 26 | for the full license text. |
7d4115a5 KL |
27 | |
28 | ||
a7f45950 KL |
29 | |
30 | Obtaining Jexer | |
31 | --------------- | |
1596e11a KL |
32 | |
33 | Jexer is available on Maven Central: | |
34 | ||
35 | ```xml | |
36 | <dependency> | |
37 | <groupId>com.gitlab.klamonte</groupId> | |
38 | <artifactId>jexer</artifactId> | |
7f7db411 | 39 | <version>0.3.1</version> |
1596e11a KL |
40 | </dependency> |
41 | ``` | |
42 | ||
a7f45950 KL |
43 | Binary releases are available on SourceForge: |
44 | https://sourceforge.net/projects/jexer/files/jexer/ | |
1596e11a | 45 | |
a7f45950 | 46 | The Jexer source code is hosted at: https://gitlab.com/klamonte/jexer |
30bd4abd | 47 | |
7d4115a5 | 48 | |
4b257bd8 | 49 | |
a7f45950 KL |
50 | Documentation |
51 | ------------- | |
4b257bd8 | 52 | |
a7f45950 | 53 | * [Java API Docs](https://jexer.sourceforge.io/apidocs/api/index.html) |
4b257bd8 | 54 | |
a7f45950 | 55 | * [Wiki](https://gitlab.com/klamonte/jexer/wikis/home) |
4b257bd8 | 56 | |
528874e2 KL |
57 | |
58 | ||
a7f45950 KL |
59 | Programming Examples |
60 | -------------------- | |
528874e2 KL |
61 | |
62 | The examples/ folder currently contains: | |
63 | ||
64 | * A [prototype tiling window | |
d4c334ef | 65 | manager](/examples/JexerTilingWindowManager.java) in less than 250 |
528874e2 KL |
66 | lines of code. |
67 | ||
5434cb2b KL |
68 | * A [prototype image thumbnail |
69 | viewer](/examples/JexerImageViewer.java) in less than 350 lines of | |
70 | code. | |
71 | ||
528874e2 KL |
72 | jexer.demos contains official demos showing all of the existing UI |
73 | controls. The demos can be run as follows: | |
4b257bd8 KL |
74 | |
75 | * 'java -jar jexer.jar' . This will use System.in/out with | |
a7f45950 | 76 | Xterm-like sequences on non-Windows non-Mac platforms. On Windows |
92453213 | 77 | and Mac it will use a Swing JFrame. |
4b257bd8 KL |
78 | |
79 | * 'java -Djexer.Swing=true -jar jexer.jar' . This will always use | |
80 | Swing on any platform. | |
81 | ||
82 | * 'java -cp jexer.jar jexer.demos.Demo2 PORT' (where PORT is a | |
a7f45950 KL |
83 | number to run the TCP daemon on). This will use the Xterm backend |
84 | on a telnet server that will update with screen size changes. | |
4b257bd8 | 85 | |
92453213 | 86 | * 'java -cp jexer.jar jexer.demos.Demo3' . This will use |
a7f45950 | 87 | System.in/out with Xterm-like sequences. One can see in the code |
92453213 KL |
88 | how to pass a different InputReader and OutputReader to |
89 | TApplication, permitting a different encoding than UTF-8. | |
90 | ||
91 | * 'java -cp jexer.jar jexer.demos.Demo4' . This demonstrates hidden | |
92 | windows and a custom TDesktop. | |
93 | ||
88a99379 KL |
94 | * 'java -cp jexer.jar jexer.demos.Demo5' . This demonstrates two |
95 | demo applications using different fonts in the same Swing frame. | |
96 | ||
15c86fc2 | 97 | * 'java -cp jexer.jar jexer.demos.Demo6' . This demonstrates two |
a7f45950 | 98 | applications performing I/O across three screens: an Xterm screen |
15c86fc2 | 99 | and Swing screen, monitored from a third Swing screen. |
88a99379 | 100 | |
4b257bd8 KL |
101 | |
102 | ||
103 | More Screenshots | |
104 | ---------------- | |
105 | ||
4b257bd8 KL |
106 | ![Yo Dawg...](/screenshots/yodawg.png?raw=true "Yo Dawg, I heard you like text windowing systems, so I ran a text windowing system inside your text windowing system so you can have a terminal in your terminal.") |
107 | ||
3cb99336 KL |
108 | ![Sixel Pictures Of Cliffs Of Moher And Buoy](/screenshots/sixel_images.png?raw=true "Sixel Pictures Of Cliffs Of Moher And Buoy") |
109 | ||
110 | ![Sixel Color Wheel](/screenshots/sixel_color_wheel.png?raw=true "Sixel Color Wheel") | |
111 | ||
4b257bd8 | 112 | |
a7f45950 | 113 | |
9c238a4b KL |
114 | Terminal Support |
115 | ---------------- | |
116 | ||
a7f45950 | 117 | The table below lists terminals tested against Jexer's Xterm backend: |
9c238a4b KL |
118 | |
119 | | Terminal | Environment | Mouse Click | Mouse Cursor | Images | | |
120 | | -------------- | ------------------ | ----------- | ------------ | ------ | | |
121 | | xterm | X11 | yes | yes | yes | | |
4d184008 | 122 | | lcxterm(3) | CLI, Linux console | yes | yes | no | |
3a4a5f00 | 123 | | rxvt-unicode | X11 | yes | yes | no(2) | |
9c238a4b KL |
124 | | alacritty(3) | X11 | yes | yes | no | |
125 | | gnome-terminal | X11 | yes | yes | no | | |
126 | | xfce4-terminal | X11 | yes | yes | no | | |
f0e0da5b | 127 | | mlterm | X11 | yes | yes | no(5) | |
9c238a4b KL |
128 | | aminal(3) | X11 | yes | no | no | |
129 | | konsole | X11 | yes | no | no | | |
130 | | yakuake | X11 | yes | no | no | | |
0bb31542 KL |
131 | | screen | CLI | yes(1) | yes(1) | no(2) | |
132 | | tmux | CLI | yes(1) | yes(1) | no | | |
9c238a4b KL |
133 | | putty | X11, Windows | yes | no | no(2) | |
134 | | Linux | Linux console | no | no | no(2) | | |
135 | | qodem(3) | CLI, Linux console | yes | yes(4) | no | | |
4d184008 | 136 | | qodem-x11(3) | X11 | yes | no | no | |
9c238a4b | 137 | |
0bb31542 | 138 | 1 - Requires mouse support from host terminal. |
9c238a4b KL |
139 | |
140 | 2 - Also fails to filter out sixel data, leaving garbage on screen. | |
141 | ||
142 | 3 - Latest in repository. | |
143 | ||
144 | 4 - Requires TERM=xterm-1003 before starting. | |
145 | ||
f0e0da5b KL |
146 | 5 - Opening image crashes terminal. |
147 | ||
9c238a4b | 148 | |
4b257bd8 | 149 | |
a7f45950 KL |
150 | See Also |
151 | -------- | |
b5f2a6db | 152 | |
a7f45950 KL |
153 | * [Tranquil Java IDE](https://tjide.sourceforge.io) is a TUI-based |
154 | integrated development environment for the Java language that was | |
155 | built using a very lightly modified GPL version of Jexer. TJ | |
156 | provided a real-world use case to shake out numerous bugs and | |
157 | limitations of Jexer. | |
b5f2a6db | 158 | |
a7f45950 KL |
159 | * [LCXterm](https://lcxterm.sourceforge.io) is a curses-based terminal |
160 | emulator that allows one to use Jexer with full support on the raw | |
161 | Linux console. | |
55b4f29b | 162 | |
a7f45950 KL |
163 | * [ptypipe](https://gitlab.com/klamonte/ptypipe) is a small C utility |
164 | that permits a Jexer TTerminalWindow to resize the running shell | |
165 | when its window is resized. | |
b5f2a6db KL |
166 | |
167 | ||
7d4115a5 | 168 | |
a7f45950 KL |
169 | Acknowledgements |
170 | ---------------- | |
3cb99336 | 171 | |
a7f45950 KL |
172 | Jexer makes use of the Terminus TrueType font [made available |
173 | here](http://files.ax86.net/terminus-ttf/) . |