Client for playing 300 publicly available Sokoban puzzles on a computer or phone.
Go to file
Kartik K. Agaram 752daaa6ea Merge template-carousel-mobile 2024-06-16 06:21:41 -07:00
assets initial Readme for sokoban.love 2024-03-10 23:19:52 -07:00
screens actually clear solver's crate X-( 2024-03-20 15:17:15 -07:00
0000-freewheeling-start new file-system format for freewheeling apps 2023-04-16 11:16:47 -07:00
0001-on wire up touch handlers 2023-12-26 09:22:19 -08:00
0002-Debug_animations_in_progress debug animations 2023-11-11 10:00:54 -08:00
0003-refresh_debug_animations debug animations 2023-11-11 10:00:54 -08:00
0004-on.update Merge carousel.love 2024-03-17 11:49:27 -07:00
0005-animate starting to experiment with animated pane transitions 2023-11-19 17:33:22 -08:00
0006-loiter starting to experiment with animated pane transitions 2023-11-19 17:33:22 -08:00
0007-save_callstack fix an outdated comment 2023-11-22 22:40:41 -08:00
0008-Debug_animation_period debug animations 2023-11-11 10:00:54 -08:00
0010-Line_height new fork: carousel shell 2023-11-15 06:06:56 -08:00
0011-on.initialize Merge carousel.love 2024-02-08 03:03:00 -08:00
0012-on.draw Merge carousel.love 2024-05-20 01:09:35 -07:00
0013-on.keychord_press Merge carousel.love 2024-02-25 00:26:08 -08:00
0014-on.text_input switch all handlers to run either the app or editor 2023-12-31 16:21:30 -08:00
0015-on.key_release switch all handlers to run either the app or editor 2023-12-31 16:21:30 -08:00
0016-on.mouse_press switch to a single global output editor 2023-12-31 22:51:04 -08:00
0017-on.mouse_release switch to a single global output editor 2023-12-31 22:51:04 -08:00
0019-Line_number_padding new fork: carousel shell 2023-11-15 06:06:56 -08:00
0020-draw_editor_border load stashed files 2024-03-17 14:38:42 -07:00
0021-draw_menu unstash a stashed file 2024-03-17 15:22:53 -07:00
0023-Menu_top start of the visual skeleton 2023-11-15 07:04:34 -08:00
0024-Menu_left start of the visual skeleton 2023-11-15 07:04:34 -08:00
0025-Menu_height start of the visual skeleton 2023-11-15 07:04:34 -08:00
0026-Menu_bottom start of the visual skeleton 2023-11-15 07:04:34 -08:00
0027-Menu_background mock up rest of menu bar and nav buttons 2023-11-15 09:02:22 -08:00
0028-draw_output_border bugfix: use border color in scrollbars 2023-12-01 20:19:27 -08:00
0029-Safe_width resize handler 2023-11-15 07:37:36 -08:00
0030-Safe_height resize handler 2023-11-15 07:37:36 -08:00
0031-on.resize extract functions for computing editor dimensions 2024-02-21 12:58:38 -08:00
0032-update_font_settings Merge carousel.love 2024-02-25 00:26:08 -08:00
0033-Normal_color bugfix: output border color 2023-11-15 13:07:01 -08:00
0034-draw_scrollbar bugfix: use border color in scrollbars 2023-12-01 20:19:27 -08:00
0035-compute_scrollbar Merge template-live-editor-mobile 2024-06-11 13:06:10 -07:00
0036-adjust_scrollbar bugfix: tapping in scrollbar area 2023-12-02 18:36:11 -08:00
0038-on_editor_scrollbar implement second, 'output' editor 2023-11-18 21:18:09 -08:00
0040-on_editor_scrollbar_area implement second, 'output' editor 2023-11-18 21:18:09 -08:00
0043-map implement 'Run' button 2023-11-18 19:42:26 -08:00
0045-Current_pane switch to a single global output editor 2023-12-31 22:51:04 -08:00
0046-Global_state aggregate global state inside a 'pane' object 2023-11-19 13:15:06 -08:00
0047-Current_pane_index implement carousel buttons for inserting/switching current pane 2023-11-19 13:37:41 -08:00
0048-Panes implement carousel buttons for inserting/switching current pane 2023-11-19 13:37:41 -08:00
0049-new_pane switch to a single global output editor 2023-12-31 22:51:04 -08:00
0050-print_to_output switch to a single global output editor 2023-12-31 22:51:04 -08:00
0051-run_button Merge carousel.love 2024-02-25 00:26:08 -08:00
0052-enable_loiter starting to experiment with animated pane transitions 2023-11-19 17:33:22 -08:00
0054-Animations_in_progress starting to experiment with animated pane transitions 2023-11-19 17:33:22 -08:00
0056-end_frame starting to experiment with animated pane transitions 2023-11-19 17:33:22 -08:00
0058-draw_next_frames_of_animations starting to experiment with animated pane transitions 2023-11-19 17:33:22 -08:00
0059-previous_pane_button Merge carousel.love 2024-02-25 00:26:08 -08:00
0060-next_pane_button Merge carousel.love 2024-02-25 00:26:08 -08:00
0061-new_pane_button screens now run 2023-12-31 16:59:34 -08:00
0063-Show_code add lots of buttons to the toolbar 2023-11-20 22:23:09 -08:00
0066-copy_button simplify state management for menus 2023-12-04 22:09:47 -08:00
0067-paste_button simplify state management for menus 2023-12-04 22:09:47 -08:00
0069-output_editor_state Merge template-live-editor-mobile 2023-12-29 15:26:57 -08:00
0070-code_editor_state extract functions for computing editor dimensions 2024-02-21 12:58:38 -08:00
0072-settings_button simplify state management for menus 2023-12-04 22:09:47 -08:00
0076-delete_pane_button screens now run 2023-12-31 16:59:34 -08:00
0079-White make pane index pop a little for Mike Stein 2023-11-20 23:46:22 -08:00
0080-Show_menu document Show_menu variable 2023-12-04 22:17:53 -08:00
0081-draw_settings_menu Merge template-live-editor-mobile 2024-01-15 02:52:26 -08:00
0082-draw_slider greatly simplify slider implementation 2023-12-16 23:41:49 -08:00
0083-slider greatly simplify slider implementation 2023-12-16 23:41:49 -08:00
0084-update_sliders bugfix: fix a first-frame crash in sliders 2023-12-19 10:43:04 -08:00
0085-slider_value sliders for font size and color settings 2023-11-21 02:19:56 -08:00
0086-mouse_press_consumed_by_any_slider greatly simplify slider implementation 2023-12-16 23:41:49 -08:00
0087-on_slider greatly simplify slider implementation 2023-12-16 23:41:49 -08:00
0090-Background_color sliders for font size and color settings 2023-11-21 02:19:56 -08:00
0091-Foreground_color bring back syntax highlighting (but so ugly) 2023-11-21 08:53:19 -08:00
0092-Settings_menu_area sliders for font size and color settings 2023-11-21 02:19:56 -08:00
0093-on_area bugfix: crash unless first mouse click on settings 2023-11-21 02:47:27 -08:00
0097-Font_height preserve settings across restart 2023-11-21 12:11:26 -08:00
0098-on.save_settings delete some unused code 2023-12-31 17:39:20 -08:00
0099-on.load_settings delete some unused code 2023-12-31 17:39:20 -08:00
0100-car support event handlers 2023-11-21 19:17:49 -08:00
0101-on.mouse_wheel_move switch to a single global output editor 2023-12-31 22:51:04 -08:00
0102-send_errors_to_output switch to a single global output editor 2023-12-31 22:51:04 -08:00
0104-call_protected escape hatch when print is overridden 2023-12-17 13:30:17 -08:00
0105-clear_handlers send errors from event handlers to output editor 2023-11-21 21:22:52 -08:00
0108-Overflow_button lay out buttons based on device dimensions 2023-11-22 12:38:16 -08:00
0109-overflow_button simplify state management for menus 2023-12-04 22:09:47 -08:00
0110-maybe_draw_overflow_button Merge template-live-editor-mobile 2024-01-15 02:52:26 -08:00
0111-populate_missing_handlers ignore all interactive handlers when editor is open 2023-11-24 21:14:41 -08:00
0114-update_output_editor switch to a single global output editor 2023-12-31 22:51:04 -08:00
0115-Title_font first draft of load/save buttons 2023-11-25 23:40:28 -08:00
0116-save_button some keyboard shortcuts on non-mobile devices 2024-02-22 18:27:39 -08:00
0117-load_button some keyboard shortcuts on non-mobile devices 2024-02-22 18:27:39 -08:00
0118-overflowable_button indicate local modifications in load/save dialog 2024-03-17 12:37:21 -07:00
0119-draw_file_dialog add numeric suffix to stashed files 2024-03-17 15:02:45 -07:00
0120-Show_file_dialog first draft of load/save buttons 2023-11-25 23:40:28 -08:00
0121-Directory Merge template-live-editor-mobile 2023-12-18 07:53:47 -08:00
0122-Directory_contents first draft of load/save buttons 2023-11-25 23:40:28 -08:00
0124-styled_button indicate local modifications in load/save dialog 2024-03-17 12:37:21 -07:00
0125-File_dialog_callback first draft of load/save buttons 2023-11-25 23:40:28 -08:00
0126-one_time_save load stashed files 2024-03-17 14:38:42 -07:00
0127-one_time_load load stashed files 2024-03-17 14:38:42 -07:00
0128-draw_file_dialog_input Merge template-live-editor-mobile 2024-01-15 02:52:26 -08:00
0129-draw_cursor type out a filename to load/save 2023-11-26 08:52:34 -08:00
0131-keychord_press_on_file_dialog type out a filename to load/save 2023-11-26 08:52:34 -08:00
0132-text_input_on_file_dialog type out a filename to load/save 2023-11-26 08:52:34 -08:00
0133-File_dialog_input_text type out a filename to load/save 2023-11-26 08:52:34 -08:00
0134-reset_file_dialog_state add numeric suffix to stashed files 2024-03-17 15:02:45 -07:00
0138-File_dialog_input_start_suffix type out a filename to load/save 2023-11-26 08:52:34 -08:00
0140-refresh_file_dialog_input_start Merge template-live-editor-mobile 2024-01-15 02:52:26 -08:00
0141-File_dialog_input_draw_suffix type out a filename to load/save 2023-11-26 08:52:34 -08:00
0142-right_justified_button Merge template-live-editor-mobile 2024-01-15 02:52:26 -08:00
0143-File_dialog_input_right_margin ok/cancel buttons in file dialog 2023-11-26 10:21:42 -08:00
0144-filenames_from_all_panes save the list of open files across restart 2023-11-26 12:26:22 -08:00
0145-Initial_load_filenames save the list of open files across restart 2023-11-26 12:26:22 -08:00
0146-load_panes_from_previous_session save the list of open files across restart 2023-11-26 12:26:22 -08:00
0147-Highlighted_button_color activate buttons for some time 2023-12-01 20:07:20 -08:00
0148-Active_button activate buttons for some time 2023-12-01 20:07:20 -08:00
0149-Border_color bugfix: use border color in scrollbars 2023-12-01 20:19:27 -08:00
0150-Button_pressed partition handlers between screen regions 2023-12-01 20:59:22 -08:00
0151-compute_scrollbar_topy bugfix: tapping in scrollbar area 2023-12-02 18:36:11 -08:00
0152-Real_print escape hatch when print is overridden 2023-12-17 13:30:17 -08:00
0154-on.mouse_move new handler: mousemoved 2023-12-25 14:37:06 -08:00
0155-on.touch_press shield script from touch events when showing editor 2024-03-22 17:29:29 -07:00
0156-on.touch_release shield script from touch events when showing editor 2024-03-22 17:29:29 -07:00
0157-on.touch_move shield script from touch events when showing editor 2024-03-22 17:29:29 -07:00
0158-Font_filename provide a place to set the font 2024-02-06 14:56:53 -08:00
0158-on.quit switch all handlers to run either the app or editor 2023-12-31 16:21:30 -08:00
0159-eval_all screens now run 2023-12-31 16:59:34 -08:00
0159-run_screen use an available constant 2024-03-17 11:56:42 -07:00
0160-run_app bugfix: don't run car.load on syntax errors 2024-03-12 23:48:34 -07:00
0161-press_run_button Merge carousel.love 2024-02-25 00:26:08 -08:00
0161-stop_app run script on startup; new button to switch to source editor 2023-12-31 21:45:12 -08:00
0162-Output_editor_state switch to a single global output editor 2023-12-31 22:51:04 -08:00
0162-press_stop_button add keyboard shortcuts for common operations 2024-02-21 06:45:37 -08:00
0163-press_show_button add keyboard shortcuts for common operations 2024-02-21 06:45:37 -08:00
0164-press_hide_button add keyboard shortcuts for common operations 2024-02-21 06:45:37 -08:00
0165-press_save_button load stashed files 2024-03-17 14:38:42 -07:00
0166-press_load_button load stashed files 2024-03-17 14:38:42 -07:00
0167-press_next_pane_button Merge carousel.love 2024-02-25 00:26:08 -08:00
0168-press_previous_pane_button Merge carousel.love 2024-02-25 00:26:08 -08:00
0169-editor_right_margin extract functions for computing editor dimensions 2024-02-21 12:58:38 -08:00
0171-code_editor_bottom_margin extract functions for computing editor dimensions 2024-02-21 12:58:38 -08:00
0172-Tooltip_background some keyboard shortcuts on non-mobile devices 2024-02-22 18:27:39 -08:00
0173-Tooltip_foreground some keyboard shortcuts on non-mobile devices 2024-02-22 18:27:39 -08:00
0174-Is_mobile some keyboard shortcuts on non-mobile devices 2024-02-22 18:27:39 -08:00
0175-show_tooltip some keyboard shortcuts on non-mobile devices 2024-02-22 18:27:39 -08:00
0176-on.quit explicitly state stance on autosave 2024-03-17 10:49:45 -07:00
0177-Window_in_focus bugfix 2024-05-20 00:40:05 -07:00
0177-has_local_modifications stop using nativefs for file location 2024-03-23 09:01:41 -07:00
0178-on.focus only show tooltips when window in focus 2024-05-19 22:27:19 -07:00
0178-revert_button start implementing stashed files 2024-03-17 13:54:20 -07:00
0179-Mouse_on_window fix a long-standing issue with tooltips 2024-05-20 00:47:43 -07:00
0179-press_revert_button new menu option: revert local changes 2024-03-17 12:12:31 -07:00
0180-Local_modifications_color start implementing stashed files 2024-03-17 13:54:20 -07:00
0180-on.mouse_focus fix a long-standing issue with tooltips 2024-05-20 00:47:43 -07:00
0181-local_modifications_color indicate local modifications in load/save dialog 2024-03-17 12:37:21 -07:00
0182-Stash_color start implementing stashed files 2024-03-17 13:54:20 -07:00
0183-stash_button start implementing stashed files 2024-03-17 13:54:20 -07:00
0184-Stash_directory start implementing stashed files 2024-03-17 13:54:20 -07:00
0185-stash_pane add numeric suffix to stashed files 2024-03-17 15:02:45 -07:00
0186-press_stash_button start implementing stashed files 2024-03-17 13:54:20 -07:00
0187-directory_contents start implementing stashed files 2024-03-17 13:54:20 -07:00
0188-add_files_to_dialog load stashed files 2024-03-17 14:38:42 -07:00
0189-add_stash_files_to_dialog load stashed files 2024-03-17 14:38:42 -07:00
0190-next_stash_filename add numeric suffix to stashed files 2024-03-17 15:02:45 -07:00
0191-unstash_button unstash a stashed file 2024-03-17 15:22:53 -07:00
0192-press_unstash_button unstash a stashed file 2024-03-17 15:22:53 -07:00
0193-unstash_pane unstash a stashed file 2024-03-17 15:22:53 -07:00
0194-unstash_filename unstash a stashed file 2024-03-17 15:22:53 -07:00
0195-can_be_unstashed stop using nativefs for file location 2024-03-23 09:01:41 -07:00
LICENSE.txt add a license 2022-05-16 18:51:28 -07:00
Manual_tests.md Merge template-live-editor-mobile 2023-12-07 01:23:34 -08:00
MemoryReferenceInfo.lua.0 remove some memory leaks from rendered fragments 2022-06-10 11:16:41 -07:00
MemoryReferenceInfo.lua.unused clean up memory leak experiments 2022-06-10 13:46:59 -07:00
README.md fix a crash involving mouse and drawings 2024-06-09 13:17:55 -07:00
app.lua Merge template-live-editor-mobile 2024-06-11 13:06:10 -07:00
button.lua remove one fiddly bit we no longer need 2024-05-20 00:52:48 -07:00
colorize.lua bring back syntax highlighting (but so ugly) 2023-11-21 08:53:19 -08:00
conf.lua Merge template-carousel-mobile 2024-03-15 23:38:52 -07:00
default_map rename a function 2023-12-01 21:00:38 -08:00
edit.lua Merge template-live-editor-mobile 2024-06-16 06:12:08 -07:00
file.lua hoist next_save to all saves 2024-03-17 10:54:26 -07:00
json.lua forgot to add json.lua 2022-05-15 14:36:25 -07:00
keychord.lua support for num pad 2023-07-07 18:40:12 -07:00
live.lua Merge template-live-editor-mobile 2023-12-18 11:44:55 -08:00
main.lua Merge carousel.love 2024-05-20 00:04:55 -07:00
nativefs.lua cleaner API for file-system access 2023-08-30 19:04:06 -07:00
reference.md Merge template-live-editor-mobile 2024-06-16 06:12:08 -07:00
search.lua Merge template-live-editor-mobile 2024-06-11 13:06:10 -07:00
select.lua Merge template-live-editor-mobile 2024-06-11 13:06:10 -07:00
test.lua show another detail on test failure 2023-01-20 21:48:49 -08:00
text.lua Merge template-live-editor-mobile 2024-06-11 13:06:10 -07:00
text_tests bugfix: clear selection when clicking above or below lines 2023-09-20 13:39:29 -07:00
text_tests.lua Merge template-live-editor 2024-06-11 12:56:22 -07:00
undo.lua fix a couple of asserts missed in the recent audit 2023-12-09 09:22:45 -08:00
wav.lua bundle support for .wav files 2023-12-19 11:16:07 -08:00

README.md

Sokoban

screenshot

A cross-platform, hackable app for playing 300 publicly available Sokoban puzzles. Runs on Windows, Mac, Linux, Android and iOS. You can edit the game and UI right on your device.

To modify the editing environment itself or repurpose it for other apps, open it on a desktop environment. The environment itself can be modified as it runs.

In early release; please report issues, particularly with usability or accessibility.

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.

Run the app using LÖVE.

Hacking

You can edit the game and UI right on your device. However, there are some gotchas to be aware of.

  • If you upgrade LÖVE you lose all your local apps and their saved settings. This includes code changes. It's hard to get code changes out due to mobile restrictions. I can't come up with an alternative to copy-paste. This imposes a strict limit on the number of changes I'm willing to make to a large app on my phone.

  • If you upgrade such apps after making local changes to them, you might see strange errors. Local changes are written to an overlay directory, whereas upgrades modify the app in place. The two locations create lots of opportunity for conflicts to arise.

    To mitigate this issue, such apps by default list local changes in the output editor every time they run. That will hopefully act as a reminder. There's also some helpers for deleting local changes in the 'scratch' page.

You can also modify the editing environment itself, or repurpose it for a different app entirely, live as it runs. This requires running it on a computer, but is much more reliable. Download the driver app. Here's an example session showing the driver (left window) editing a different app (right window containing yellow text):

making changes without restarting the app

Some reference documentation on how to create your own apps.

If the app being modified by the driver lives in a .love file, your changes will go into the save directory. If it lives in a directory (like this repo), your changes will go straight into the same directory.

Keyboard shortcuts

Within the editor widget:

  • 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

  • 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.

  • Some colors can't be customized yet.

Contributors

Many thanks to Michal Zalewski for creating the sprites and curating all the puzzles.

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 the template repo for mobile freewheeling apps. 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.