MiSTer FPGA: Difference between revisions

From TapTo Wiki

 
Line 1: Line 1:
[https://mister-devel.github.io/MkDocs_MiSTer/ MiSTer FPGA] is an open source project which emulates retro console, computers and arcade machines using an FPGA board called the DE10-Nano. MiSTer is fully supported by TapTo as a platform, and originally started as a project on MiSTer. TapTo has several [[TapScript#MiSTer|MiSTer-exclusive commands]] because of this.
== Installation ==
== Installation ==
Download [https://github.com/wizzomafizzo/tapto/releases/latest/ TapTo] and copy it to the <code>Scripts</code> folder on your MiSTer's SD card.
Download [https://github.com/wizzomafizzo/tapto/releases/latest/ TapTo] and copy it to the <code>Scripts</code> folder on your MiSTer's SD card.
Line 13: Line 15:
db_url = https://github.com/TapToCommunity/tapto/raw/main/scripts/mister/repo/tapto.json
db_url = https://github.com/TapToCommunity/tapto/raw/main/scripts/mister/repo/tapto.json
</syntaxhighlight>
</syntaxhighlight>
=== Main Alternatives ===


==== aitorgomez ====
== Known Issues ==
 
* TapTo can have conflicts with other devices that use serial USB connections such as the [https://github.com/venice1200/MiSTer_tty2oled tty2oled project] and anything else using an Arduino board. Current workaround is to disable [[Config File (tapto.ini)#Device Auto-detection (probe device)|probe_devices in the tapto.ini]] file and manually set the [[Config File (tapto.ini)#Manual Reader Connection (reader)|reader path]]. '''This is planned to be fixed in TapTo v2.'''
* Neo Geo game files are only supported in TapTo search with the <code>.neo</code> format, not in <code>.zip</code> or folder format which are also supported by MiSTer. Writing these directly to a token and launching is supported (e.g. <code>NeoGeo/mslug</code> or <code>NeoGeo/mslug.zip</code>). This will be fixed but not in the immediate future.
 
== Main Alternatives ==
 
=== aitorgomez ===
[[File:GomezLoadingscreen.png|thumb|Example of TapTo features in fork]]
An alternative version of MiSTer Main is available by [https://aitorgomez.net/ spark2k06], which adds many great TapTo related features to the core of MiSTer:
An alternative version of MiSTer Main is available by [https://aitorgomez.net/ spark2k06], which adds many great TapTo related features to the core of MiSTer:


Line 25: Line 34:
Please check [https://github.com/spark2k06/Main_MiSTer spark2k06's repository] for more details.
Please check [https://github.com/spark2k06/Main_MiSTer spark2k06's repository] for more details.


=== Hardware Setup ===
=== Insert-Coin ===
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.
An alternative version of MiSTer Main is also available by [https://github.com/funkycochise funkycochise] as part of the [https://github.com/funkycochise/Insert-Coin Insert-Coin project]. This version includes a feature to hide the loading screen before cores start games, which works great with TapTo!
 
If TapTo is unable to auto-detect your device, it may be necessary to manually configure the reader setting:<syntaxhighlight lang="ini">
[tapto]
reader="pn532_uart:/dev/ttyUSB0"
</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>


== Mappings Database ==
== Legacy 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.}}
{{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.
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.

Latest revision as of 02:27, 3 October 2024

MiSTer FPGA is an open source project which emulates retro console, computers and arcade machines using an FPGA board called the DE10-Nano. MiSTer is fully supported by TapTo as a platform, and originally started as a project on MiSTer. TapTo has several MiSTer-exclusive commands because of this.

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's SD card root:

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

Known Issues

  • TapTo can have conflicts with other devices that use serial USB connections such as the tty2oled project and anything else using an Arduino board. Current workaround is to disable probe_devices in the tapto.ini file and manually set the reader path. This is planned to be fixed in TapTo v2.
  • Neo Geo game files are only supported in TapTo search with the .neo format, not in .zip or folder format which are also supported by MiSTer. Writing these directly to a token and launching is supported (e.g. NeoGeo/mslug or NeoGeo/mslug.zip). This will be fixed but not in the immediate future.

Main Alternatives

aitorgomez

Example of TapTo features in fork

An alternative version of MiSTer Main is available by spark2k06, which adds many great TapTo related features to the core of MiSTer:

  • Show status of connected reader as icon in top bar.
  • TapTo standby screen.
  • Box art on game load.
  • Many additional MGL features.

Please check spark2k06's repository for more details.

Insert-Coin

An alternative version of MiSTer Main is also available by funkycochise as part of the Insert-Coin project. This version includes a feature to hide the loading screen before cores start games, which works great with TapTo!

Legacy 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.