MiSTer FPGA: Difference between revisions

Revision as of 02:55, 14 July 2024

Installation

Download TapTo and copy it to the Scripts folder on your MiSTer's SD card.

Once installed, run tapto from the MiSTer Scripts menu, a prompt will offer to enable TapTo as a startup service, then the service will be started in the background.

After the initial setup is complete, a status display will be shown. It's OK to exit this screen, the service will continue to run in the background.

Downloader and Update All

TapTo is available in Update All by enabling the MiSTer Extensions repository in the Tools & Scripts menu.

If you only want TapTo, add the following text to the downloader.ini file on your MiSTer:

[mrext/tapto]
db_url = https://github.com/wizzomafizzo/tapto/raw/main/scripts/mister/repo/tapto.json

Main Alternative

An alternative version of the MiSTer Main application is also available by spark2k06, which adds many great TapTo related features to the core of MiSTer. It's already being used by many people in the community, and is easy to install.

Features include:

Rich game loading screens, show cover art on screen when a game is launched.
Custom TapTo standby screen when waiting for a token to be inserted.
Detection of TapTo in settings and status icons of main menu.
TapTo integration with ao486 and PCXT cores.
New MGL file tags for customising loading experience.

Please check spark2k06's repository for more details.

It can be installed and updated automatically through Downloader by changing the [distribution_mister] section of downloader.ini like this:

[distribution_mister]
db_url = https://aitorgomez.net/static/mistermain/db.json.zip

This will not affect any other system files besides the Main binary.

Hardware Setup

Your reader may work out of the box with no extra configuration. Run tapto from the Scripts menu, plug it in, and check if it shows as connected in the log view.

If TapTo is unable to auto-detect your device, it may be necessary to manually configure the reader setting:

[tapto]
reader="pn532_uart:/dev/ttyUSB0"

Be aware the ttyUSB0 part may be different if you have other devices connected such as tty2oled. For a list of possible devices try:

ls /dev/serial/by-id or ls /dev | grep ttyUSB

Mappings Database

	The nfc.csv is deprecated and will only ever be supported on the MiSTer platform. It will continue working for the immediate future, but it won't support any new mappings features. It's recommended to use the new mappings database instead.

TapTo supports an nfc.csv file in the top of the SD card. This file can be used to override the text read from a tag and map it to a different text value. This is useful for mapping Amiibos which are read-only, testing text values before actually writing them, and is necessary for using the command custom command by default.

Create a file called nfc.csv in the top of the SD card, with this as the header:

match_uid,match_text,text

You'll then need to either power cycle your MiSTer or restart the TapTo service.

After the file is created, the service will automatically reload it every time it's updated.

Here's an example nfc.csv file that maps several Amiibos to different functions:

match_uid,match_text,text
04e5c7ca024980,,**command:reboot
04078e6a724c80,,_#Favorites/Final Fantasy VII.mgl
041e6d5a983c80,,_#Favorites/Super Metroid.mgl
041ff6ea973c81,,_#Favorites/Legend of Zelda.mgl

Only one match_ column is required for an entry, and the match_uid can include colons and uppercase characters. You can get the UID of a tag by checking the output in the taptui Script display or on your phone.

@@ Line 34: / Line 34: @@
 Your reader may work out of the box with no extra configuration. Run <code>tapto</code> from the <code>Scripts</code> menu, plug it in, and check if it shows as connected in the log view.
-If you are using a PN532 NFC module connected with a USB to serial cable, then the following config may be needed in <code>tapto.ini</code> in the <code>Scripts</code> folder:<syntaxhighlight lang="ini">
+If TapTo is unable to auto-detect your device, it may be necessary to manually configure the reader setting:<syntaxhighlight lang="ini">
 [tapto]
-probe_device=yes
+reader="pn532_uart:/dev/ttyUSB0"
-allow_commands=no
-</syntaxhighlight>Create this file if it doesn't exist.
-If TapTo is unable to auto-detect your device, it may be necessary to manually configure the connection string:<syntaxhighlight lang="ini">
-[tapto]
-connection_string="pn532_uart:/dev/ttyUSB0"
-allow_commands=no
 </syntaxhighlight>Be aware the ttyUSB0 part may be different if you have other devices connected such as [https://github.com/venice1200/MiSTer_tty2oled tty2oled]. For a list of possible devices try:
 <code>ls /dev/serial/by-id</code> or <code>ls /dev | grep ttyUSB</code>
-== Configuration File ==
-TapTo supports a <code>tapto.ini</code> file in the <code>Scripts</code> folder. This file can be used to configure the TapTo service.
-If one doesn't exist, create a new one. This example has all the default values:<syntaxhighlight lang="ini">
-[tapto]
-connection_string=""
-allow_commands=no
-disable_sounds=no
-probe_device=yes
-exit_game=no
-</syntaxhighlight>All lines except the <code>[tapto]</code> header are optional.
-=== Connection String (connection_string) ===
-{| class="wikitable"
-!Key
-!Default Value
-|-
-|<code>connection_string</code>
-|
-|}
-See [[MiSTer#Hardware Setup|Hardware Setup]] for details. This option is for configuration of [https://github.com/nfc-tools/libnfc libnfc].
-=== Allow Shell Commands From Tokens (allow_commands) ===
-{| class="wikitable"
-!Key
-!Default Value
-|-
-|<code>allow_commands</code>
-|no
-|}
-Enables the [[Token Commands|shell]] custom command to be triggered from a tag.
-By default this is disabled and only works from the [[Mappings|Mappings Database]] described below.
-=== Disable Sounds After a Read (disable_sounds) ===
-{| class="wikitable"
-!Key
-!Default Value
-|-
-|<code>disable_sounds</code>
-|no
-|}
-Disables the success and fail sounds played when a tag is read by the reader.
-=== Probe for Serial Devices (probe_device) ===
-{| class="wikitable"
-!Key
-!Default Value
-|-
-|<code>probe_device</code>
-|yes
-|}
-Enables auto-detection of a serial based reader device.
-=== Exit Game When Token Is Removed (exit_game) ===
-{| class="wikitable"
-!Key
-!Default Value
-|-
-|<code>exit_game</code>
-|no
-|}
-Enables exiting the current game when a token is removed from the reader.
-{{Warn|This does not trigger a save file to be written in MiSTer, you have to do that manually.}}
-=== Exit Game Core Blocklist (exit_game_blocklist) ===
-{| class="wikitable"
-!Key
-!Default Value
-|-
-|<code>exit_game_blocklist</code>
-|
-|}
-A comma separated list of cores to ignore the <code>exit_game</code> option for. For example, to ignore the <code>exit_game</code> option for the NES and SNES cores:<syntaxhighlight lang="ini">
-[tapto]
-exit_game=yes
-exit_game_blocklist=NES,SNES
-</syntaxhighlight>With this configuration, removing a token will not exit the game when using the NES or SNES cores, but will for all other cores.
-The core name is the same as the name that shows on the left sidebar of the OSD when in a core.
-=== Exit Game Delay (exit_game_delay) ===
-{| class="wikitable"
-!Key
-!Default Value
-|-
-|<code>exit_game_delay</code>
-|0
-|}
-A number, in seconds, that TapTo will wait between the removal of the card and reloading the menu core. Requires <code>exit_game</code> set to yes. This parameter is useful if you want to swap games without reloading the menu core. If a new card is tapped before the menu core is loaded, the command on the card will be executed immediately and the menu core loading will be cancelled.<syntaxhighlight lang="ini">
-[tapto]
-exit_game=yes
-exit_game_delay=6
-</syntaxhighlight>
 == Mappings Database ==
+{{Warn|The nfc.csv is deprecated and will only ever be supported on the MiSTer platform. It will continue working for the immediate future, but it won't support any new mappings features. It's recommended to use the new mappings database instead.}}
 TapTo supports an <code>nfc.csv</code> file in the top of the SD card. This file can be used to override the text read from a tag and map it to a different text value. This is useful for mapping Amiibos which are read-only, testing text values before actually writing them, and is necessary for using the <code>command</code> custom command by default.
 Create a file called <code>nfc.csv</code> in the top of the SD card, with this as the header:
   <code>match_uid,match_text,text</code>
-You'll then need to either power cycle your MiSTer, or restart the TapTo service by running <code>tapto</code> from the <code>Scripts</code> menu, selecting the <code>Stop</code> button, then the <code>Start</code> button.
+You'll then need to either power cycle your MiSTer or restart the TapTo service.
 After the file is created, the service will automatically reload it every time it's updated.
@@ Line 158: / Line 57: @@
 e6d5a983c80,,_#Favorites/Super Metroid.mgl
 ff6ea973c81,,_#Favorites/Legend of Zelda.mgl</code>
-Only one <code>match_</code> column is required for an entry, and the <code>match_uid</code> can include colons and uppercase characters. You can get the UID of a tag by checking the output in the <code>tapto</code> Script display or on your phone.
+Only one <code>match_</code> column is required for an entry, and the <code>match_uid</code> can include colons and uppercase characters. You can get the UID of a tag by checking the output in the <code>taptui</code> Script display or on your phone.