Readables - Revision history

Datiswous: added extra space after each section.

2026-10-07T13:41:16Z

added extra space after each section.

← Older revision		Revision as of 13:41, 7 October 2026
Line 25:		Line 25:
	* maps, that are also mobile and go in their own section of inventory;		* maps, that are also mobile and go in their own section of inventory;
	* stock and custom textures, that can contain text and graphics with appropriate background. Typically, these are applied to surfaces that are immobile, non-frobbable, and must be read either close-up or through a spyglass.		* stock and custom textures, that can contain text and graphics with appropriate background. Typically, these are applied to surfaces that are immobile, non-frobbable, and must be read either close-up or through a spyglass.


	== Adding Readables to your Map - From Prefabs ==		== Adding Readables to your Map - From Prefabs ==

	For a really easy way to add readables to your maps, use Fidcal's [[Readables Prefabs]].		For a really easy way to add readables to your maps, use Fidcal's [[Readables Prefabs]].


	== Adding Readables to your Map - From Model-Based Entities ==		== Adding Readables to your Map - From Model-Based Entities ==
Line 47:		Line 49:

	http://www.mindplaces.com/save/paper2.jpg		http://www.mindplaces.com/save/paper2.jpg


	== Adding Readables to your Map - from Scratch, Made from Brushes ==		== Adding Readables to your Map - from Scratch, Made from Brushes ==
Line 113:		Line 116:

	Now compile your map.		Now compile your map.


	== Test your Readable! ==		== Test your Readable! ==
Line 120:		Line 124:

	When testing readable text you can use reloadXData in the console to reload changed xdata definitions in-game. A small test map with the player start right in front of the readable and you can review changes in seconds just by pressing the up key and Enter in the console to repeat the command or even faster, bind reloadXData to a key so you just hit a key to refresh the readable.		When testing readable text you can use reloadXData in the console to reload changed xdata definitions in-game. A small test map with the player start right in front of the readable and you can review changes in seconds just by pressing the up key and Enter in the console to repeat the command or even faster, bind reloadXData to a key so you just hit a key to refresh the readable.


	==Troubleshooting==		==Troubleshooting==
Line 174:		Line 179:

	* No gui text on readable and it wouldn't display at all when frobbed yet no error in xdata. Possible reason : sheet upside down so player frobbing it from back!		* No gui text on readable and it wouldn't display at all when frobbed yet no error in xdata. Possible reason : sheet upside down so player frobbing it from back!



Line 188:		Line 194:

	It is likely all the variables you see in an xd file could be used this way so e.g., num_pages etc.		It is likely all the variables you see in an xd file could be used this way so e.g., num_pages etc.


	== Triggering Something After Being Read ==		== Triggering Something After Being Read ==
Line 208:		Line 215:

	It both cases, in the "Readable:" dialog group, select "Name of single entity" and enter the name of your readable.		It both cases, in the "Readable:" dialog group, select "Name of single entity" and enter the name of your readable.


	== Dynamically Changing Readable Contents ==		== Dynamically Changing Readable Contents ==

Joebarnin: New section discussing how to dynamically change readable content

2026-09-27T18:51:54Z

New section discussing how to dynamically change readable content

@@ Line 209: / Line 209: @@
 It both cases, in the "Readable:" dialog group, select "Name of single entity" and enter the name of your readable.
 [[Category:Tutorial]]
 {{GUI}}

Geep: Change category tag to {{GUI}}, that includes Editing

2022-11-04T18:11:14Z

Change category tag to {{GUI}}, that includes Editing

← Older revision		Revision as of 18:11, 4 November 2022
Line 210:		Line 210:

	[[Category:Tutorial]]		[[Category:Tutorial]]
	~~[[Category:Editing]]~~		{{GUI}}

Geep: Add new intro, revise headings

2021-12-27T21:05:16Z

Add new intro, revise headings

Show changes

Geep: /* Create your custom text */ Add mention of Readable Editor

2021-12-22T22:58:21Z

Create your custom text: Add mention of Readable Editor

← Older revision		Revision as of 22:58, 22 December 2021
Line 52:		Line 52:

	== Create your custom text ==		== Create your custom text ==
	Create your xdata file containing your readable text. ~~This is explained here~~: [[XData File Creation]]. You can of course skip that step and use the '''readables_test.xd''' file, which is already prefabricated in the darkmod repository. Alternatively, you can also define the text data on the entity itself (see below).		Create your xdata file containing your readable text. Ways to do this are discussed in:
			* [[XData File Creation]]
			* Method 2 of [[Readables Prefabs]]
			* [[Readable Editor]]

			You can of course skip that step and use the '''readables_test.xd''' file, which is already prefabricated in the darkmod repository. Alternatively, you can also define the text data on the entity itself (see below).

	== Entity Keys/Values ==		== Entity Keys/Values ==

Geep: /* Triggering Something After Being Read */

2021-06-27T21:31:58Z

Triggering Something After Being Read

← Older revision		Revision as of 21:31, 27 June 2021
Line 158:		Line 158:

	== Triggering Something After Being Read ==		== Triggering Something After Being Read ==
	''From forum discussion [https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=462151 here]''		''From 2021 forum discussion [https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=462151 here]''
	There are two methods.		There are two methods.

Geep: Add Triggering Something After Being Read

2021-06-27T21:31:17Z

Add Triggering Something After Being Read

@@ Line 157: / Line 157: @@
 It is likely all the variables you see in an xd file could be used this way so eg, num_pages etc.
 [[Category:Tutorial]]
 [[Category:Editing]]

Fidcal: /* Non_existant xdata declaration */

2010-08-12T06:00:06Z

Non_existant xdata declaration

← Older revision		Revision as of 06:00, 12 August 2010
Line 103:		Line 103:
	* The xd file isn't loaded (reload Doom/TDM - see previous section.)		* The xd file isn't loaded (reload Doom/TDM - see previous section.)
	* The xd file is wrongly named or in the wrong path. The file can be any legal prefix but must be suffixed .xd and it must be in either darkmod/xdata folder or mymap/xdata folder (if you have a current game folder.)		* The xd file is wrongly named or in the wrong path. The file can be any legal prefix but must be suffixed .xd and it must be in either darkmod/xdata folder or mymap/xdata folder (if you have a current game folder.)
			* There may be an error in another xdata declaration earlier in the same file which prevents the code reading this one.

	===num_pages not defined===		===num_pages not defined===

Fidcal: /* Non_existant xdata declaration */

2010-08-12T05:57:36Z

Non_existant xdata declaration

← Older revision		Revision as of 05:57, 12 August 2010
Line 102:		Line 102:
	* The xdata name was put in the wrong place eg, below the first curly bracket.		* The xdata name was put in the wrong place eg, below the first curly bracket.
	* The xd file isn't loaded (reload Doom/TDM - see previous section.)		* The xd file isn't loaded (reload Doom/TDM - see previous section.)
			* The xd file is wrongly named or in the wrong path. The file can be any legal prefix but must be suffixed .xd and it must be in either darkmod/xdata folder or mymap/xdata folder (if you have a current game folder.)

	===num_pages not defined===		===num_pages not defined===

Stifu: Link to Readable Editor added

2010-03-10T16:45:02Z

Link to Readable Editor added

← Older revision		Revision as of 16:45, 10 March 2010
Line 15:		Line 15:
	"xdata_contents" "[readable text shader name]"		"xdata_contents" "[readable text shader name]"

	This key holds the name of the readable text as defined in your .xd File. See [[XData File Creation]].		This key holds the name of the readable text as defined in your .xd File. See [[XData File Creation]]. This last step is not necessary if you use the [[Readable Editor]] for creating your texts.

	That's it. Later you will be able to select skins to match the parchment of your model to your gui, but that's another day.		That's it. Later you will be able to select skins to match the parchment of your model to your gui, but that's another day.