Sherlock

Objective

An easy and convenient tool to check and test the integration of puzzles.

PuzzleMe’s Sherlock is a free tool developed by Amuse Labs to help you check and test the integration of your puzzles. Once installed, it runs as a browser extension, making it easy to test embedded iframes. Sherlock does the following:

1. Integration Checks: to ensure the iframe functions as expected
2. Series Settings: a list of settings showing active and inactive settings for the player

PuzzleMe's Sherlock

Integration checks

The listed checks are conducted on pages where a PuzzleMe iframe has been embedded.

Left: An example where all checks pass; Right: An example where some of checks fail

UID integration

uid: Sherlock verifies whether the user identity (uid) parameter is present in the iframe source url or not. This is a url parameter that the PuzzleMe iframe accepts, and is used to track user sessions. When uid is passed, puzzle progress is captured accurately. Read more about user identity here.

Social sharing

src: This is a parameter that is passed to the iframe source url from the parent site. The src should hold the value for the currently embedded parent site's full url. If the src parameter is not present or if the src does not match the top url despite being present, the check will fail. Read more about social sharing here.

Frame ancestors

This check ensures that your puzzles can only be embedded on websites you explicitly allow, preventing unauthorized embedding elsewhere. We highly recommend setting Allowed Domains from your series settings, read more here.

Non iframe redirect

This checks whether a puzzle URL, when opened outside an iframe in a separate browser tab, redirects to the specified URL. In most cases, this should point to the games page or puzzle archive. Read more here

Link-based multiplayer

This check identifies if your puzzle embed page is correctly configured to support link based social or multiplayer mode. An incorrect implementation will result in an invalid social play link resulting in users unable to play together. Read more about social play here.

No double load

Sherlock tests whether the embedded iframe is loaded just once. This test fails if the iframe is loaded more than once. The loads can either be complete or cancelled or a combination but in any case, multiple loads have to be addressed immediately. Multiple loads have billing implications and so careful embedding of the iframe is critical. Read more about loads and billing here.

Series settings

Clicking on this shows the various series settings that have been pre-selected from within the Dashboard. Read more about them here

Checks showing both active and inactive settings