Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nagydani/loveputer
A console-based Lua-programmable computer for children based on löve2d framework.
https://github.com/nagydani/loveputer
android cli education lua
Last synced: 3 months ago
JSON representation
A console-based Lua-programmable computer for children based on löve2d framework.
- Host: GitHub
- URL: https://github.com/nagydani/loveputer
- Owner: nagydani
- License: gpl-3.0
- Created: 2023-06-22T16:49:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-10T19:32:42.000Z (8 months ago)
- Last Synced: 2024-10-06T16:40:58.674Z (4 months ago)
- Topics: android, cli, education, lua
- Language: Lua
- Homepage:
- Size: 2.17 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# loveputer
A console-based Lua-programmable computer for children based on [LÖVE2D] framework.
## Principles
- Command-line based UI
- Full control over each pixel of the display
- Ability to easily reset to initial state
- Impossible to damage with non-violent interaction
- Syntactic mistakes caught early, not accepted on input
- Possibility to test/try parts of program separately
- Share software in source package form
- Minimize frustration
# Usage
Rather than the default LÖVE storage locations (save directory, cache, etc), the
application uses a folder under _Documents_ to store projects. Ideally, this is
located on removable storage to enable sharing programs the user writes.
For simplicity and security reasons, the user is only allowed to access files
inside a project. To interact with the filesystem, a project must be selected
first.
## Keys
| Command | Keymap |
| :---------------------------------------------------------------- | :-------------------------------------------- |
| Clear terminal | Ctrl+L |
| Quit project | Ctrl+Shift+Q |
| Reset application to initial state | Ctrl+Shift+R |
| Exit application | Ctrl+Esc |
| Pause application | Ctrl+Pause |
| **Input** |
| Move cursor horizontally | ⇦⇨ |
| Move cursor vertically | ⇧⇩ |
| Go back in command history | PageUp |
| Go forward in command history | PageDown |
| Move in history (if in first/last line) | ⇧⇩ |
| Jump to start | Home |
| Jump to end | End |
| Jump to line start | Alt+Home |
| Jump to line end | Alt+End |
| Insert newline | Shift+Enter |
| Evaluate input | Enter |
| **Editor** |
| _same as Input, except for:_ |
| Scroll up | PageUp |
| Scroll down | PageDown |
| Move selection (if in first/last line) | ⇧⇩ |
| Replace selection with input | Enter |
| _additionally_ |
| Delete selected (line) | Ctrl+Delete |
| | Ctrl+Y |
| Replace input with selected content | Esc |
| Insert selected content into input | Shift+Esc |
| Scroll to start | Ctrl+PageUp |
| Scroll to end | Ctrl+PageDown |
| Scroll up by one line | Ctrl+PageUp |
| Scroll down by one line | Ctrl+PageDown |
| Move selection to start | Ctrl+Home |
| Move selecion to end | Ctrl+End |
| Quit editor (save work) | Ctrl+Shift+Q |
### Projects
A _project_ is a folder in the application's storage which contains at least a
`main.lua` file.
Projects can be loaded and ran. At any time, pressing Ctrl-Shift-Q
quits and returns to the console
- `list_projects()`
List available projects.
- `project(proj)`
Open project _proj_ or create a new one if it doesn't exist.
New projects are supplied with example code to demonstrate the structure.
- `current_project()`
Print the currently open project's name (if any).
- `run_project(proj?)`
Run either _proj_ or the currently open project if no arguments are passed.
- `example_projects()`
Copy the included example projects to the projects folder.
- `close_project()`
Close currently opened project.
- `edit(file)`
Open file in editor. If it does not exist yet, a new file will be created.
See [Editor mode](#editor)
### Files
Once a project is open, file operations are available on it's contents.
- `list_contents()`
List files in the project.
- `readfile(file)`
Open _file_ and display it's contents.
- `writefile(file, content)`
Write to _file_ the text supplied as the _content_ parameter. This can be
either a string, or an array of strings.
- `runfile(file)`
Run _file_ if it's a lua script.
### Editor
