Using CMS Plugins

The Garden Gnome Package (GGPKG) is a package format for content management systems that lets you easily embed your projects into your website.

To output a Garden Gnome Package, click the Generate GGPKG button in the Output panel.

The package can also be created by selecting it as an HTML template in the HTML5 output. You would use this, for instance, if you wanted to make a droplet for a GGPKG output.

In order to use the package format in your CMS, you must first download and install the plug-in for your CMS.

Create a GGPKG

  1. Add an HTML5 output.
  2. Click the Generate GGPKG button to output the project.
    Generate GGPKG
  3. Add this GGPKG to a CMS website:

✭ The package can be viewed locally with the Garden Gnome Package Viewer.

✭ Any assets added to the HTML5 output will also be included in the package. This is useful for when you have a gallery component and need to bring external files into the package.

GGPKG Attributes

How a package is displayed in your website is customizable and has the following attributes. The first attribute added needs ggpkg at the beginning of the string as in

GGPKG shortcode example

Attribute Joomla WordPress
id or file
Identifies package (required)
file="test.ggpkg" id=75
Remote URL of Pano2VR or Object2VR HTML5 output (optional – instead of id or file)
url="" url=''
Width of the player (optional)
width="320" width='320'
Height of player (optional)
height="240" height='320'
If player starts as preview image (optional)
start_preview="true" start_preview='true'
Specify with which node a tour starts using the Node ID
n/a start_node=node5
Sets the initial view of the first node. The format is pan/tilt/fov/projection. Projection is optional.
start_view="90/0/70" start_view='90/0/70'
Display user data instead of pano (optional)
userdata_only="true" n/a
Display map instead of pano (optional)
map_only="true" n/a
If user data should be displayed below panorama (optional)
display_userdata="true" n/a
If map should be displayed below pano (optional)
display_map="true" n/a
To use the gyro on handheld devices (optional)
gyro="true" n/a
To use true north when using the gyro (optional)
gyro_north="true" n/a


Having troubles? Please take a look at the following requirements. If these don’t fix your issue, feel free to contact us.

  • Do not use numbers (0-9) in the beginning of the GGPKG’s file name.

  • Make sure the ZIP extension for PHP is installed on your server. In most cases, if it is not installed you will get an error message stating it is missing. You will then need to contact your host provider and ask them to install it for you.

  • Do not use special characters (á, $, ^, etc.) in the package file name.

  • Do not use spaces in the package file name.

See also