HPL3/Amnesia: Rebirth/Tutorials/Tablets - Revision history

Darkfire: added a mention about notes

2020-11-10T17:51:27Z

added a mention about notes

Darkfire: Warning

2020-11-10T00:35:29Z

Warning

Darkfire: Final touches

2020-11-10T00:22:35Z

Final touches

Darkfire: More info

2020-11-10T00:09:53Z

More info

Darkfire: Created

2020-11-09T00:44:52Z

Created

New page

This tutorial will detail how to make a custom Dark World tablet. They are the dark-grey tablets that have hieroglyphic text on them which gets translated after a moment. The tutorial assumes you can set up your mod and have basic skills in scripting etc.

To get a custom readable tablet in Rebirth:
# Set up a new category for your map in <code>readables.cfg</code>
# Set the note ID and FrontEntry to whatever you want the note to be called
# Place a category of the same name in english.lang, and then set up an entry with the same name as the ID previously set in readables.cfg
# Place the <code>dw_tablet_readable.ent</code> entity somewhere in a level
# Name your tablet in game as <code>Readable_<ID HERE></code>
# Set the GUI func to <code>OnGuiDWNote</code> and set text side as wanted
# Place this script somewhere in your map script:
<syntaxhighlight lang="cpp">
void OnGuiDWNote(const tString&in asEntityName, float afTimeStep)
{
DWNote_RenderGUI(asEntityName, afTimeStep);
}
</syntaxhighlight>

If you want to make a tablet unreadable, you just make the entity name something that isnt in <code>readables.cfg</code>.
Frictional named all their unreadable tablets like this: <code>Readable_DWNote_MiscXX</code>

← Older revision		Revision as of 17:51, 10 November 2020
Line 1:		Line 1:
	This tutorial will detail how to make a custom Dark World tablet. They are the dark-grey tablets that have hieroglyphic text on them which gets translated after a moment. The tutorial assumes you can set up your mod and have basic skills in scripting etc.		This tutorial will detail how to make a custom Dark World tablet. They are the dark-grey tablets that have hieroglyphic text on them which gets translated after a moment. The tutorial assumes you can set up your mod and have basic skills in scripting etc.
		+
		+	If you are already familiar with [[HPL3/Amnesia: Rebirth/Tutorials/Notes\|how the readables system works]], the way the tablets work will be largely familiar to you. The tablets only require a few simple steps more than e.g. a note, but this tutorial will cover their creation from scratch.

	==Tutorial==		==Tutorial==

← Older revision		Revision as of 00:35, 10 November 2020
Line 28:		Line 28:

	If you want to make a tablet unreadable (orange gibberish), leave the Readable/ID parameter of the tablet empty. This means that it doesn't need lang and readables entries.		If you want to make a tablet unreadable (orange gibberish), leave the Readable/ID parameter of the tablet empty. This means that it doesn't need lang and readables entries.
		+
		+	{{warning\|You can add a BackEntry to a tablet, but the blue text won't render so it will be easily missed - and therefore is not recommended.}}

	Good practices:		Good practices:

@@ Line 4: / Line 4: @@
 To get a custom readable tablet in Rebirth:
-# Set up a new category for your map in <code>readables.cfg</code>.
+# In <code>readables.cfg</code>:
-# Set the note ID and FrontEntry to whatever you want the note to be called. They don't have to be the same.
+## Set up a new category for your map.
-# Place a category in <code>english.lang</code> with the same name as the ID in <code>readables.cfg</code>
+## Create a new entry. Set the note ID and FrontEntry to whatever you want. They don't have to be the same, although that's what FG usually did.
-# In that category, set up an entry with the same name as the FrontEntry name previously set for the tablet in <code>readables.cfg</code>
+# In <code>english.lang</code>:
-# Place the <code>dw_tablet_readable.ent</code> entity somewhere in a level
+## Place a category in with the same name as the category ID from <code>readables.cfg</code>
-# Set the Readable/ID parameter of the entity to the ID from <code>readables.cfg</code>
+## In that category, set up an entry with the same name as the FrontEntry name previously set for the tablet in <code>readables.cfg</code>
-# Set the GUI func to <code>OnGuiDWNote</code> and set text scale as wanted
+## Add an entry called <code><FrontEntry Name>_En</code>. This is the blue text that will appear on the tablet itself (you probably want to set the same text as previously).
-# Add this to your include list in your map script: <code>#include "helpers/custom/helper_props_custom.hps"</code>
+## Add an entry called <code><FrontEntry Name>_Name</code>. This is the name of the entry in the sketchbook.
-# Place this function somewhere in your script:
+## Add a category called "Levels" and inside add an entry which is called the same as the "Name" parameter in the <code>readables.cfg</code> category. This will be the sketchbook category.
 <syntaxhighlight lang="cpp">
 void OnGuiDWNote(const tString&in asEntityName, float afTimeStep)
@@ Line 20: / Line 27: @@
 </syntaxhighlight>
-If you want to make a tablet unreadable, leave the Readable/ID parameter of the tablet empty. This means that it doesn't need lang and readables entries.
+If you want to make a tablet unreadable (orange gibberish), leave the Readable/ID parameter of the tablet empty. This means that it doesn't need lang and readables entries.
-Optional steps:
+Good practices:
-* Set up the note so it appears in the sketchbook properly:
+* Name your tablet in game as <code>Readable_<ID HERE></code>
-** Add an entry called <code><FrontEntry Name>_Name</code> in the same map category in <code>english.lang</code>
+* If the tablet isn't going to be readable, name the entity like this: <code>Readable_DWNote_MiscXX</code>, where XX are numbers
 == Config file examples ==
@@ Line 36: / Line 40: @@
 		<Entry Name="TestTablet_FrontEntry">My first tablet bla bla bla bla bla</Entry>
 		<Entry Name="TestTablet_FrontEntry_Name">This is the entry name in the sketchbook</Entry>
    </CATEGORY>