Relay Override Scripting - Revision history

Philmasterplus: Add Miscellaneous section and add info on custom resources

2021-03-13T07:14:02Z

Add Miscellaneous section and add info on custom resources

← Older revision		Revision as of 07:14, 13 March 2021
Line 253:		Line 253:
	Additional CSS Styling Ideas and Jason's functions using page.append can be found in [http://kolmafia.us/showthread.php?1818-OCD-Inventory-control Bale's OCD Relay Script] and [http://kolmafia.us/showthread.php?17230-EoD-SC-Ascension-Checklist-Handler EoD's Ascension Checklist Relay Script].		Additional CSS Styling Ideas and Jason's functions using page.append can be found in [http://kolmafia.us/showthread.php?1818-OCD-Inventory-control Bale's OCD Relay Script] and [http://kolmafia.us/showthread.php?17230-EoD-SC-Ascension-Checklist-Handler EoD's Ascension Checklist Relay Script].

			== Miscellaneous ==
			If your relay override script uses custom resources (e.g. images, CSS, JavaScript) that are from outside KoL, you need to distribute your script and resources as a ZIP file, or place them in a Subversion repository. See [[SVN Primer]] for more information.

			If your relay override script uses custom images, you must put them under <code>images/relayimages/</code>. This is because KoLmafia serves images only if they are under <code>images/</code>[https://kolmafia.us/threads/performance-issues.13387/post-98934]. However, the <code>cache clear</code> command will delete all files under <code>images/</code> except for the <code>images/relayimages/</code>[https://kolmafia.us/threads/performance-issues.13387/post-98980]. Thus, <code>images/relayimages/</code> is the only safe place for any custom images.

	[[Category:Scripting]]		[[Category:Scripting]]

Fredg1: :|

2020-08-14T22:35:38Z

← Older revision		Revision as of 22:35, 14 August 2020
Line 1:		Line 1:
	{{TOCright}}		{{TOCright}}
	A relay script is a script that creates or modifies a web page in the relay browser. It is only in the relay browser that the effects of these scripts can be seen. There are two different kinds of relay override scripts. The first is simply known as an Relay Script. The second is a User Interface script.		A relay script is a script that creates or modifies a web page in the relay browser. It is only in the relay browser that the effects of these scripts can be seen. There are two different kinds of relay override scripts. The first is simply known as a Relay Script. The second is an User Interface script.

	==Relay Script==		==Relay Script==

Eliteofdelete: /* Example of Using CSS in a User Interface Script */

2014-12-30T22:26:28Z

Example of Using CSS in a User Interface Script

← Older revision		Revision as of 22:26, 30 December 2014
Line 241:		Line 241:
	styles();		styles();
	page.append("</head><body><form name='relayform' method='POST' action=''>");		page.append("</head><body><form name='relayform' method='POST' action=''>");
	write_button_Example("test", "John's Button");		write_button_Example("test", "John's Button"); //Will generate a button with just "John" as it uses single quotes in the label instead of \"
	write_button("test2", "John's Button");		write_button("test2", "John's Button");
	write_button2("test3", "John's Super Button", "shiny");		write_button2("test3", "John's Super Button", "shiny");

Eliteofdelete: Addition Info and tools for writing an Interface Script

2014-12-30T22:24:17Z

Addition Info and tools for writing an Interface Script

@@ Line 152: / Line 152: @@
+}
 </syntaxhighlight></div>
 [[Category:Scripting]]

Bale: /* Relay Script */ Fix example to work since both KoL and KoLmafia have changed since then

2014-11-14T09:42:21Z

Relay Script: Fix example to work since both KoL and KoLmafia have changed since then

← Older revision		Revision as of 09:42, 14 November 2014
Line 11:		Line 11:
	#Then the contents of the page can be modified with [[replace_string\|replace_string()]] or other string manipulation functions.		#Then the contents of the page can be modified with [[replace_string\|replace_string()]] or other string manipulation functions.
	#Finally, the modified page is written with the [[write\|write()]] command.		#Finally, the modified page is written with the [[write\|write()]] command.

			===Whichplace, Whichshop and Whichstore Overrides===
			For overrides to place.php, shop.php and store.php it is possible to override based on the whichplace, whichshop and whichstore parameters. This is quite helpful so that you can choose to override only specific places and shops without needing to make an override for all of them.

			An example is that to override the plains, you'll note that the URL is <code> place.php?whichplace=plains </code> so you could override all place.php pages with a place.ash override, or you could choose to override only the plains with a script named place.plains.ash.


	===Example of Relay Override===		===Example of Relay Override===
	Here is an example of a relay script. Assuming it is named shore.ash, it will modify shore.php to reveal items that are needed for the level 6 tower monster.		Here is an example of a relay script. Assuming it is named shop.shore.ash, it will modify "The Shore, Inc." Shop at <code> shop.php?whichshop=shore.php </code> to reveal items that are needed for the level 6 tower monster.
	<div style="margin-bottom: 1em; border: dashed 1px green; padding: 1em; margin:0px 20px;"><syntaxhighlight>		<div style="margin-bottom: 1em; border: dashed 1px green; padding: 1em; margin:0px 20px;"><syntaxhighlight>
	// This script will only work if it is named shore.ash		// This script will only work if it is named shop.shore.ash
	~~void main~~(~~) {~~		buffer telescope(buffer page) {
	buffer ~~results;~~
	~~// Get the basic shore~~ page
	~~append(results, visit_url(~~));

	~~// This will modify the Dude Ranch text if a stick of dynamite is needed~~
	void dynamite() {		void dynamite() {
	if(available_amount($item[stick of dynamite]) < 1)		if(available_amount($item[stick of dynamite]) < 1) page.replace_string("<b>dude ranch souvenir crate</b>",
	replace_string(~~results,~~ "~~Distant Lands Dude Ranch Adventure~~",		"<font color=\"green\"><b>dude ranch souvenir crate<br />(stick of dynamite needed)</b></font>");
	"<font color=\"green\"><b>~~Distant Lands Dude Ranch Adventure"~~
	+" (stick of dynamite needed)</b></font>");
	}		}

	~~// This will modify the Paradise Island text if a tropical orchid is needed~~
	void orchid() {		void orchid() {
	if(available_amount($item[tropical orchid]) < 1)		if(available_amount($item[tropical orchid]) < 1 && available_amount($item[packet of orchid seeds]) < 1) page.replace_string("<b>tropical island souvenir crate</b>",
	replace_string(~~results,~~ "~~Tropical Paradise Island Getaway~~",		"<font color=\"green\"><b>tropical island souvenir crate<br />(tropical orchid needed)</b></font>");
	"<font color=\"green\"><b>~~Tropical Paradise Island Getaway"~~
	+" (tropical orchid needed)</b></font>");
	}		}

	~~// This will modify the Ski Resort text if a barbed-wire fence is needed~~
	void fence() {		void fence() {
	if(available_amount($item[barbed-wire fence]) < 1)		if(available_amount($item[barbed-wire fence]) < 1) page.replace_string("<b>ski resort souvenir crate</b>",
	replace_string(~~results,~~ "~~Large Donkey Mountain Ski Resort~~",		"<font color=\"green\"><b>ski resort souvenir crate<br />(barbed-wire fence needed)</b></font>");
	"<font color=\"green\"><b>~~Large Donkey Mountain Ski Resort"~~
	+" (barbed-wire fence needed)</b></font>");
	}		}

	~~// Only do this if the character has no access to the mall~~		if(!can_interact() && my_path() != "Bugbear Invasion") {
	if(!can_interact()) {		if(my_path() == "Bees Hate You") {
	~~// If the character has a level 7 telescope, only check for the necessary item~~		orchid();
	if(get_property("telescopeUpgrades") == "7")		} else if(get_property("telescopeUpgrades") == "7" && !in_bad_moon()) {
	switch(get_property("telescope7")) {		switch(get_property("telescope7")) {
	case "see a wooden beam":		case "see a wooden beam":
Line 57:		Line 51:
	fence(); break;		fence(); break;
	}		}
	~~// Check for all three items~~		} else {
	else {
	dynamite();		dynamite();
	orchid();		orchid();
Line 65:		Line 58:
	}		}

	// ~~Write the modified~~ page ~~to the web browser~~		// If dinghy plans are needed, you will always need to buy them! Otherwise it is time to look into that UV-resistant compass
	write(~~results~~);		if(get_property("lastIslandUnlock").to_int() < my_ascensions() && page.contains_text("dinghy plans"))
			page.replace_string("<b>dinghy plans</b>", "<font color=\"green\"><b>dinghy plans</b></font>");
			else if(available_amount($item[UV-resistant compass]) + available_amount($item[ornate dowsing rod]) == 0)
			page.replace_string("UV-resistant compass", "<font color=\"green\"><b>UV-resistant compass</b></font>");

			return page;
			}

			void main() {
			visit_url().telescope().ShopWTF().write();
	}		}
	</syntaxhighlight></div>		</syntaxhighlight></div>

Bale at 08:21, 18 November 2013

2013-11-18T08:21:41Z

← Older revision		Revision as of 08:21, 18 November 2013
Line 3:		Line 3:

	==Relay Script==		==Relay Script==
	Basic relay scripts are used to change the appearance of a KoL page. ~~They need to have the same name as the page they are modifying with the .php extension changed to a .ash extension.~~		Basic relay scripts are used to change the appearance of a KoL page. You will find many examples of relay scripts that you may download from the [http://kolmafia.us/forumdisplay.php?16-Relay-Override-Scripts KoLmafia Forums] to your /relay directory.

	You will find many examples of relay scripts that you may download from the [http://kolmafia.us/forumdisplay.php?16-Relay-Override-Scripts KoLmafia Forums] to your /relay directory.

	===Writing a Relay Script===		===Writing a Relay Script===

Bale at 08:21, 18 November 2013

2013-11-18T08:21:09Z

← Older revision		Revision as of 08:21, 18 November 2013
Line 3:		Line 3:

	==Relay Script==		==Relay Script==
	Basic relay scripts are used to change the appearance of a KoL page.		Basic relay scripts are used to change the appearance of a KoL page. They need to have the same name as the page they are modifying with the .php extension changed to a .ash extension.

	~~Then~~ you may download ~~relay scripts~~ from the [http://kolmafia.us/forumdisplay.php?16-Relay-Override-Scripts KoLmafia Forums] to your /relay directory.		You will find many examples of relay scripts that you may download from the [http://kolmafia.us/forumdisplay.php?16-Relay-Override-Scripts KoLmafia Forums] to your /relay directory.

	===Writing a Relay Script===		===Writing a Relay Script===

Bale: relay scripts no longer need to be enabled

2013-11-18T08:19:42Z

relay scripts no longer need to be enabled

← Older revision		Revision as of 08:19, 18 November 2013
Line 3:		Line 3:

	==Relay Script==		==Relay Script==
	Basic relay scripts are used to change the appearance of a KoL page. ~~Note that relay scripts are disabled by default. In order to use relay override scripts, you must enable the relevant KoLmafia preference checked as shown:~~		Basic relay scripts are used to change the appearance of a KoL page.
	~~:[[File:Override browser preference.jpg]]~~

	Then you may download relay scripts from the [http://kolmafia.us/forumdisplay.php?16-Relay-Override-Scripts KoLmafia Forums] to your /relay directory.		Then you may download relay scripts from the [http://kolmafia.us/forumdisplay.php?16-Relay-Override-Scripts KoLmafia Forums] to your /relay directory.

Bale at 09:04, 17 July 2010

2010-07-17T09:04:36Z

← Older revision		Revision as of 09:04, 17 July 2010
Line 154:		Line 154:
	</syntaxhighlight></div>		</syntaxhighlight></div>

	[[Category:~~ASH~~ Scripting]]		[[Category:Scripting]]

Heeheehee: consistency

2010-07-05T18:14:10Z

consistency

← Older revision		Revision as of 18:14, 5 July 2010
Line 3:		Line 3:

	==Relay Script==		==Relay Script==
	Basic relay scripts are used to change the appearance of a KoL page. Note that relay scripts are disabled by default. In order to use relay override scripts, you must enable the relevant ~~KoLMafia~~ preference checked as shown:		Basic relay scripts are used to change the appearance of a KoL page. Note that relay scripts are disabled by default. In order to use relay override scripts, you must enable the relevant KoLmafia preference checked as shown:
	:[[File:Override browser preference.jpg]]		:[[File:Override browser preference.jpg]]

	Then you may download relay scripts from the [http://kolmafia.us/forumdisplay.php?16-Relay-Override-Scripts ~~KolMafia~~ Forums] to your /relay directory.		Then you may download relay scripts from the [http://kolmafia.us/forumdisplay.php?16-Relay-Override-Scripts KoLmafia Forums] to your /relay directory.

	===Writing a Relay Script===		===Writing a Relay Script===
Line 81:		Line 81:

	===Writing an Interface Script===		===Writing an Interface Script===
	For writing interface scripts, several features were added to ~~KolMafia~~.		For writing interface scripts, several features were added to KoLmafia.
	* ASH predefined string constant __FILE__, which is the filename of the current script. This allows relay scripts to link or submit a form to themselves, even if the user has renamed them.		* ASH predefined string constant __FILE__, which is the filename of the current script. This allows relay scripts to link or submit a form to themselves, even if the user has renamed them.
	* ASH function [[form_fields\|form_fields()]], which returns a string[string] map with all the name/value pairs from the relay request being handled.		* ASH function [[form_fields\|form_fields()]], which returns a string[string] map with all the name/value pairs from the relay request being handled.
	* ASH string functions [[entity_encode\|entity_encode()]] and [[entity_decode\|entity_decode()]], for converting text that might contain special characters such as ampersands and angle brackets so that it can safely be displayed in HTML, and retrieving such text from form fields.		* ASH string functions [[entity_encode\|entity_encode()]] and [[entity_decode\|entity_decode()]], for converting text that might contain special characters such as ampersands and angle brackets so that it can safely be displayed in HTML, and retrieving such text from form fields.

	Additionally, there are some excellent tools for writing form elements in interface scripts on the [http://kolmafia.us/showthread.php?3842-Form-of...HTML ~~KolMafia~~ Forum]. That script is a toolbox of essential functions for any advanced interface script so make good use of it.		Additionally, there are some excellent tools for writing form elements in interface scripts on the [http://kolmafia.us/showthread.php?3842-Form-of...HTML KoLmafia Forum]. That script is a toolbox of essential functions for any advanced interface script so make good use of it.

	===Example of User Interface===		===Example of User Interface===