I've agonized over conflicts between editor and script handlers for a while, but finally the solution occurred to me: to use the script's handlers, hide the editor. To use the editor's handlers, show the editor. The menu and settings are always active. This seems nice and consistent, easy to explain. Mike Stein would prefer we just supported love.* handlers in scripts to minimize special cases and cognitive load for people. But I'd rather err on the side of being transparent about what's going on inside. As a compromise I'm supporting love.* names at least in addition to my rephrasings (which came about mostly because love.keychordpressed is just too much of a mouthful) |
||
|---|---|---|
| assets | ||
| 0000-freewheeling-start | ||
| 0001-on | ||
| 0002-Debug_animations_in_progress | ||
| 0003-refresh_debug_animations | ||
| 0004-on.update | ||
| 0005-animate | ||
| 0006-loiter | ||
| 0007-save_callstack | ||
| 0008-Debug_animation_period | ||
| 0010-Line_height | ||
| 0011-on.initialize | ||
| 0012-on.draw | ||
| 0013-on.keychord_press | ||
| 0014-on.text_input | ||
| 0015-on.key_release | ||
| 0016-on.mouse_press | ||
| 0017-on.mouse_release | ||
| 0019-Line_number_padding | ||
| 0020-draw_editor_border | ||
| 0021-draw_menu | ||
| 0023-Menu_top | ||
| 0024-Menu_left | ||
| 0025-Menu_height | ||
| 0026-Menu_bottom | ||
| 0027-Menu_background | ||
| 0028-draw_output_border | ||
| 0029-Safe_width | ||
| 0030-Safe_height | ||
| 0031-on.resize | ||
| 0032-update_font_settings | ||
| 0033-Normal_color | ||
| 0034-draw_scrollbar | ||
| 0035-compute_scrollbar | ||
| 0036-adjust_scrollbar | ||
| 0038-on_editor_scrollbar | ||
| 0040-on_editor_scrollbar_area | ||
| 0042-draw_canvas | ||
| 0043-map | ||
| 0045-Current_pane | ||
| 0046-Global_state | ||
| 0047-Current_pane_index | ||
| 0048-Panes | ||
| 0049-new_pane | ||
| 0050-print_to_output | ||
| 0051-run_button | ||
| 0052-enable_loiter | ||
| 0054-Animations_in_progress | ||
| 0056-end_frame | ||
| 0058-draw_next_frames_of_animations | ||
| 0059-previous_pane_button | ||
| 0060-next_pane_button | ||
| 0061-new_pane_button | ||
| 0063-Show_code | ||
| 0064-show_code_button | ||
| 0065-hide_code_button | ||
| 0066-copy_button | ||
| 0067-paste_button | ||
| 0068-copy_editor | ||
| 0069-output_editor_state | ||
| 0070-code_editor_state | ||
| 0071-duplicate_pane_button | ||
| 0072-settings_button | ||
| 0074-clear_pane_button | ||
| 0075-clear_pane | ||
| 0076-delete_pane_button | ||
| 0077-example_pane | ||
| 0078-Example_panes | ||
| 0079-White | ||
| 0080-Show_settings | ||
| 0081-draw_settings_menu | ||
| 0082-draw_slider | ||
| 0083-Settings_font_slider | ||
| 0084-update_any_sliders | ||
| 0085-slider_value | ||
| 0086-mouse_on_any_slider | ||
| 0087-on_slider | ||
| 0088-Settings_foreground_sliders | ||
| 0089-Settings_background_sliders | ||
| 0090-Background_color | ||
| 0091-Foreground_color | ||
| 0092-Settings_menu_area | ||
| 0093-on_area | ||
| 0095-Selected_slider | ||
| 0097-Font_height | ||
| 0098-on.save_settings | ||
| 0099-on.load_settings | ||
| 0100-car | ||
| 0101-on.mouse_wheel_move | ||
| LICENSE.txt | ||
| Manual_tests.md | ||
| MemoryReferenceInfo.lua.0 | ||
| MemoryReferenceInfo.lua.unused | ||
| README.md | ||
| app.lua | ||
| button.lua | ||
| colorize.lua | ||
| default_map | ||
| edit.lua | ||
| file.lua | ||
| json.lua | ||
| keychord.lua | ||
| live.lua | ||
| main.lua | ||
| nativefs.lua | ||
| reference.md | ||
| search.lua | ||
| select.lua | ||
| test.lua | ||
| text.lua | ||
| text_tests | ||
| text_tests.lua | ||
| undo.lua | ||
README.md
Example "freewheeling" app that can be modified without being restarted
Running this repo in isolation won't be very helpful. If you haven't yet, first check out the driver app. This repo is a template you can copy to create your own live apps that juggle text editor widgets. The editors support copy/paste, search, infinite undo, etc. You can't modify editor functionality live (yet?).
Some reference documentation on how to create your own apps.
This repo is an example of a Freewheeling App, designed above all to be easy to run, easy to modify and easy to share.
Getting started
Install LÖVE. It's just a 5MB download, open-source and
extremely well-behaved. I'll assume below that you can invoke it using the
love command, but that might vary depending on your OS.
Run this app from the terminal, passing its directory to LÖVE
Hacking
To modify it live without restarting the app each time, download the driver app. Here's an example session using a fork of this repo:
If you run a .love file, your changes will go into the save directory. If you unzip the .love file into a new directory and run the directory instead, your changes will go straight into the same directory.
Keyboard shortcuts
Up to you! But within the included editor widget if you use it:
ctrl+fto find patterns within a filectrl+cto copy,ctrl+xto cut,ctrl+vto pastectrl+zto undo,ctrl+yto redoctrl+=to zoom in,ctrl+-to zoom out,ctrl+0to reset zoomalt+right/alt+leftto jump to the next/previous word, respectively- mouse drag or
shift+ movement to select text,ctrl+ato select all
Exclusively tested so far with a US keyboard layout. If you use a different layout, please let me know if things worked, or if you found anything amiss: http://akkartik.name/contact
Known issues
-
Both freewheeling apps and the driver for them currently benefit from being launched in terminal windows rather than by being clicked on in a desktop OS. See the driver app for details.
-
No support yet for Unicode graphemes spanning multiple codepoints.
-
No support yet for right-to-left languages.
-
Undo/redo may be sluggish in editor windows containing large files. Large files may grow sluggish in other ways.
-
If you kill the process, say by force-quitting because things things get sluggish, you can lose data.
-
Can't scroll while selecting text with mouse.
Mirrors and Forks
This repo is a fork of lines.love, an editor for plain text where you can also seamlessly insert line drawings. Its immediate upstream is text.love, a version without support for line drawings. Updates to it can be downloaded from the following mirrors:
- https://git.sr.ht/~akkartik/template-live-editor
- https://codeberg.org/akkartik/template-live-editor
- https://nest.pijul.com/akkartik/template-live-editor (using the Pijul version control system)
Further forks are encouraged. If you show me your fork, I'll link to it here.
- https://git.sr.ht/~akkartik/luaML.love - a "browser" for a Lua-based markup language, loosely analogous to HTML except it's all Lua.
- https://git.sr.ht/~akkartik/bf.love - a toy environment for working with BF programs.
- https://git.sr.ht/~akkartik/broadsheet.love - a multi-column paginator that uses all available width while remaining readable.
- https://git.sr.ht/~akkartik/crosstable.love - for all-play-all tournaments.