Template repo for tiny cross-platform apps that can be modified on phone, tablet or computer.
Go to file
Kartik K. Agaram d86e8f945b better comment 2023-04-20 23:39:36 -07:00
assets
0000-freewheeling-start new file-system format for freewheeling apps 2023-04-16 11:16:47 -07:00
0001-on better comment 2023-04-20 23:39:36 -07:00
LICENSE.txt
Manual_tests.md manual tests for the protocol with the driver 2023-04-09 10:34:24 -07:00
MemoryReferenceInfo.lua.0
MemoryReferenceInfo.lua.unused
README.md new file-system format for freewheeling apps 2023-04-16 11:16:47 -07:00
app.lua Merge text0 2023-04-19 19:47:42 -07:00
button.lua
edit.lua Merge text0 2023-04-08 22:03:05 -07:00
file.lua
json.lua
keychord.lua
live.lua attempt at better error recovery 2023-04-20 00:30:25 -07:00
main.lua Merge text0 2023-04-20 18:28:23 -07:00
reference.md include Current_time in reference 2023-04-20 18:42:29 -07:00
search.lua Merge text0 2023-04-02 16:50:08 -07:00
select.lua
test.lua
text.lua Merge text0 2023-04-08 23:00:47 -07:00
text_tests.lua Merge text0 2023-04-02 16:50:08 -07:00
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?).

This repo is a fork of lines.love, an editor for plain text where you can also seamlessly insert line drawings. Designed above all to be easy to modify and give you early warning if your modifications break something.

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:

making changes without restarting the app

To publish your changes:

  • delete all files with a numeric prefix from the repo, and then
  • move all files with a numeric prefix from the save dir to the repo

Keyboard shortcuts

Up to you! But within the included editor widget if you use it:

  • ctrl+f to find patterns within a file
  • ctrl+c to copy, ctrl+x to cut, ctrl+v to paste
  • ctrl+z to undo, ctrl+y to redo
  • ctrl+= to zoom in, ctrl+- to zoom out, ctrl+0 to reset zoom
  • alt+right/alt+left to jump to the next/previous word, respectively
  • mouse drag or shift + movement to select text, ctrl+a to 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 large files. Large files may grow sluggish in other ways. Works well in all circumstances with files under 50KB.

  • If you kill the process, say by force-quitting because things things get sluggish, you can lose data.

  • Long wrapping lines can't yet distinguish between the cursor at end of one screen line and start of the next, so clicking the mouse to position the cursor can very occasionally do the wrong thing.

  • Can't scroll while selecting text with mouse.

  • No scrollbars yet. That stuff is hard.

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:

Further forks are encouraged. If you show me your fork, I'll link to it here.

Feedback

Most appreciated.