Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update taptui.sh script to work with new API #114

Open
wizzomafizzo opened this issue Nov 10, 2024 · 7 comments
Open

Update taptui.sh script to work with new API #114

wizzomafizzo opened this issue Nov 10, 2024 · 7 comments
Assignees
Labels
help wanted Extra attention is needed

Comments

@wizzomafizzo
Copy link
Member

Current version of taptui script used the old REST API which no longer exists. All REST calls must be replaced with an equivalent call to the new API, which can with with the tapto.sh -api ... commands.

API CLI command: https://tapto.wiki/Command_Line_Interface#API_Request
API https://tapto.wiki/API

@asturur asturur self-assigned this Nov 10, 2024
@wizzomafizzo
Copy link
Member Author

@asturur
Copy link
Collaborator

asturur commented Nov 10, 2024

is tapto.sh -api

  • a necessity
  • a preference
  • an possibility

?

@wizzomafizzo
Copy link
Member Author

is tapto.sh -api

  • a necessity
  • a preference
  • an possibility

?

no preference. it's an easy way to access a websocket client that handles the json-rpc protocol already. i'm not sure if anything ships on mister or not.

my understanding is a combination of that command and the jq command would drop in replace all the broken stuff

@wizzomafizzo wizzomafizzo added the help wanted Extra attention is needed label Nov 15, 2024
@Tom-Neverwinter
Copy link

I cannot access either of these pages:

API CLI command: https://tapto.wiki/Command_Line_Interface#API_Request
API https://tapto.wiki/API

attempted to change address to zaparoo instead of tapto

@wizzomafizzo
Copy link
Member Author

I cannot access either of these pages:

API CLI command: https://tapto.wiki/Command_Line_Interface#API_Request API https://tapto.wiki/API

attempted to change address to zaparoo instead of tapto

Thanks for mentioning. Links should work now. I've made the redirect smarter.

@wizzomafizzo
Copy link
Member Author

wizzomafizzo commented Jan 12, 2025

Important features:

  • Write custom text to token (see -write CLI flag)
  • Read token (without running the token, see -read CLI flag)
  • Search game and write to token (see media.search API method)
  • Basic settings options (tap/hold mode toggle, toggle audio, etc. just stick to the basic stuff, it's ok to make the user open the config file for advanced settings, UI is a waste of time)
  • Update games db

Nice to haves that taptui had but not showstoppers:

  • System filter on search (is just an option on media.search, but you'll have to also query the systems method for list of system)
  • Browse games and write to token (not supported by the API right now though or any way to filter search by paths)
  • Mappings viewer and creator (via API, not the mappings files)
  • Helpers for writing some zapscript commands (I think just launch.random tbh, option to write this and select the system from a list) and listing suggestions to write (like a quick reference and picker of commands available)
  • Amiibo lookup when creating mappings (was a completely custom solution in taptui using an online amiibo db, it would be nice if this could be integrated into core properly and referenced from the API or something idk)
  • Reference for how much space some text would take up on a token (may not be possible right now until the API is more descriptive about token type)

One thing taptui didn't have was an on-screen keyboard for text input and could generally be a bit awkward using a controller. These would be great but not important. Very fiddly job making an on screen keyboard.

Needs to fit on a CRT. Would be cool if it could be responsive but idk how to reliably check that and it's not important.

@wizzomafizzo
Copy link
Member Author

Also, some perspective on me wanting to keep the config simple. One of the reasons I switched to the toml config format is so a lot more complex config can be defined, because that means we can add complicated features under the expectation that a power user is going to take the time to learn how to write the config themselves from documentation or another user

I don't want to be in a situation where I want to add or change some tricky/niche feature but I can't because I also have to accommodate it in a TUI or even the app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants