XData File Creation - Revision history

Fidcal: /* Notes, Troubleshooting, etc. */

2010-02-06T21:22:44Z

Notes, Troubleshooting, etc.

← Older revision		Revision as of 21:22, 6 February 2010
Line 60:		Line 60:

	If your text is too long for the page it won't crash it just will get truncated at the most it can display in the defined rectangle.		If your text is too long for the page it won't crash it just will get truncated at the most it can display in the defined rectangle.

			You can use reloadXData in the console to reload changed xdata definitions in-game.

	More troubleshooting tips at [[Readables#Test_your_Readable.21]]		More troubleshooting tips at [[Readables#Test_your_Readable.21]]

AluminumHaste: /* The Data Block */

2009-11-04T01:29:33Z

The Data Block

← Older revision		Revision as of 01:29, 4 November 2009
Line 39:		Line 39:
	If you want to type separate lines, putting a slash "/" after them will make them join up in the readable (this may be useful if you are using an editor without word-wrap).		If you want to type separate lines, putting a slash "/" after them will make them join up in the readable (this may be useful if you are using an editor without word-wrap).

	{		{
	"title" : "W00t!"		"title" : "W00t!"
	"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally		"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally

Fidcal: /* Notes, Troubleshooting, etc. */

2009-02-18T08:00:19Z

Notes, Troubleshooting, etc.

← Older revision		Revision as of 08:00, 18 February 2009
Line 60:		Line 60:

	If your text is too long for the page it won't crash it just will get truncated at the most it can display in the defined rectangle.		If your text is too long for the page it won't crash it just will get truncated at the most it can display in the defined rectangle.

			More troubleshooting tips at [[Readables#Test_your_Readable.21]]

	[[Category:Tutorial]]		[[Category:Tutorial]]
	[[Category:Editing]]		[[Category:Editing]]

Springheel: /* The Data Block */

2009-02-08T14:40:12Z

The Data Block

← Older revision		Revision as of 14:40, 8 February 2009
Line 36:		Line 36:

	Again, the name of the block is important, as it is referred to in the master block. The syntax is quite straight forward. Anything inside the quotes will appear as an uninterrupted block of text (word wrapping will happen automatically). Use two empty quotes ("") to leave an empty line.		Again, the name of the block is important, as it is referred to in the master block. The syntax is quite straight forward. Anything inside the quotes will appear as an uninterrupted block of text (word wrapping will happen automatically). Use two empty quotes ("") to leave an empty line.

			If you want to type separate lines, putting a slash "/" after them will make them join up in the readable (this may be useful if you are using an editor without word-wrap).

			{
			"title" : "W00t!"
			"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally
			customizable. Choose" /
			"your own background, your own font, your own text size! Heck, even custom texts are possible..."
			}


	'''Note: There can be no hard returns inside a pair of quotes, or the readable will not work!'''		'''Note: There can be no hard returns inside a pair of quotes, or the readable will not work!'''

Springheel: /* The Data Block */

2009-02-07T12:15:52Z

The Data Block

← Older revision		Revision as of 12:15, 7 February 2009
Line 31:		Line 31:
	"title" : "W00t!"		"title" : "W00t!"
	"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally		"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally
	customizable. Choose your own background, your own font, your own text size! Heck, even custom		customizable. Choose your own background, your own font, your own text size! Heck, even custom
	texts are possible..."		texts are possible..."
	}		}

Springheel: /* The Data Block */

2009-02-07T12:15:39Z

The Data Block

← Older revision		Revision as of 12:15, 7 February 2009
Line 31:		Line 31:
	"title" : "W00t!"		"title" : "W00t!"
	"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally		"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally
	customizable. Choose your own background, your own font, your own text size! Heck, even custom		customizable. Choose your own background, your own font, your own text size! Heck, even custom
	texts are possible..."		texts are possible..."
	}		}

Springheel: /* The Data Block */

2009-02-07T12:15:22Z

The Data Block

← Older revision		Revision as of 12:15, 7 February 2009
Line 30:		Line 30:
	{		{
	"title" : "W00t!"		"title" : "W00t!"
	"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally customizable. Choose your own background, your own font, your own text size! Heck, even custom texts are possible..."		"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally
			customizable. Choose your own background, your own font, your own text size! Heck, even custom
			texts are possible..."
	}		}

	Again, the name of the block is important, as it is referred to in the master block. The syntax is quite straight forward. Anything inside the quotes will appear as an uninterrupted block of text (word wrapping will happen automatically). Use two empty quotes ("") to leave an empty line.		Again, the name of the block is important, as it is referred to in the master block. The syntax is quite straight forward. Anything inside the quotes will appear as an uninterrupted block of text (word wrapping will happen automatically). Use two empty quotes ("") to leave an empty line.
	'''
	Note: There can be no hard returns inside a pair of quotes, or the readable will not work!'''		'''Note: There can be no hard returns inside a pair of quotes, or the readable will not work!'''

	== Custom Fonts and Stuff ==		== Custom Fonts and Stuff ==

Springheel: /* The Data Block */

2009-02-07T12:14:50Z

The Data Block

← Older revision		Revision as of 12:14, 7 February 2009
Line 30:		Line 30:
	{		{
	"title" : "W00t!"		"title" : "W00t!"
	"body" : "This is a damn fine readable. Read it at your own risk.~~" \~~		"body" : "This is a damn fine readable. Read it at your own risk. Absolutely frobable. Totally customizable. Choose your own background, your own font, your own text size! Heck, even custom texts are possible..."
	"Absolutely frobable. Totally customizable. Choose your own ~~" \~~
	"background, your own font, your own text size! Heck, even ~~" \~~
	"custom texts are possible..."
	}		}

	Again, the name of the block is important, as it is referred to in the master block. The syntax is quite straight forward~~, just~~ be ~~sure to add~~ a ~~backslash at the end~~ of the ~~strings to connect them. The last string does~~ not ~~have a backslash.~~		Again, the name of the block is important, as it is referred to in the master block. The syntax is quite straight forward. Anything inside the quotes will appear as an uninterrupted block of text (word wrapping will happen automatically). Use two empty quotes ("") to leave an empty line.
			'''
			Note: There can be no hard returns inside a pair of quotes, or the readable will not work!'''

	== Custom Fonts and Stuff ==		== Custom Fonts and Stuff ==

Fidcal: Add notes & troubleshooting

2007-11-11T02:20:34Z

Add notes & troubleshooting

← Older revision		Revision as of 02:20, 11 November 2007
Line 42:		Line 42:
	"gui_page1" : "guis/readables/page_test.gui"		"gui_page1" : "guis/readables/page_test.gui"
	Each page can use its own gui (for example if you plan to display page 1 as the book's cover and the rest as ordinary book pages). The tutorial is still to be written: [[GUI Definitions]]		Each page can use its own gui (for example if you plan to display page 1 as the book's cover and the rest as ordinary book pages). The tutorial is still to be written: [[GUI Definitions]]


			==Notes, Troubleshooting, etc.==

			If your readable will not display in-game and you get a 'num_pages not defined' error when you know you have - or you only have one page, then check to see if you accidentally put a \ character after the last quote marks. The function is expecting more and there isn't any. With an inventory readable this will also lock up the inventory and all frobbing so is pretty fatal to continuing the game.

			If your text is too long for the page it won't crash it just will get truncated at the most it can display in the defined rectangle.

	[[Category:Tutorial]]		[[Category:Tutorial]]
	[[Category:Editing]]		[[Category:Editing]]

Fidcal: clarification

2007-09-23T13:18:59Z

clarification

← Older revision		Revision as of 13:18, 23 September 2007
Line 4:		Line 4:

	== Create the .xd File ==		== Create the .xd File ==
	Create a new .xd file named after your map file. If your map file is called "readable_tutorial.map", create the file '''xdata/readable_tutorial.xd'''.		Create a new .xd file named after your map file. If your map file is called "readable_tutorial.map", create the file '''xdata/readable_tutorial.xd'''. ''(note: the xd file can be any name but it makes sense to use map name when published for identification and to avoid conflict etc. For example darkmanor.xd will work fine with darkmanor448.map and darkmanor449.map etc. or even just 449.map during development.) ''

	To save time-consuming syntax typing, I suggest copying the content of another .xd file right into yours. There is are already the file readable_test.xd in the xdata/ folder. Open it and copy all of its content into yours.		To save time-consuming syntax typing, I suggest copying the content of another .xd file right into yours. There is are already the file readable_test.xd in the xdata/ folder. Open it and copy all of its content into yours.