Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AavaGames/playdate-keyboard-based-menu-ui
https://github.com/AavaGames/playdate-keyboard-based-menu-ui
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/AavaGames/playdate-keyboard-based-menu-ui
- Owner: AavaGames
- License: mit
- Created: 2024-03-25T19:19:14.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-03-26T14:09:42.000Z (8 months ago)
- Last Synced: 2024-08-01T23:30:50.308Z (4 months ago)
- Language: Lua
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-playdate - Keyboard Based Menu - A menu that uses the playdate's keyboard to navigate and select. (Game Development / Programming Frameworks & Languages)
README
# Keyboard Based Menu
A menu that uses the playdate's keyboard to navigate and select. Created as an aesthetic homage to traditional roguelikes!
## Features
### Commands, Bool, Options
Create menu items just like the playdate's menu system. Tie your callbacks and tweak your parameters to close the keyboard, menu/page or all menus when the item is selected.
### Automatic Nested Pages
If your menu has too many options and will overflow the space it has, it will automatically create a sub page at the bottom.
### Formats to your Font
Whatever font you give it will automatically adjust its dimensions to fit it properly.
### LuaCATS Syntax
Added type and constructor definitions for LuaCATS used by [Lua Language Server](https://github.com/LuaLS/lua-language-server) for the [sumneko.lua VSCode extension](https://marketplace.visualstudio.com/items?itemName=sumneko.lua). Highly recommend using with [Playdate-LuaCATS by notpeter](https://github.com/notpeter/playdate-luacats/).
## Limitations
- You cannot change the font after the menu is created, you will need to recreate the menu if you wish to change the font.
## Showcase / Example Project
Try it out on the Playdate [(download pdx)](https://github.com/AavaGames/playdate-keyboard-based-menu-ui-example/releases/tag/1.0) and peruse some code at this git
https://github.com/AavaGames/playdate-keyboard-based-menu-ui-example
## Installation
1. Download the repo
2. Add the `keyboard-based-menu` folder to your project
3. import `SOURCEFOLDER\keyboard-based-menu\imports`
4. Now you can create a MenuManager singleton and open Menus!
## Use
Look through main.lua [here](https://github.com/AavaGames/playdate-keyboard-based-menu-ui-example) to get a real example of its use.
1. Create a MenuManager singleton
1. Pass in your callback for what to do when a menu opens from gameplay and when all menus close. Example: Change GameManager state to menu so gameplay update stops running.
2. Create a Menu: pass it the menu manager, a name and its items.
3. `menu:open()`
### Menu Item
```lua
--[[
Initializes a menu item.
Parameters:
text (string): The text of the menu item.
assignedGlyph (string): The preferred assigned glyph for the menu item. Nil assigns the next in the keyboard sequence. First come, first serve. To skip use nil or empty string ""
closeKeyboardOnSelect (boolean): Whether to close the keyboard on selection.
closeMenuOnSelect (boolean): Whether to close the menu on selection.
allMenus (boolean): Whether to close all menus on selection. Requires closeMenuOnSelect.
selectionFunction (function): The function to execute when the menu item is selected.
]]
```