Scripting

From WikIkariam, the Ikariam wiki - Guides, buildings, ships and more.

[edit] Introduction

WARNING: Use scripting at your own risk. You could get yourself banned!

Scripting is the ability to enhance the user experience, and Gameforge have a section in their Terms and Conditions relating to it (See Prohibited programs below).

This article describes some scripts that are available for GreaseMonkey, and more may be found on userscripts.org.

A list of all approved scripts can be found in the Ikariam forums. Use of an unauthorised script could get you Banned.

[edit] Game Rules

VII. Scripting

• Using a program as interface between the player and his game is prohibited. Any other form of automatically generated information generated for a group of players advantage with malicious intentions is forbidden as well.

This includes but is not limited to:

• Bots
• Macros
• Automated island databases.

A full list of approved scripts can be found here.

Note: Only exceptions to this are programs that are expressly approved by Gameforge.

Please bear in mind that using scripts that are not approved by Gameforge may get your account permanently banned.

[edit] Approved Tools

Type	Title	Author	Links	Description
	Ikariam Animator	Anilo	Install Forum	Animated graphic pack for Ikariam. Also called Animated Ikariam.
	Citizin Alerter	Unknown	Install	Alerts when your town hall is almost full.
	Ikariam City Select Reorder	Overkill	Install	Allows you to re-order your towns in the town select drop down menu.
	Ikariam Friend List	B. Metz	Install	This script adds a small button to your Ikariam playfield. On mouseover a field will expand where you will be able to add friends and their respective URLs to a list allowing quick access to your friends islands.
	Ikariam Solarium	Foxtrod II	Install	Adds a day and night effect. Project base by Anilo.
	Ikariam Transport Countdown	Matthew Hancock	Install	Convert Ikariam transport (Trade Fleet) and Trade Port Arrival times to a countdown instead of static timestamp.
	Ikariam Notebar	EnigmaBrand	Install	Adds a small tab to the left side of the game window. When you mouseover it, it will expand to show you the note taking window. Click into it and begin typing. The script saves what you type as you type it so you don't have to worry about clicking any save buttons. Click the tab again and it hides it!
	Ikariam Quickbar	EnigmaBrand	Install	Adds a tab that lets you add quick links to specific saved URLs.
	Ikariam Wikibar	EnigmaBrand	Install	Adds a tab that expands and opens wikikariam in game
	Shipment Times	Wiisley	Install	A script that adds the loading time of the current amount of resources to the travel time.
	Multi-Page Combat Report Viewer	Martynius	Install	This script allows more than 10 Combat Reports to be displayed in the first page of the Military Advisor View.
	Ikariam Alliance Sorter	Martynius	Install	Adds links in the Embassy and Diplomacy Advisor to sorts the Alliance Members by last active date, name, rank points and number of towns. Changes the light bulb showing whether a player is on/offline to (i) if the player has not logged in during the last seven days.
	Ikariam Mini-Chat	Sampisa	Install	Approved on some domains only (.fi, .fr, .hu, .nl, .pl, .ru)- NOT approved on domains that use the list of scripts from .com domain - Adds a small window on the left, where a 2-panels chat is enabled. One has violet background, and is server-wide: when someone write on it, the message is shown to every player, on the server, that has the same panel open. This is called "Server Chat". Another panel has green background, and is reserved to the alliance: a message wrote in this panel can be read only by the members of the same alliance of the writing player. This is called "Ally chat".

[edit] Themes

Themes replace some of the images in Ikariam to change the look and feel of the game. They don't change gameplay at all or put any additional load on the game servers, so they should all be approved by nature. Find more themes or create your own at the Ikariam Themes site.

Type	Title	Author	Links	Description
	Animated	Anilo	Install	Animates a lot of images
	Cutthroat	Fungah	Install	Turn your city into a pirate cove!
	Sexy Theme	PhasmaExMachina	Install	Skin for Ikariam that changes some of the artwork with to sexier images

[edit] Illegal Tools

Type	Title	Author	Links	Description
	Hades Army Scripts	arya	n/a	This is a mix script of: IkariamFriendList v.04 by Elnaira ScoreLinker 0.5.7 by ImmortalNights (c) Kronos Utils v.04 by Kronos mods Johan Sundström
	Ikariam Alarm and Overview table	Suller Andras	n/a	Automatically refreshes the side bar in a game every 5-10 minutes and warns with a sound when you have a new message or you are under attack (Illegal). Also collects the important informations (residents, the quantity of raw materials, the level of buildings, building standing under building), and displays it in a table at the bottom of the page. There has been some talk on the forums that this script might be allowed if the alarm is removed. The script author is however skeptical, since the overviews granted by the script are in direct competition with the advisor improvements Gameforge grant paying players.
	Ikariam Auto Login	Pezmc	n/a	Automatic login for any Ikariam server. Saving you time and effort.
	Ikariam Auto Refresh	Pezmc	n/a	Automatic refresh of all Ikariam pages for any Ikariam server. Saving you time and keeping you up to date.
	Kronos Utils	ecmanaut	n/a	This is an extensive script with hundreds of enhancements, mostly relating to the user interface and visualizing in-game information.
	Kronos Overview	ecmanaut	n/a	Requires Kronos Utilities. Inspired by Ikariam Overview Table, this script gives you table overviews of your resources and troops, but without storing any data of its own, and instead asking Kronos Utils (which it thus requires to be installed) for the info.
	Ikariam Spam (IsIIMS)	reddwarf	n/a	Allows messages to be sent to all residents of your island. This script no longer works in Patch 0.2.6, due to a rate-limit placed on outgoing messages. It has been removed from the list of approved scripts and tools.
	Blank Canvas	Jerome Dane	n/a	No longer approved by Gameforge Firefox addon to allow auto select of the preferred login server, fast linking of the buildings on all islands, highscore information of a player in the island view, etc. Includes many useful approved scripts. Contains working Animated Ikariam and several other graphic themes (Christmas, Gunmetal, etc).

[edit] Uncategorised Tools

Type	Title	Author	Links	Description
	Ikariam Upgrade Watcher	ATND	Install Website	Attaches a simple icon on each building which shows level and if upgradeable.
	Ikariam Menu Enhanced	Jawaka	French English	Enhanced menu for Ikariam.
	Ikariam Tokens	Scaremonger	Install	Displays small circular icons on buildings, towns and resources that show their level.
	Ikairam Utilities	Jawaka	Install	This script adds an array of available resources to the side bar.
	ResourcesShortcuts	A. Rosemary	Install	This script adds shortcuts to the resources in a side panel. Moreover, the shortcuts show the increased amount per hour.
	Horizontal Scrollbar Remover	subverted / EuroDance	Install	This script removes the useless horizontal scrollbar displayed by Firefox in the world, island and town view at resolution of 1024x768 or less.
	Anti Ikariam PLUS	$hikamaru	Install	Hide all things related to Ikariam PLUS. For example: images of plus on advisers, Premium Trader in Town hall, etc.
	Ikariam Transporter	darkyndy	Install	No longer on approval list. Adds a drop-down box that allows you to quickly select an island to transport resources to.

[edit] Scripting Tools for Developers

The following tools can be very useful for developers looking to write scripts for Ikariam.

Type	Title	Author	Links	Description
	IkaTools	PhasmaExMachina	Website	Include in your scripts to get easy access to game information through method calls such as IkaTools.cityGetResource("marble")
	Script Updater	PhasmaExMachina	Website	Include in your scripts to automatically check for updates and notify the end user when one becomes available