Skip to content

api: add card lookup endpoint - #891

Merged
bicarus-dev merged 1 commit into
spice2x:mainfrom
Avimitin:card-api
Aug 25, 2026
Merged

bicarus-dev merged 1 commit into
spice2x:mainfrom
Avimitin:card-api

Conversation

@Avimitin

@Avimitin Avimitin commented Aug 24, 2026 •

Copy link
Copy Markdown
Contributor

Link to GitHub Issue or related Pull Request, if one exists

N/A

Description of change

I am developing spice.nimabe.net, a static frontend for SpiceAPI. It already supports generating and inserting new card IDs, but SpiceAPI does not provide a way to discover cards already configured on the game machine.

This makes the frontend inconvenient for existing users who generated and saved their card IDs locally. They currently have to open each card file on the game machine and manually copy its ID into the frontend.

This change adds a card.get_cards API function that enumerates the current cards for readers supported by the running game. Each entry contains:

  • reader index
  • canonical 16-character card ID
  • source, set to file or override
  • file_name for file-backed cards

File-backed cards expose only the save-file basename. Active -card0 and -card1 values are returned with source: "override" and no file_name, instead of representing an override as a file. spicefe derives the useful default import names card0 and card1 from the reader index. Reader enumeration uses eamuse_get_game_keypads() so games with only one reader do not expose a second card.

This allows spicefe and other API clients to offer one-click import for existing cards, without requiring users to manually find and copy their card IDs.

Because card IDs are sensitive, card.get_cards can only be used when the operator has configured an API password. No full filesystem path is exposed. Missing, unreadable, and invalid cards are omitted.

The existing card.insert function remains unchanged. To avoid requiring a password for the whole card module, this change adds support for password requirements on individual API functions while preserving existing module-wide password behavior.

Access to configured card paths and runtime card overrides is synchronized because API requests may read them concurrently with configuration updates.

The Python and Dart API wrappers and README documentation have been updated for the new function and source metadata.

Testing

  • Ran the complete src/spice2x/build_docker.sh build successfully.
  • Built all required 32-bit and 64-bit targets.
  • Built the Windows XP-compatible 32-bit targets.
  • Passed static import checks.
  • Passed Windows 7 and Windows XP compatibility checks.
  • Completed release packaging successfully.
  • Verified both updated Dart wrappers are correctly formatted.
  • Ran all 106 spicefe tests successfully.
  • git diff --check passes.

This implementation was prepared with assistance from OpenAI Codex.

@Avimitin

Avimitin commented Aug 25, 2026 •

Copy link
Copy Markdown
Contributor Author

Does this include the card IDs provided via -card0 and -card1 args?

Now included, command-line override will now returns correspond default filename card0 or card1. Changes are squashed and fixup. All requested changes are applied.

Add card.get_cards() to return the effective card ID and source for
each reader supported by the current game. Identify each source as file
or override, include the basename only for file-backed cards, and expose
-card0 and -card1 overrides without treating them as files.

Only allow the function when an API password is configured because card
IDs should not be exposed to unauthenticated network clients. This lets
static frontends such as spice.nimabe.net import existing cards without
requiring users to open files on the game machine and copy IDs manually.
@bicarus-dev
bicarus-dev merged commit dad88ca into spice2x:main Aug 25, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant