Config file (tapto.ini): Difference between revisions

Revision as of 01:10, 8 July 2024

The TapTo config file is a file stored alongside the TapTo executable called tapto.ini, which holds all permanent configuration options for TapTo. It uses the INI file format and is the same across all platforms support for TapTo. If the TapTo service must be restarted if changes are made to this file, so it can reload and apply the new settings.

A default config looks like this:

[tapto]
reader =
allow_commands = no
disable_sounds = no
probe_device = yes
exit_game = no
exit_game_blocklist =
exit_game_delay = 0
debug = no
api_port = 7497
api_basic_auth =

[systems]
games_folder =
set_core =

This config is effectively the same as a missing or empty tapto.ini file. It will usually be created by TapTo if it doesn't exist. Default values can always be omitted from the file. Lines can be commented out by starting them with ; or #.

TapTo Section

This section is required and starts with [tapto]. It contains all the common global configuration options for the TapTo service and how it should behave.

Reader


Key	Type	Default Value	Example Value
reader	String (text)	<empty string>	pn532_uart:/dev/ttyUSB0

The reader key is used to manually specify a device string that TapTo should try connect to. It's useful if the reader device you're using can't be auto-detected, or if probe devices is disabled. See the Reader Drivers page for a full list of possible device strings and how they work.

[tapto]
reader = pn532_uart:/dev/ttyUSB0

This means TapTo will continuously attempt to connect to this device while it's running, until it makes a connection. If device probing is enabled, TapTo will continue to try auto-detecting devices alongside this connection, though it won't try to reconnect any of the ones you've set here.

It's also possible to specify multiple readers to be connected:

[tapto]
reader = pn532_uart:/dev/ttyUSB0
reader = pn532_uart:/dev/ttyUSB1
reader = file:/tmp/read_tapto

Allow Commands


Key	Type	Default Value	Example Value
allow_commands	Boolean (yes/no/true/false)	no	yes

Disable Sounds


Key	Type	Default Value	Example Value
disable_sounds	Boolean (yes/no/true/false)	no	yes

Probe Devices


Key	Type	Default Value	Example Value
probe_device	Boolean (yes/no/true/false)	yes	no

Exit Game (Insert Mode)


Key	Type	Default Value	Example Value
exit_game	Boolean (yes/no/true/false)	no	yes

Exit Game Blocklist


Key	Type	Default Value	Example Value
exit_game_blocklist	String list	<empty list>	Amiga,PSX,N64

Exit Game Delay


Key	Type	Default Value	Example Value
exit_game_delay	Number (0-255)	0	15

Debug Logging


Key	Type	Default Value	Example Value
debug	Boolean (yes/no/true/false)	no	yes

API Port


Key	Type	Default Value	Example Value
api_port	String (text)	7497	8080

API Basic Auth


Key	Type	Default Value	Example Value
api_basic_auth	String (text)	<empty string>	myname:Letmein!

Games Folder


Key	Type	Default Value	Example Value
games_folder	String (test)	<empty string>	/mnt/usb999

Set Core


Key	Type	Default Value	Example Value
set_core	String (text)	<empty string>	_Console/N64:_LLAPI/N64

@@ Line 1: / Line 1: @@
 The TapTo config file is a file stored alongside the TapTo executable called ''tapto.ini'', which holds all permanent configuration options for TapTo. It uses the [[wikipedia:INI_file|INI file format]] and is the same across all platforms support for TapTo. If the TapTo service must be restarted if changes are made to this file, so it can reload and apply the new settings.
-A default config looks like this:<syntaxhighlight lang="ini">
+A default config looks like this:
+<syntaxhighlight lang="ini">
 [tapto]
 reader =
@@ Line 17: / Line 19: @@
 games_folder =
 set_core =
-</syntaxhighlight>This config is effectively the same as a missing or empty tapto.ini file. It will usually be created by TapTo if it doesn't exist. Default values can always be omitted from the file. Lines can be commented out by starting them with <code>;</code> or <code>#</code>.
+</syntaxhighlight>
+This config is effectively the same as a missing or empty tapto.ini file. It will usually be created by TapTo if it doesn't exist. Default values can always be omitted from the file. Lines can be commented out by starting them with <code>;</code> or <code>#</code>.
 === TapTo Section ===
 This section is required and starts with <code>[tapto]</code>. It contains all the common global configuration options for the TapTo service and how it should behave.
 ==== Reader ====
 {| class="wikitable"
 |+
@@ Line 35: / Line 41: @@
 |pn532_uart:/dev/ttyUSB0
 |}
-The reader key is used to manually specify a device string that TapTo should try connect to. It's useful if the reader device you're using can't be auto-detected, or if probe devices is disabled. See the [[Reader Drivers]] page for a full list of possible device strings and how they work.<syntaxhighlight lang="ini">
+The reader key is used to manually specify a device string that TapTo should try connect to. It's useful if the reader device you're using can't be auto-detected, or if probe devices is disabled. See the [[Reader Drivers]] page for a full list of possible device strings and how they work.
+<syntaxhighlight lang="ini">
 [tapto]
 reader = pn532_uart:/dev/ttyUSB0
-</syntaxhighlight>This means TapTo will continuously attempt to connect to this device while it's running, until it makes a connection. If device probing is enabled, TapTo will continue to try auto-detecting devices alongside this connection, though it won't try to reconnect any of the ones you've set here.
+</syntaxhighlight>
+This means TapTo will continuously attempt to connect to this device while it's running, until it makes a connection. If device probing is enabled, TapTo will continue to try auto-detecting devices alongside this connection, though it won't try to reconnect any of the ones you've set here.
+It's also possible to specify multiple readers to be connected:
-It's also possible to specify multiple readers to be connected:<syntaxhighlight lang="ini">
+<syntaxhighlight lang="ini">
 [tapto]
 reader = pn532_uart:/dev/ttyUSB0
 reader = pn532_uart:/dev/ttyUSB1
 reader = file:/tmp/read_tapto
-</syntaxhighlight>Allow Commands
+</syntaxhighlight>
+==== Allow Commands ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|allow_commands
+|Boolean (yes/no/true/false)
+|no
+|yes
+|}
+==== Disable Sounds ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|disable_sounds
+|Boolean (yes/no/true/false)
+|no
+|yes
+|}
+==== Probe Devices ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|probe_device
+|Boolean (yes/no/true/false)
+|yes
+|no
+|}
+==== Exit Game (Insert Mode) ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|exit_game
+|Boolean (yes/no/true/false)
+|no
+|yes
+|}
+==== Exit Game Blocklist ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|exit_game_blocklist
+|String list
+|<empty list>
+|Amiga,PSX,N64
+|}
+==== Exit Game Delay ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|exit_game_delay
+|Number (0-255)
+|0
+|15
+|}
+==== Debug Logging ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|debug
+|Boolean (yes/no/true/false)
+|no
+|yes
+|}
+==== API Port ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|api_port
+|String (text)
+|7497
+|8080
+|}
+==== API Basic Auth ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|api_basic_auth
+|String (text)
+|<empty string>
+|myname:Letmein!
+|}
+==== Games Folder ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|games_folder
+|String (test)
+|<empty string>
+|/mnt/usb999
+|}
+==== Set Core ====
+{| class="wikitable"
+|+
+!Key
+!Type
+!Default Value
+!Example Value
+|-
+|set_core
+|String (text)
+|<empty string>
+|_Console/N64:_LLAPI/N64
+|}