Readables Prefabs - Revision history

Geep: /* Method 2: By Direct Editing of Your XD File */ Add reference to "Books_with_Illuminated_Capitals"

2025-04-24T21:25:27Z

Method 2: By Direct Editing of Your XD File: Add reference to "Books_with_Illuminated_Capitals"

← Older revision		Revision as of 21:25, 24 April 2025
Line 46:		Line 46:
	# Put subheading(s) in the title line-spaced down with \n\n\n and also text in the body also line-spaced down with \n\n\n.		# Put subheading(s) in the title line-spaced down with \n\n\n and also text in the body also line-spaced down with \n\n\n.
	# Use only the title for the whole page if you want a larger font.		# Use only the title for the whole page if you want a larger font.
	# Some provide an 'illuminated' capital initial letter where shown else leave empty (can precede with \n\n to force linefeeds.) If you do insert an illuminated capital letter then also horizontal-space out the start of the first three body lines to leave room.		# Some provide an 'illuminated' capital initial letter where shown else leave empty (can precede with \n\n to force linefeeds.) If you do insert an illuminated capital letter then also horizontal-space out the start of the first three body lines to leave room. For more, see [[Books with Illuminated Capitals]].

	* Enter your text in paragraphs between double quotes which in turn are between the curly brackets.		* Enter your text in paragraphs between double quotes which in turn are between the curly brackets.

Geep: /* Introduction */ Add ref

2021-12-27T21:31:47Z

Introduction: Add ref

← Older revision		Revision as of 21:31, 27 December 2021
Line 17:		Line 17:
	''scroll_rolled_mobile_gothic_bamberg.pfb''		''scroll_rolled_mobile_gothic_bamberg.pfb''

	Within the "Choose Prefab" viewer's left pane, look for the "readables" category. This is further subdivided into books, scrolls, and sheets. (There are also signs, ~~discussed elsewhere~~.) ~~Books can be~~ open or closed, and scrolls ~~can be~~ open or rolled up. All forms ~~can be~~ mobile (aka movable) or static (aka immobile), discussed in [[Readables]].		Within the "Choose Prefab" viewer's left pane, look for the "readables" category. This is further subdivided into books, scrolls, and sheets. (There are also signs, treated separately in [[Text_Decals_for_Signs_etc.]]) Provided book prefabs are open or closed, and scrolls are open or rolled up. All forms are available in mobile (aka movable) or static (aka immobile) form, also discussed in [[Readables]].

	==Inserting Readables Prefabs==		==Inserting Readables Prefabs==

Geep: /* Introduction */ Add a short paragraph

2021-12-27T21:26:09Z

Introduction: Add a short paragraph

← Older revision		Revision as of 21:26, 27 December 2021
Line 17:		Line 17:
	''scroll_rolled_mobile_gothic_bamberg.pfb''		''scroll_rolled_mobile_gothic_bamberg.pfb''

			Within the "Choose Prefab" viewer's left pane, look for the "readables" category. This is further subdivided into books, scrolls, and sheets. (There are also signs, discussed elsewhere.) Books can be open or closed, and scrolls can be open or rolled up. All forms can be mobile (aka movable) or static (aka immobile), discussed in [[Readables]].

	==Inserting Readables Prefabs==		==Inserting Readables Prefabs==

Geep: Breakout "Creating Text Content, add info about Readables Editor

2021-12-22T22:46:04Z

Breakout "Creating Text Content, add info about Readables Editor

← Older revision		Revision as of 22:46, 22 December 2021
Line 3:		Line 3:
	{{Summary\|		{{Summary\|
	* Select a readable prefab in your map editor.		* Select a readable prefab in your map editor.
	*You now have a working readable with blank pages.		* You now have a working readable with blank pages.
	* Copy its template xdata from xdata/prefabs.xd to your own xd file and give it a unique name.		* Copy its template xdata from xdata/prefabs.xd to your own xd file and give it a unique name.
	* ~~Type in~~ your ~~own~~ text ~~between~~ the ~~quotes where shown~~.		* Create your new text content, either with the Readable Editor or by hand-editing.
	* Enter the number of pages where shown (default is 1)
	}}		}}

Line 21:		Line 20:
	==Inserting Readables Prefabs==		==Inserting Readables Prefabs==

	* First make your own plain text xd file, eg, mymap.xd. (Do this BEFORE launching Doom/TDM else it won't load it - you'll have to exit and open TDM again.)		* First make your own plain text xd file, e.g., mymap.xd. (Do this BEFORE launching Doom/TDM else it won't load it - you'll have to exit and open TDM again.)
	* In your map editor, in orthoview, point to where you want the readable, RMB, insert prefab, select a readables prefab. There are images at [[Fonts Screenshots]] so you can see what the fonts look like.		* In your map editor, in orthoview, point to where you want the readable, RMB, insert prefab, select a readables prefab. There are images at [[Fonts Screenshots]] so you can see what the fonts look like.
	* With the readable selected, in Entity Inspector note the xdata name from xdata_contents. (tip: highlight then Ctrl+C to copy it)		* With the readable selected, in Entity Inspector note the xdata name from xdata_contents. (tip: highlight then Ctrl+C to copy it)
Line 27:		Line 26:
	* Open prefabs.xd in a text editor and find that xdata name you copied (tip: F3 to search (usually) paste in the name)		* Open prefabs.xd in a text editor and find that xdata name you copied (tip: F3 to search (usually) paste in the name)
	* Select & copy the complete xdata section including the name and the last end curly bracket. (tip: look for a few blank lines then the next xdata header name.)		* Select & copy the complete xdata section including the name and the last end curly bracket. (tip: look for a few blank lines then the next xdata header name.)
	* Paste it into your own xd file, eg, mymap.xd.		* Paste it into your own xd file, e.g., mymap.xd.
	* Still in your own xd file, change the xdata name header, eg, <br>from ''book_gothic_bamberg'' to eg, ''nightwatch_logbook''.<br>It MUST be a unique name used nowhere else in this or any other xdata file on the player's system so make it distinctive. 'path' not essential but recommended to make distinctive, eg,<br>''mymapname/magic_book3''		* Still in your own xd file, change the xdata name header, e.g., <br>from ''book_gothic_bamberg'' to e.g., ''nightwatch_logbook''.<br>It MUST be a unique name used nowhere else in this or any other xdata file on the player's system so make it distinctive. 'path' not essential but recommended to make distinctive, e.g.,<br>''mymapname/magic_book3''
			* If you are using Method 1 next, save and close your xd file. Otherwise, leave it open for further editing.
			==Creating Text Content for One or More Pages==
			===Method 1: By Using the Readable Editor===
			''suggested by joebarnin''
			* In DR, with the readable selected and open in the Entity Inspector, change the '''xdata_contents''' property to the new name (e.g., nightwatch_logbook) you used in the xd file.
			* At this point you should be able to use the [[Readable Editor]]. It will update your xd file automatically.

			===Method 2: By Direct Editing of Your XD File===
	'''ADDING TEXT:'''		'''ADDING TEXT:'''
	* In all xdata sections, your main text should be typed between double quotes usually in a 'body' section where shown.		* In all xdata sections, your main text should be typed between double quotes usually in a 'body' section where shown.
Line 43:		Line 48:

	* Enter your text in paragraphs between double quotes which in turn are between the curly brackets.		* Enter your text in paragraphs between double quotes which in turn are between the curly brackets.
	* Use \n to linefeed within the quotes else two empty double quotes for blank lines if needed, eg...		* Use \n to linefeed within the quotes else two empty double quotes for blank lines if needed, e.g...
	{		{
	"paragraph"		"paragraph"
Line 65:		Line 70:
	* Resave your xdata file.		* Resave your xdata file.

	* In ~~your map editor~~, in Entity Inspector, change the ~~xdata name on the readable entity~~ to the ~~one~~ in ~~your xdata~~ file~~, eg, mymap.xd~~. Tip: if you copy and paste this from your xd file make sure you do not accidentally include any linefeeds - it can cause problems.		* In DR, with the readable selected and open in the Entity Inspector, change the '''xdata_contents''' property to the new name (e.g., nightwatch_logbook) you used in the xd file. Tip: if you copy and paste this from your xd file make sure you do not accidentally include any linefeeds - it can cause problems.

	==Testing & Troubleshooting==		==Testing & Troubleshooting==

Geep: Correct info about finding prefabs.xd

2020-04-22T16:24:16Z

Correct info about finding prefabs.xd

← Older revision		Revision as of 16:24, 22 April 2020
Line 24:		Line 24:
	* In your map editor, in orthoview, point to where you want the readable, RMB, insert prefab, select a readables prefab. There are images at [[Fonts Screenshots]] so you can see what the fonts look like.		* In your map editor, in orthoview, point to where you want the readable, RMB, insert prefab, select a readables prefab. There are images at [[Fonts Screenshots]] so you can see what the fonts look like.
	* With the readable selected, in Entity Inspector note the xdata name from xdata_contents. (tip: highlight then Ctrl+C to copy it)		* With the readable selected, in Entity Inspector note the xdata name from xdata_contents. (tip: highlight then Ctrl+C to copy it)
	* ~~Open~~ the file ~~xdata/prefab~~.xd in a text editor and find that xdata name you copied (tip: F3 to search (usually) paste in the name)		* In the TDM distribution, within tdm_prefabs01.pk4, find the file prefabs.xd
			* Open prefabs.xd in a text editor and find that xdata name you copied (tip: F3 to search (usually) paste in the name)
	* Select & copy the complete xdata section including the name and the last end curly bracket. (tip: look for a few blank lines then the next xdata header name.)		* Select & copy the complete xdata section including the name and the last end curly bracket. (tip: look for a few blank lines then the next xdata header name.)
	* Paste it into your own xd file, eg, mymap.xd.		* Paste it into your own xd file, eg, mymap.xd.

Geep: /* Inserting Readables Prefabs */

2020-03-10T12:20:53Z

Inserting Readables Prefabs

← Older revision		Revision as of 12:20, 10 March 2020
Line 53:		Line 53:
	* '''Do not press the Enter key to start a new line within the quotes--the readable will not work if you do!''' Long lines will wordwrap in the game readable. If you should want to force a new line within quotes then type \n. Tip : set your text editor to wordwrap and narrow its window to approximate the width of the page in-game.		* '''Do not press the Enter key to start a new line within the quotes--the readable will not work if you do!''' Long lines will wordwrap in the game readable. If you should want to force a new line within quotes then type \n. Tip : set your text editor to wordwrap and narrow its window to approximate the width of the page in-game.

	Geep comments, 2020: Note that any given page can only have 1 font for both title and body. But different pages can have different ~~fonts~~, by editing the "gui_pageN" settings at the bottom of the page setting. No markup is available for font size ''within'' a line, or for italics, bold, and underline. ~~You~~ may be able to fake a font size change within a line by using the title/body overlap, but with ~~low probability of success~~.		Geep comments, 2020: Note that any given page can only have 1 font style for both title and body. But different pages can have different font styles, by editing the "gui_pageN" settings at the bottom of the page setting. No markup is available for font size ''within'' a line, or for italics, bold, and underline. Under some circumstances, you may be able to fake a font size change within a line by using the title/body overlap, but test it with different screen widths.

Geep: /* Inserting Readables Prefabs */

2020-03-10T12:14:52Z

Inserting Readables Prefabs

← Older revision		Revision as of 12:14, 10 March 2020
Line 33:		Line 33:
	* In all xdata sections, your main text should be typed between double quotes usually in a 'body' section where shown.		* In all xdata sections, your main text should be typed between double quotes usually in a 'body' section where shown.
	* Almost all can also use the same area using a larger font. This is typically called the 'title' section but need not be restricted to just a heading - regard it as just a larger font option for any use or position on the page; it can even be used for the main text if a larger font is needed.		* Almost all can also use the same area using a larger font. This is typically called the 'title' section but need not be restricted to just a heading - regard it as just a larger font option for any use or position on the page; it can even be used for the main text if a larger font is needed.
	* Both 'title' and 'body' sections can ''independently'' fill the same page (i.e., like two overlays on a blank sheet)~~, so~~ when mixing leave spaces for the other ~~font~~.		* Both 'title' and 'body' sections can ''independently'' fill the same page (i.e., like two overlays on a blank sheet). So when mixing both, leave spaces for the other's text, to avoid overlapping characters.
	* You now have choices:		* You now have choices:
	# Put text in the body only and leave the title blank.		# Put text in the body only and leave the title blank.

Geep: /* Inserting Readables Prefabs */ Clarify title vs. body overlap. Add comment about lack of markup

2020-03-10T12:00:14Z

Inserting Readables Prefabs: Clarify title vs. body overlap. Add comment about lack of markup

← Older revision		Revision as of 12:00, 10 March 2020
Line 33:		Line 33:
	* In all xdata sections, your main text should be typed between double quotes usually in a 'body' section where shown.		* In all xdata sections, your main text should be typed between double quotes usually in a 'body' section where shown.
	* Almost all can also use the same area using a larger font. This is typically called the 'title' section but need not be restricted to just a heading - regard it as just a larger font option for any use or position on the page; it can even be used for the main text if a larger font is needed.		* Almost all can also use the same area using a larger font. This is typically called the 'title' section but need not be restricted to just a heading - regard it as just a larger font option for any use or position on the page; it can even be used for the main text if a larger font is needed.
	* Both 'title' and 'body' sections can fill the same page so when mixing leave spaces for the other font.		* Both 'title' and 'body' sections can ''independently'' fill the same page (i.e., like two overlays on a blank sheet), so when mixing leave spaces for the other font.
	* You now have choices:		* You now have choices:
	# Put text in the body only and leave the title blank.		# Put text in the body only and leave the title blank.
Line 52:		Line 52:

	* '''Do not press the Enter key to start a new line within the quotes--the readable will not work if you do!''' Long lines will wordwrap in the game readable. If you should want to force a new line within quotes then type \n. Tip : set your text editor to wordwrap and narrow its window to approximate the width of the page in-game.		* '''Do not press the Enter key to start a new line within the quotes--the readable will not work if you do!''' Long lines will wordwrap in the game readable. If you should want to force a new line within quotes then type \n. Tip : set your text editor to wordwrap and narrow its window to approximate the width of the page in-game.

			Geep comments, 2020: Note that any given page can only have 1 font for both title and body. But different pages can have different fonts, by editing the "gui_pageN" settings at the bottom of the page setting. No markup is available for font size ''within'' a line, or for italics, bold, and underline. You may be able to fake a font size change within a line by using the title/body overlap, but with low probability of success.

Springheel: /* Inserting Readables Prefabs */

2009-02-07T12:21:14Z

Inserting Readables Prefabs

← Older revision		Revision as of 12:21, 7 February 2009
Line 51:		Line 51:
	}		}

	* Do not press the Enter key to start a new line within the quotes - ~~let your plain text editor wordwrap and long~~ lines will ~~also~~ wordwrap in the game readable. If you should want to force a new line within quotes then type \n. Tip : set your text editor to wordwrap and narrow its window to approximate the width of the page in-game.		* '''Do not press the Enter key to start a new line within the quotes--the readable will not work if you do!''' Long lines will wordwrap in the game readable. If you should want to force a new line within quotes then type \n. Tip : set your text editor to wordwrap and narrow its window to approximate the width of the page in-game.

Springheel: /* Inserting Readables Prefabs */

2009-02-06T00:26:12Z

Inserting Readables Prefabs

← Older revision		Revision as of 00:26, 6 February 2009
Line 24:		Line 24:
	* In your map editor, in orthoview, point to where you want the readable, RMB, insert prefab, select a readables prefab. There are images at [[Fonts Screenshots]] so you can see what the fonts look like.		* In your map editor, in orthoview, point to where you want the readable, RMB, insert prefab, select a readables prefab. There are images at [[Fonts Screenshots]] so you can see what the fonts look like.
	* With the readable selected, in Entity Inspector note the xdata name from xdata_contents. (tip: highlight then Ctrl+C to copy it)		* With the readable selected, in Entity Inspector note the xdata name from xdata_contents. (tip: highlight then Ctrl+C to copy it)
	* ~~Find~~ that xdata name ~~below here now~~ (tip: F3 to search (usually) paste in the name)		* Open the file xdata/prefab.xd in a text editor and find that xdata name you copied (tip: F3 to search (usually) paste in the name)
	* Select & copy the complete xdata section including the name and the last end curly bracket. (tip: look for a few blank lines then the next xdata header name.)		* Select & copy the complete xdata section including the name and the last end curly bracket. (tip: look for a few blank lines then the next xdata header name.)
	* Paste it into your own xd file, eg, mymap.xd.		* Paste it into your own xd file, eg, mymap.xd.