Tetris_XH - a CMSimple_XH Plugin

Tetris_XH is an implementation of the famous Tetris game for inclusion on a CMSimple_XH website.

Please do read this documentation! Support might not be given otherwise. It's generally a good idea to read the documentation, before you encounter any problems!

Important Notice

The current version of Tetris_XH is a so called release candidate. Use with caution!

back to top

Requirements

Tetris_XH is a plugin for CMSimple_XH. It requires an UTF-8 encoded version.

back to top

Installation

The installation is done as with many other CMSimple_XH plugins. See the CMSimple_XH wiki for further details.

  1. Backup the data on your server.
  2. Unzip the distribution on your computer.
  3. Upload the whole directory tetris to your server into CMSimple_XH's plugins directory.
  4. Set write permissions to the subdirectories config/, css/, languages/ and to the plugin's data folder.
  5. Switch to Tetris in the back-end to check if all requirements are fulfilled.
back to top

Settings

The plugin's configuration is done as with many other CMSimple_XH plugins in the website's back-end. Select Tetris from "Plugins".

You can change the default settings of Tetris_XH in "Plugin Config". Hints for the options will be displayed when hovering over the help icons with your mouse.

Localization is done in "Plugin Language". You can translate the character strings to your own language, or customize them according to your needs.

The style of Tetris_XH can be customized in "Plugin Stylesheet". If you want to style the jQueryUI elements to fit to your template, you should consider to add jQueryUI theming support to your template. How this can be done is explained in the CMSimple forum.

back to top

Usage

Edit the page that you want to display the tetris game, and insert the required script call: tetris(); by CMSimple scripting, the new {{{PLUGIN:...}}} call or by hi_pd_scripting.

back to top

Limitations

jQuery

Tetris_XH may not work in installations with jQuery dependent plugins/addons/templates that don't use jQuery4CMSimple, but import their own jQuery library. This won't get fixed (as it's not possible to fix it in all cases), because all developers are advised to use only jQuery4CMSimple together with all their jQuery based code for CMSimple_XH. So offending extensions should be updated!

Vulnerability of highscores

It is not very hard for hackers to manipulate the highscores without actually scoring them through game play. But this poses no real security issue, as the size of the highscore database is restricted.

CSS validation

As the plugin makes use of jQueryUI themes, the generated output might not be valid CSS 2.1.

back to top

License

Tetris_XH is licensed under GPLv3.

© 2011 Christoph M. Becker

back to top

Credits

Tetris_XH is based on Tetris with jQuery by Franck Marcia. Many thanks to him for developing this nice and simple implementation of Tetris and releasing the code under an open source license.

This plugin uses free applications icons from Aha-Soft. Many thanks for making these icons freely available.

Many thanks to the community at the CMSimple forum for tips, suggestions and testing. Particularly I want to thank Gert and oldnema for their suggestions to improve Tetris_XH. And I have to apologize to bca, who tested the online demo first, but wasn't able to save his highscore because of a bug in the plugin.

Many thanks to Luda Wieland who pointed out that the highscores couldn't be written on installations in a UserDir and helped with debugging the problem.

And many thanks to all developers of CMSimple_XH without whom this amazing CMS wouldn't exist.

back to top