MyArcadePlugin Pro Documentation
MyArcadePlugin Pro Documentation
MyArcadePlugin Pro Documentation
MyArcadePlugin
Pro v5
User Documentation
http://myarcadeplugin.com
v2.00 - 13.09.2011
http://myarcadeplugin.com
TABLE OF CONTENTS
INSTALLATION................................................................................ 3
Overview .............................................................................................. 3
MYGAMELISTCREATOR .................................................................44
Options ...............................................................................................45
Game List For Posts And Pages ..................................................................... 46
Requirements....................................................................................... 4
MYSCORESPRESENTER ..................................................................51
MyArcadePlugin Pro Upgrade ............................................................. 7
Options ............................................................................................... 52
Activation ............................................................................................. 8
Function Reference.............................................................................54
Template Coding................................................................................. 57
Display 10 Todays Scores ................................................................................ 57
Display 20 Most Active Players ..................................................................... 57
Display 10 HighScores Of A Game ................................................................ 58
http://myarcadeplugin.com
FUNGAMES THEME.......................................................................60
Options Panel .................................................................................... 60
Customize Header .......................................................................................... 60
Customize Footer............................................................................................ 62
Advertisement Banner ................................................................................... 64
Top Slider Settings .......................................................................................... 63
Featured Slider Settings ................................................................................. 64
Layout Settings................................................................................................ 60
Navigation Settings............................. Fehler! Textmarke nicht definiert.
Installation
Overview
Thank you for purchasing MyArcadePlugin Pro!
This document provides instructions for installing and using MyArcadePlugin Pro,
MyGameListCreator, MyScoresPresenter and the FunGames theme. Since the instructions are
specific to the MyArcadePlugin Suite, they do not cover every WordPress function. For help
using WordPress, please see the further reading boxes throughout the text for additional
resources. We also recommend using the tutorials at codex.wordpress.org
http://myarcadeplugin.com
Requirements
To run MyArcadePlugin Pro you will need a WordPress ready hosting plan. It should include the
following features:
At least PHP 5.3.x
memory limit 64M or more
allow_url_fopen = ON
MySQL version 4.1.2 or greater
Unlimited bandwidth
http://myarcadeplugin.com
WordPress Installation
If you are new to WordPress and you are worried about where to start, you can take a look to
this great documentation:
http://codex.wordpress.org/New_To_WordPress_-_Where_to_Start
WordPress is well known for its easy and fast installation. Here you will find a step-by-step
tutorial how to install WordPress on your server:
http://codex.wordpress.org/Installing_WordPress
http://myarcadeplugin.com
http://myarcadeplugin.com
http://myarcadeplugin.com
MyArcadePlugin Pro
Activation
Once MyArcadePlugin Pro is activated, you will need to enter your personal license key to be
able to use all premium features.
You have received your personal key with the download link immediately after the
purchase.
After the license key verification, you will need to setup MyArcadePlugin Pro.
http://myarcadeplugin.com
Panel Overview
Once installed, you will find a control panel in your WordPress
administration bar. There you have access to the most important
functions of the MyArcadePlugin Pro. A single click on "MyArcade" will
bring you to the "MyArcadePlugin Dashboard" page. There you will
get an overview of the Plugin status, settings, news and special offers.
"Fetch Games" will bring you to a new page where you can
automatically fetch games from many game distributors like Mochi,
HeyZap, Kongregate and Playtomic. All fetched games will be saved in
your database and you can publish them with just a single click
whenever you want.
"Publish Games" will to that job for you and publish defined number of fetched games. That
will create as many WordPress posts as you want with just a one click.
"Import Games" gives you the possibility to import individual games to your brand new arcade
site. Actually, MyArcadePlugin Pro supports import of IBPArcade, PHPBB, SWF, DCR, Embed
and IFrame games.
On the "Manage Games" view you can edit and play games before you publish them.
http://myarcadeplugin.com
http://myarcadeplugin.com
Mochi Settings
Mochi Media is one of the biggest flash game distributors. Mochi has over 30.000 free games in
his database that we will use for our arcade site. First, you should create a Mochi user account.
An account is needed if you want to earn some extra money from Mochi and if you want to save
game scores.
If you do not have a Mochi Media account, click here to create one:
https://www.mochimedia.com/r/23f4b6b9ad680165
Mochi Media Feed URL
This field contains the URL to the Mochi Media's game feed. The default value is:
http://www.mochimedia.com/feeds/games/
http://myarcadeplugin.com
Now click on "Settings". The next thing you should do is to verify your Domain. Just follow the
instructions on the Mochi's site. To get your Publisher ID scroll down on the settings page to
the "Bridge Settings" section. There you will see your Publisher ID and your Publisher Secret
Key.
Copy and paste these ID's to the corresponding fields on MyArcade Mochi Settings.
http://myarcadeplugin.com
Feed Games
Feed Games gives you the option to setup how many games should be fetched every time you
click on "Fetch Games" and start fetching.
If you want to feed all games that Mochi Media offers, then leave this field blank but keep in
mind that this can take a while and that your server can overload. This is not recommended!!
To avoid server overloads we would suggest you to use values between 100 and 1000.
Filter by Tag
You may choose this option to include games that include or exclude a tag. To exclude a tag you
must preface it with a minus sign (-).
Example 1: '-zh-cn' will exclude all Chinese games
Example 2: '-snow' will exclude all Game that are tagged to snow
Example 3: 'snow' will include only games tagged to snow.
Enter tags without quotes ( ' )!
http://myarcadeplugin.com
http://myarcadeplugin.com
http://myarcadeplugin.com
HeyZap Settings
HeyZap is another big flash game distributor. Compared with Mochi Media, HeyZap does not
offer score submitting but they have many social and multiplayer games.
To be able to fetch HeyZap games a user account is needed. Click on the following link and sign
up on HeyZap: http://heyzap.com/publishers/
HeyZap Feed URL
This field contains the URL to the HeyZap's games feed. The default value is:
http://www.heyzap.com/publisher_api/v2/
Edit this entry only when HeyZap feed url has been changed otherwise MyArcadePlugin will not
work properly.
Site Key & Secret Key
To be able to fetch more than 10 games at once you have to enter valid site and secret key.
Feed Games
Feed Games gives you the option to setup how many games should be fetched when you click
on "Fetch Games" and start fetching of HeyZap games. HeyZap allows you to use values
between 1 and 200.
http://myarcadeplugin.com
Game Variants
HeyZap offers two kinds of games that you can add to your site: SWF and Embed games. The
most of the social and multiplayer games are "Embed-Games". If you want to fetch all HeyZap
games then you need to select "SWF + Embed Games".
HeyZap Auto Game Feeding (Cron)
This option allows you to turn your games site into an autoblog. If this option is checked,
MyArcadePlugin Pro will fetch HeyZap games automatically.
Go to "General Settings" to select a fetch (cron) interval.
http://myarcadeplugin.com
Playtomic Settings
Like Mochi and HeyZap, Playtomic offers you also a lot of quality games for your site.
http://playtomic.com
Playtomic Feed URL
This field contains the URL to the HeyZap's games feed. The default value is:
http://playtomic.com/games/feed/mochi
Edit this entry only when Playtomic feed url has been changed otherwise MyArcadePlugin will
not work properly.
Languages
Here you can select the languages what the games should have. Only game tagged to the
selected languages will be inserted into your games database.
Audience
Playtomic offers you to filter games by audience: Everyone, Teens and Mature. If you want to
fetch all games then uncheck all the options.
http://myarcadeplugin.com
Advertisement
In this drop down you can select what advertisements the games should have included. Every
selection except "Any" will limit the number of games that you will get from Playtomic.
Thereby, I would recommend you to choose "Any" for this setting.
Leaderboards
On this setting you can limit the leaderboard type of games that should be fetched.
MyArcadePlugin support Mochi Scores and it is recommended to select "Mochi Media" if you
want to save scores on your site.
Every selection except "Any" will limit the number of games that you will get from Playtomic.
Microtransactions
Playtomic doesn't provide a description of this setting.
Minimum Rating
Playtomic calculates an engagement rating for all games which is a score out of 100 for how fun
the game is according to actual player data. A rating of 90 or more is an excellent game but you
will get fewer games. 70 or more is a great game. 50 or more is a good game. Below 50 many not
be very good.
http://myarcadeplugin.com
Fetch Games
How many Playtomic games should be fetched at once. Leave blank if you want to fetch all
games (not recommended). This option only affects the manual game fetching. It is
recommended to use values between 100 and 1000 to avoid server overload.
http://myarcadeplugin.com
Kongregate Settings
Kongregate provides a sponsored games XML feed that you can add to your site. The feed is
updated regularly.
http://www.kongregate.com/
Kongregate Feed URL
This field contains the URL to the HeyZap's games feed. The default value is:
http://www.kongregate.com/games_for_your_site.xml
Edit this entry only when HeyZap feed url has been changed otherwise MyArcadePlugin will not
work properly.
http://myarcadeplugin.com
General Settings
In this chapter, the global settings for MyArcadePlugin Pro are described.
Save User Scores
This option enables the score submitting to your site. If the checkbox is checked,
MyArcadePlugin Pro will save submitted user scores.
Actually, MyArcadePlugin Pro is able to save following score types:
Mochi Media Scores (Publisher ID and Publisher Secret Key needed)
IBPArcade Scores
Publish Games
A number entered in this field defines how many games should be published at once when you
click on "Add Games To Blog".
Post Status
Here you can select how new game posts should be added to your blog.
"Publish" This option will publish the game posts immediately.
"Draft" This option will only add the game posts to your blog. They will not be published.
Thereby, you will be able to edit or review each post before you publish it.
"Scheduled" will publish games in a time interval, in minutes. For example, if you want to
publish every hour one game then enter 60 into the field "Schedule Time".
http://myarcadeplugin.com
http://myarcadeplugin.com
http://myarcadeplugin.com
http://myarcadeplugin.com
http://myarcadeplugin.com
Category Mapping
Map Mochi, HeyZap, Playtomic and Kongegrate categories to your own category names. That
allows you to publish games in translated or summarized categories instead of using the
predefined category names from game distributors.
The category mapping is implemented with the modern AJAX technology. So you don't need to
click the "Save Settings" button. The changes in this section are saved automatically.
http://myarcadeplugin.com
Advanced Features
http://myarcadeplugin.com
http://myarcadeplugin.com
After the game fetching is run, you will get an output like this:
http://myarcadeplugin.com
At this point, the games are added to your database and are not visible to your visitors. Now you
have two options to publish the fetched games: Manual Publishing and Automated Publishing
Automated Publishing
A single click on "Publish Games" is sufficient to publish a defined number of games on your
site. The number of games can be adjusted under "General Settings" "Publish Games".
With that feature, you are able to populate your new site with thousands of games in just a few
minutes.
Manual Publishing
The second method to publish games on your site is to use the manual publishing. After the
game fetching, you will get a game box for each fetched game with some buttons. There you can
preview each game, edit game details like description, instructions, tags or categories. A single
click on "Publish" will publish a single game on your site.
http://myarcadeplugin.com
http://myarcadeplugin.com
Mochi offers over 30.000 games. If you leave blank the setting "Feed Games" under "Mochi
Settings", MyArcadePlugin Pro will fetch all available games. That means that a huge feed has
to be downloaded and encoded. That will cause an overload of most web servers. To void this
overload you should use offset feeding like this:
http://myarcadeplugin.com
Select "Use Offset" and enter 1.000 at "Fetch" and 2.000 for offset. When you now click on "Fetch
Games", MyArcadePlugin will fetch 1.000 games started from the 2.00oth game.
Manual Import
With MyArcadePlugin you are also able to import individual games such IBPArcade, PHPBB,
SWF, DCR, EMBED or IFRAME games. To add such a game to your site click on "Import
Games".
First select an import method:
After selecting the desired import method the form below the selection will change and show
you all needed fields that needs to be filled out for the selected import.
http://myarcadeplugin.com
For uploading new game files, thumbnails and screenshot MyArcadePlugin offers you two
methods. At the one hand you can upload files from your local hard drive and on the other hand
you are able to grab files from a given url.
http://myarcadeplugin.com
To upload a file from local hard drive, click on "Browse", select a file and click on "Start
Upload". To grab a file from a given url, enter the url and click on "Start Upload".
You should upload all needed files before you do anything else on the import form because
MyArcadePlugin is able to fill the form automatically on some games for you.
MyArcadePlugin will also try to detect the game dimensions and insert them into the form.
http://myarcadeplugin.com
To be able to use this feature you have to setup your Mochi Media account. Login to your Mochi
Media account, click on "Settings" and scroll down to "Auto Post Settings". Select "Custom
built script" on "Auto Post Method" and enter the following URL to "Auto Post URL":
http://{YOUR URL}/wp-content/plugins/myarcadeplugin/modules/mochi_autopost.php
http://myarcadeplugin.com
CubePoints Integration
MyArcadePlugin has a built in CubePoints integration. CubePoints is a point management
system for WordPress. Users can earn points by playing games, submitting scores and getting
highscores or even by logging in on your site.
The achieved points are displayed with widgets and user can donate their points to other user.
For more information about CubePoints please visit:
http://cubepoints.com
After activating CubePoints you will need to setup the plugin before use. Click on CubePoints ->
Configure and set how many points user should get for several actions.
MyArcadePlugin will handle the rest for you!
http://myarcadeplugin.com
Function Reference
MyArcadePlugin Pro will work with every standard WordPress theme but you can also use
several useful functions to create a nice looking site with special features. In this chapter, you
will find all available functions that you can use in your themes. Use these functions if you use a
standard WordPress theme or if you want to create your own individual theme.
MyArcadePlugin uses WordPress custom fields to saves additional game information's. To
display these information's you can use the following functions within the WordPress loop:
Print Game Description
<?php echo get_post_meta($post ->ID, "mabp_description", true); ?>
http://myarcadeplugin.com
http://myarcadeplugin.com
http://myarcadeplugin.com
MyGameListCreator
To save your server performance MyGameListCreator will create game list that is saved in a
static file. A list with a big number of games is a great SEO-Method to get more visitors. This
method is well known and Miniclip is using it, too. The game list will be refreshed when you
publish, edit or delete a game post. MyGameListCreator is able to create to kinds of static game
lists: "Game List For Posts And Pages" and "Standard Game List".
MyGameListCreator will create two files located in the root folder of your WordPress
installation (where wp-config.php) is located:
gamelist.php
gamepostlist.php
http://myarcadeplugin.com
Options
Game List Title - Customize the name of your list. You can also use html code to adapt
the style to your theme.
Limit Showed Games - Set "-1" (without quotes) to create a list with all published games.
Otherwise, enter an integer.
Limit Game Names - Set how many chars of a game name should be shown. Leave blank
to show the entire name.
Begin Wrap - Customize the start html code to adapt to your theme, i.e. "<div>". This
code will be placed above the game list.
End Wrap - This is the global end wrap for the game list, i.e. "</div>".
Begin List Wrap - Put here your list begin wrap, i.e. "<ul>".
End List Wrap - Put here your list end wrap, i.e. "</ul>".
Begin Item Wrap - Put here your begin wrap for a game in the list, i.e "<li>".
End Item Wrap - Put here your end wrap for a game in the list, i.e "</li>".
Games Categories - Create a list containing only games from selected categories. If you
wish to have games from each category included in the list, please select all categories.
http://myarcadeplugin.com
Create List With Leading Letters - Check this option if you want to create an
alphabetically ordered list with leading letters, like on Miniclip. If this option is not
checked "default" list will be created where the games are ordered by their publish date.
Rows For Lists With Leading Letters - Enter the number of rows that should be created.
Auto Create Game List - Check this option if you want to create automatically the game
list.
The game list will contain all games of selected categories. This feature can be very useful if you
have a mixed website and not only a pure arcade portal.
http://myarcadeplugin.com
Customize the HTML output over the"Post Game List Template". Use HTML code and available
placeholders to create unique game lists.
Available Placeholders
%TITLE% - Shows the name of a game
%TITLE_WITH_LINK% - Game name with a link to the game post
%THUMBNAIL% - Shows the thumbnail of a game
%THUMBNAIL_WITH_LINK% - Shows a clickable thumbnail
%DESCRIPTION% - Prints the game description
%INSTRUCTION% - Prints the game instructions
Default Template Code
<p>
<strong>%TITLE_WITH_LINK%</strong><br />
<div style="float:left;">%THUMBNAIL_WITH_LINK%</div>
%DESCRIPTION%
</p>
<p style="clear:left;"></p><br />
http://myarcadeplugin.com
Styling Examples
In this chapter, you will see two simple styling examples:
Default Style
Miniclip Style
However, with MyGameListCreator you can also create your own unique looking game list using
the available options and CSS-Code.
<div id="gamelist">
End Wrap:
</div>
</ul>
</li>
http://myarcadeplugin.com
16
Begin Warp:
<div id="gamelist">
End Wrap:
<div class="clear"></div></div>
<ul style="width:128px;">
</ul>
<li>
http://myarcadeplugin.com
</li>
Theme Integration
To display the created game list (gamelist.php) in your theme you have to put this line of code
on the desired place in your theme:
<php
if (function_exists('get_game_list')) {
get_game_list();
}
?>
http://myarcadeplugin.com
MyScoresPresenter
MyScoresPresenter will show player and game scores on your site. The output code for scores
can easily be configured with templates over the WordPress backend. MyScoresPresenter
includes several Widgets that you can add to your site. Go to Appearance Widget and
drop the desired Widgets into the sidebars.
With the current version of MyScoresPresenter, you can show the following scores:
Most Active Players
Latest Scores
Today's Scores
Single Game Scores - Shows scores of a single game
MyArcadePlugin Leaderboard - Shows best players on your site
http://myarcadeplugin.com
Options
MyScoresPresenter offers you the possibility to customize the score output using templates
without touching the code. In this chapter, you will get an overview of available templates and
styling examples.
The templates work with special placeholders. The current version of MyScoresPresenter offers
your following placeholders:
%USERNAME% - Display the name of an user
%SCORE% - Display the score of a game
%GAMENAME% - Display the name of a game (without link)
%GAME% - Display the game name with the game link
%GAMEPLAYS% - Display the game plays of an user
%GAMEIMAGEURL% - Gets the thumbnail url of a game
%HIGHSCORE% - Display how many highscore a user has achieved
%DATE% - Display the date of the score
http://myarcadeplugin.com
Template Usage
The output code of MyScoresPresenter will always be an unordered list. With templates, you
can style the output of the list items. Here is an example how to style Latest Scores.
Template code:
<strong>%USERNAME%</strong> on %GAME%
http://myarcadeplugin.com
Function Reference
You build your own themes and you want to integrate score boxes to your theme, then you can
use following functions:
Todays Scores
myscore_get_todays_scores($limit)
Latest Scores
myscore_get_latest_scores($limit)
http://myarcadeplugin.com
Leaderboard Check
Returns "true" when the displayed game has Leaderboard enabled. This function can only be
used inside the WordPress-Loop.
myscore_check_leaderboard()
Leaderboard Bridge
http://myarcadeplugin.com
Mochi Media games submit their scores over a "Leaderboard Bridge". This bridge has to be
added to your theme to be able to receive game scores. You can embed the Leaderboard Bridge
with this function call:
<?php
if (function_exists('myarcade_get_leaderboard_code')) {
myarcade_get_leaderboard_code();
}
?>
http://myarcadeplugin.com
Template Coding
In this chapter, you will see some code examples that you can use in your themes.
http://myarcadeplugin.com
Now you are able to show latest scores of a game. You can use this example for your sidebar:
<?php if ( is_single() ) :?>
<?php if (function_exists(myscore_get_game_scores) ) : ?>
<h2>Best Players</h2>
http://myarcadeplugin.com
<ul>
<?php echo myscore_get_latest_scores(); ?>
</ul>
<?php endif; ?>
<?php endif; ?>
http://myarcadeplugin.com
FunGames Theme
FunGames Theme is a premium Arcade Theme for WordPress. It is fully compatible to Mingle
and BuddyPress. The theme has BuddyPress templates integrated!
Using MyArcadePlugin Pro and the FunGames theme, you will generate a two-way income. By
publishing Mochi Media games, you will be paid my Mochi Media. On the other hand, you can
integrate Adsense Ads or other banners to increase your earnings.
Options Panel
The theme options panel can be found at Appearance -> Theme Options. Here you will get an
overview about all available settings.
Layout Settings
This section customizes the look of the theme.
http://myarcadeplugin.com
Blog Category
Select a category that should be used as a regular WordPress blog (if needed).
Main Color Scheme
Select a color scheme that should be used.
Sidebar Position
Select a sidebar position - left or right.
Games per Box
Set the number of games that should be shown in each category box on the front page.
Box order
Select how the category boxes should be shown on the front page: Vertical or Horizontal.
Hide Category Boxes
Select categories which should be excluded from the front page.
Game Embed Box
Enable or disable the game embed box - "Embed this game on your site..."
Game Order
Select how games should be ordered on the front page. Info: Random order may slow down your
site!
http://myarcadeplugin.com
Customize Header
Here you can specify all header settings for your template.
Custom Favicon
Enter the url of your own custom favicon.
Custom Logo
Enter here the URL to your logo. Maximum dimensions are 460x80px.
Site Keywords
If you do not use a SEO-Plugin, you can use this field to enter your Meta keywords. Pick some
keywords that will describe your website separated by a coma (,). This is a meta-tag within the
HEAD tags.
Site Description
A small description of your site for the meta-tag.
Custom Header Code
In this section, you can enter custom Meta or JavaScript codes. (e.g.: Mochi Verification)
Customize Footer
Here you can specify all footer settings for your template.
Custom Footer Code
This section allows you to add a custom HTML or JavaScript code ( e.g.: Google Analytics).
http://myarcadeplugin.com
http://myarcadeplugin.com
Advertisement Banner
This section allows you to manage your Adsense codes and other banner.
Header Banner
Put the code for a 468x60px banner here. This will appear on your header on each site.
Content Banner
Put the code for a 300x250px banner here. This banner will appear on each game site (single
page) near the game description.
Game Preloader Banner
Put the code for the game preloading section. It's recommended to use a 336x280px banner
here.
Over Game Banner
Put the code for a 728x90px banner here. This banner will appear on each game site (single
page) above the playable game.
http://myarcadeplugin.com
Progress Bar
This section customizes the settings of the single game site.
http://myarcadeplugin.com