Hosted QR Scorecards

Overview

This page documents setup and procedures required to configure QR code capabilities in tsh Scrabble® tournament software. The term "hosted" refers to the QR facilities being provided by web services rather than entirely on the tsh client as previously had been unfortunately the case.

Setup

Add the following lines exactly as show to the event's config.tsh:

config names_with_naspa_id = 1
config standings_hotlink_to_qr = 1
config qr_server_name = 'qr.wgvc.com'
config qr_reg_uri = '/cgi-bin/qrreg.pl'

Add the following line with the URL replaced by the exact web address of the the tournament's Event Coverage Index as generated by tsh:

config public_tourney_html_url = 'http://tsh.wgvc.com/2020-04-18-QuaHSCO/html'

To add QR codes to player scorecards:

config qr_scorecards = 1

Explanation

config names_with_naspa_id = 1 indicates the player roster downloaded from Cross-Tables should include NASPA IDs as suffixes. These will generally be hidden in reports and console output.

config standings_hotlink_to_qr = 1 will set player names in standings and ratings reports as HTML links to player scorecards.

config qr_server_name = 'qr.wgvc.com' and config qr_reg_uri = '/cgi-bin/qrreg.pl' together define the URL of the QR registration web service.

config public_tourney_html_url is needed to inform the software of the location whence information about the tournament in progress can be received, which is otherwise not known reliably. This value can also be provided as an argument to the qrreg tsh command.

Registration Procedure

1. Synchronize event data to its web site using mirror_ftp or some other file transfer facility.
2. Issue the qrreg command from the tsh command line, optionally providing the public_tourney_html_url value.

The QR server will compare the tournament data on the tsh client with the indicated public URL. If the two do not match exactly, the registration will be refused. This check is intended to ensure the operator has provided the correct URL for his event. Because of this check, the website must be up to date with respect to any late data entry or configuration changes on the client.

If the registration fails because of a data mismatch, a brief error report will be output showing key information for the indicated URL.

1. Check that you have in fact provided the exact URL for the event you are running.
2. Verify that data is current on the web site.

The qrreg command can be repeated as many times as necessary to account for roster changes, subject each time to the check described above.

If players are moved between divisions or dropped from an event, it is not necessary to redo the event registration and doing so will have no effect. Registration will need to be performed to account for players added to the event, or if the URL for the event they are participating in changes, for example if they switch lexicons.

Players Without IDs

Since NASPA generally requires that all players in sanctioned events be association members, they should all have organization IDs which will allow access to event data. In the event for whatever reason a player does not have an ID, this will be reported by the qrreg step.

A temporary player ID can be composed as follows:

1. The first 2 characters of the ID are XX.
2. The next 5 characters are the last 5 digits event director's NASPA ID including zeros, for example 00896.
   • The ID of any director associated with the event can be used for this purpose, their ID is used only to ensure the temporary ID does not conflict with another event in progress.
3. The last 3 digits are digits uniquely identifying the player within the event.
   • For example, temporary IDs for 3 players could be defined as XX00896001, XX00896002 and XX00896003.
   • If you have more unregistered players than can be assigned unique IDs using this method, congratulations on hosting such a large event.
4. At this time, the tournament .t file must be edited manually to add the ID to the player name, for example:

Li, Ruth:XX000008       1269

Tournament Operations

No further actions are required to maintain access to player scorecards through standings or ratings links, or through QR codes as they appear on player scorecards, which can be scanned with any smartphone's QR app.

Web Hosted QR Code Generation

A PNG of the QR code for use on player badges can be obtained from the naspa.club site as follows, replacing the example player ID with that of the event participant as appropriate: http://naspa.club/i/AA000896.