Rules regarding third party tools

Copied over from another thread, but should reside here as a sticky:

THIRD PARTY TOOLS

We've been made aware of tools that some players have developed to assist them in playing Illyriad.  Some of these tools are basic (web-enabled spreadsheets and the like) and some of these tools are quite advanced (JavaScripts etc that "float" above the web client).

We haven't had a particularly stringent policy on these tools, and have been happy to let players develop them.

However, when we've been aware of functionality within a tool that gives what we deem to be an unfair advantage over other players, we've asked that the functionality be removed until we can find some way of closing down the source of the data to whatever extent possible, and it is muchly to the credit of the players who have developed these tools that they've done what we requested.

We do, now, have guidelines for players who wish to develop tools, and these are as follows:

1. Data usage must comply with the current, publicly visible User Interface
The tool must only use the data that is publicly visible and explicitly available on the User Interface to all players without having to go into the source code.

If, for example, the publicly visible interface does not tell you where an army is travelling to, then this is something we do not intend for you to know, and tools that attempt to extract this data from the source of the world map are not allowed.

2. Tools that automate regular data capture
Tools that automatically refresh their data without any intervention from the user are forbidden. This includes map-scanning tools and event notification tools that conduct their *own* data refreshes. 

We don't have an issue with tools that ride on the back of manually initiated refreshes of data (or refreshes of data that Illyriad refreshes itself, such as Chat channels) but we do have an issue with tools that poll the server.

3. Tools that automate actions
Tools that submit ingame *actions* back to the web server are forbidden. 

The word "action" is important here. 

We don't have a problem with anyone who has (eg) a tool that allows you to click on a player's name and view their ranking, open a new mail message, look at their profile, or center the map on their capital city.  These are all examples of reasonable uses.

However, any tool that (eg) dispatches an army, casts a spell, starts construction etc is a definite no-no.


Please be aware that these guidelines are subject to change.  If you are in any doubt at all about whether a particular function of your tool is permitted, we'd urge you to get in touch with us before writing or using it.  Please use Petitions ingame to do this.

Larry wrote: Are tools allowed to automatically download the updated datafile_towns.xml file on a 24hr basis? Given that that's the express purpose of providing said xml file...

Yes, absolutely Larry.

Datafiles we provide may be downloaded at the frequency we specify that the datafile refreshes at.

Would a script to scan sections of the map (upon my initiation, not automatically) for tile data be accepted?

There's been no response to my request for release of tile data, so I was wondering if it would be allowed to simply do it myself.

HonoredMule wrote: I have the idea stuck in my head that I cannot have a script post information gathered from the in-game interface to another server.  However I cannot find the text that gave me this impression.  Can you please clarify or point me to the relevant rule?  And assuming it isn't a fabrication of my imagination, is it only talking about scraping tools, or is any form of submission including data gathered from the interface (like names and coordinates of account's cities, resource numbers, etc.) going to be a problem--even if it only occurs with a manual button press? Here's some context: I'm currently having HarmlessButler submit some user-generated data (particularly attack plans that generate launch timers) to a server for the purpose of syncing it with other computers or browser installations.  Eventually I may use it for additional purposes in the future, such as sharing attack plans with allies/war coordinators, setting email alerts for launch timers, or showing a combined, chronologically ordered list of (your private) launch timers for every account you own or sit). I'm starting to extend the user-generated data to handle such things as dividing cities into groups (navigationally) and tagging cities to help identify them by iconified specializations/strengths.  With 9 cities spread all about in unfamiliar territory, keeping things straight gets quite difficult and will become more so as Illyriad grows more dynamic and fluid.  Naturally, I want to sync all this data as well.  But that would be a lot easier if I didn't have to keep user-generated and interface-gathered data at arm's length from each other.  It would be much simpler if I could organize data strictly by relationship and just sync the whole kit and caboodle, excluding only objects that haven't any user-generated data.

Posting data gathered ingame to a third-party server is allowed, so long as the data was gathered from user initiated actions rather than anything automated.  Scripts that poll the server under any guise are not allowed.

Posting data *back* to the Illyriad server as player actions is not allowed (see Rule 3 above).

I'm hoping/sure that all data you're gathering - with the exception of XML data we provide - is "user generated" data - by which I mean a) either data that a user enters into your own interface, or b) data which is gathered from the interface based on a user interaction with the interface.  I think when you talk about "user generated" data in this context you mean information that users specifically give you/your servers.

I would also say/warn that many of these features (and more besides) are coming in the UI v2, and that all third-party tools will either break (and/or become partially/wholly redundant) as a result of UI v2.

Noryasha Grunk wrote: Would a script to scan sections of the map (upon my initiation, not automatically) for tile data be accepted? There's been no response to my request for release of tile data, so I was wondering if it would be allowed to simply do it myself.

Yes, Noryasha. So long as the data you gather is user-initiated this is acceptable.

However, you might wish to wait for the data release, as this will be a) accurate, b) complete, c) take account of changes in terrain (it does change under certain circumstances), and d) will contain more information than is currently in the user interface (such as "Terrain in terms of combat resolution").

lep wrote: I already asked via petition Norysasha and was told "no" in no uncertain terms. I was however also told that a map tile data release is under consideration and would be announced in data request section.

A slight misrepresentation, Lep!

You asked whether it was permissable in a Petition with the words "one-off bot data collection" in it the subject line.

Our response to that is absolutely not.  However, user generated map views - with a data collection tool that sits above - is acceptable (see Rule 2 above).

Again, though, I'd recommend waiting till the data is released officially. It'll be more complete, and your tool won't break when we change the UI.

Best,

SC


Edited by GM Stormcrow - 25 Oct 2010 at 00:36

Illy Tools seems to fit the outline, but is there anyone who can check it out to be sure it wont get someone in trouble?