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 | |
01fccda0 | 9 | ![Terminal, Image, Table](/screenshots/new_demo1.png?raw=true "Terminal, Image, Table") |
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> | |
f46a119f | 39 | <version>0.3.2</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 | |
f46a119f KL |
57 | * [Jexer web page](https://jexer.sourceforge.io/) |
58 | ||
528874e2 KL |
59 | |
60 | ||
a7f45950 KL |
61 | Programming Examples |
62 | -------------------- | |
528874e2 KL |
63 | |
64 | The examples/ folder currently contains: | |
65 | ||
66 | * A [prototype tiling window | |
d4c334ef | 67 | manager](/examples/JexerTilingWindowManager.java) in less than 250 |
528874e2 KL |
68 | lines of code. |
69 | ||
9ad2ce4f KL |
70 | * A much slicker [prototype tiling window |
71 | manager](/examples/JexerTilingWindowManager2.java) in less than 200 | |
72 | lines of code. | |
73 | ||
5434cb2b KL |
74 | * A [prototype image thumbnail |
75 | viewer](/examples/JexerImageViewer.java) in less than 350 lines of | |
76 | code. | |
77 | ||
528874e2 KL |
78 | jexer.demos contains official demos showing all of the existing UI |
79 | controls. The demos can be run as follows: | |
4b257bd8 KL |
80 | |
81 | * 'java -jar jexer.jar' . This will use System.in/out with | |
a7f45950 | 82 | Xterm-like sequences on non-Windows non-Mac platforms. On Windows |
92453213 | 83 | and Mac it will use a Swing JFrame. |
4b257bd8 KL |
84 | |
85 | * 'java -Djexer.Swing=true -jar jexer.jar' . This will always use | |
86 | Swing on any platform. | |
87 | ||
88 | * 'java -cp jexer.jar jexer.demos.Demo2 PORT' (where PORT is a | |
a7f45950 KL |
89 | number to run the TCP daemon on). This will use the Xterm backend |
90 | on a telnet server that will update with screen size changes. | |
4b257bd8 | 91 | |
92453213 | 92 | * 'java -cp jexer.jar jexer.demos.Demo3' . This will use |
a7f45950 | 93 | System.in/out with Xterm-like sequences. One can see in the code |
92453213 KL |
94 | how to pass a different InputReader and OutputReader to |
95 | TApplication, permitting a different encoding than UTF-8. | |
96 | ||
97 | * 'java -cp jexer.jar jexer.demos.Demo4' . This demonstrates hidden | |
98 | windows and a custom TDesktop. | |
99 | ||
88a99379 KL |
100 | * 'java -cp jexer.jar jexer.demos.Demo5' . This demonstrates two |
101 | demo applications using different fonts in the same Swing frame. | |
102 | ||
15c86fc2 | 103 | * 'java -cp jexer.jar jexer.demos.Demo6' . This demonstrates two |
a7f45950 | 104 | applications performing I/O across three screens: an Xterm screen |
15c86fc2 | 105 | and Swing screen, monitored from a third Swing screen. |
88a99379 | 106 | |
ba71ae78 KL |
107 | * 'java -cp jexer.jar jexer.demos.Demo7' . This demonstrates the |
108 | BoxLayoutManager, achieving a similar result as the | |
109 | javax.swing.BoxLayout apidocs example. | |
110 | ||
4b257bd8 KL |
111 | |
112 | ||
113 | More Screenshots | |
114 | ---------------- | |
115 | ||
f46a119f KL |
116 | Jexer can be run inside its own terminal window, with support for all |
117 | of its features including images and mouse, and more terminals: | |
118 | ||
465d742a | 119 | ![Yo Dawg...](/screenshots/jexer_sixel_in_sixel.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.") |
4b257bd8 | 120 | |
f46a119f KL |
121 | Sixel output uses a single palette which works OK for a variety of |
122 | real-world images: | |
123 | ||
3cb99336 KL |
124 | ![Sixel Pictures Of Cliffs Of Moher And Buoy](/screenshots/sixel_images.png?raw=true "Sixel Pictures Of Cliffs Of Moher And Buoy") |
125 | ||
f46a119f KL |
126 | The color wheel with that palette is shown below: |
127 | ||
3cb99336 KL |
128 | ![Sixel Color Wheel](/screenshots/sixel_color_wheel.png?raw=true "Sixel Color Wheel") |
129 | ||
4b257bd8 | 130 | |
a7f45950 | 131 | |
9c238a4b KL |
132 | Terminal Support |
133 | ---------------- | |
134 | ||
a7f45950 | 135 | The table below lists terminals tested against Jexer's Xterm backend: |
9c238a4b KL |
136 | |
137 | | Terminal | Environment | Mouse Click | Mouse Cursor | Images | | |
138 | | -------------- | ------------------ | ----------- | ------------ | ------ | | |
139 | | xterm | X11 | yes | yes | yes | | |
f46a119f | 140 | | jexer | CLI, X11, Windows | yes | yes | yes | |
de9f648e | 141 | | mlterm | X11 | yes | yes | yes | |
29dcb861 | 142 | | RLogin | Windows | yes | yes | yes | |
9c238a4b KL |
143 | | alacritty(3) | X11 | yes | yes | no | |
144 | | gnome-terminal | X11 | yes | yes | no | | |
83ca289f KL |
145 | | iTerm2 | Mac | yes | yes | no(5) | |
146 | | kitty(3) | X11 | yes | yes | no | | |
f46a119f | 147 | | lcxterm(3) | CLI, Linux console | yes | yes | no | |
83ca289f | 148 | | mintty | Windows | yes | yes | no(5) | |
f46a119f | 149 | | rxvt-unicode | X11 | yes | yes | no(2) | |
9c238a4b KL |
150 | | xfce4-terminal | X11 | yes | yes | no | |
151 | | aminal(3) | X11 | yes | no | no | | |
152 | | konsole | X11 | yes | no | no | | |
153 | | yakuake | X11 | yes | no | no | | |
cae2b42e | 154 | | Windows Terminal(6) | Windows | no | no | no(2) | |
0bb31542 KL |
155 | | screen | CLI | yes(1) | yes(1) | no(2) | |
156 | | tmux | CLI | yes(1) | yes(1) | no | | |
9c238a4b KL |
157 | | putty | X11, Windows | yes | no | no(2) | |
158 | | Linux | Linux console | no | no | no(2) | | |
159 | | qodem(3) | CLI, Linux console | yes | yes(4) | no | | |
4d184008 | 160 | | qodem-x11(3) | X11 | yes | no | no | |
d033d507 | 161 | | yaft | Linux console (FB) | no | no | yes | |
9c238a4b | 162 | |
0bb31542 | 163 | 1 - Requires mouse support from host terminal. |
9c238a4b KL |
164 | |
165 | 2 - Also fails to filter out sixel data, leaving garbage on screen. | |
166 | ||
167 | 3 - Latest in repository. | |
168 | ||
169 | 4 - Requires TERM=xterm-1003 before starting. | |
170 | ||
83ca289f | 171 | 5 - Sixel images can crash terminal. |
3676d542 | 172 | |
cae2b42e KL |
173 | 6 - Version 0.4.2382.0, on Windows 10.0.18362.30. Tested against |
174 | WSL-1 Debian instance. | |
175 | ||
9c238a4b | 176 | |
4b257bd8 | 177 | |
a7f45950 KL |
178 | See Also |
179 | -------- | |
b5f2a6db | 180 | |
a7f45950 KL |
181 | * [Tranquil Java IDE](https://tjide.sourceforge.io) is a TUI-based |
182 | integrated development environment for the Java language that was | |
183 | built using a very lightly modified GPL version of Jexer. TJ | |
184 | provided a real-world use case to shake out numerous bugs and | |
185 | limitations of Jexer. | |
b5f2a6db | 186 | |
a7f45950 KL |
187 | * [LCXterm](https://lcxterm.sourceforge.io) is a curses-based terminal |
188 | emulator that allows one to use Jexer with full support on the raw | |
189 | Linux console. | |
55b4f29b | 190 | |
a7f45950 KL |
191 | * [ptypipe](https://gitlab.com/klamonte/ptypipe) is a small C utility |
192 | that permits a Jexer TTerminalWindow to resize the running shell | |
193 | when its window is resized. | |
b5f2a6db KL |
194 | |
195 | ||
7d4115a5 | 196 | |
a7f45950 KL |
197 | Acknowledgements |
198 | ---------------- | |
3cb99336 | 199 | |
a7f45950 KL |
200 | Jexer makes use of the Terminus TrueType font [made available |
201 | here](http://files.ax86.net/terminus-ttf/) . |