Difference between revisions of "Modding Encyclopaedia"
m (adding category tag) |
|||
| (One intermediate revision by one user not shown) | |||
| Line 10: | Line 10: | ||
To be able to use new pictures, just add them in the "truegfx" directory | To be able to use new pictures, just add them in the "truegfx" directory | ||
| − | The structure and syntax is explained | + | The structure and syntax is explained below. |
==How to test the changes ?== | ==How to test the changes ?== | ||
| Line 92: | Line 92: | ||
In the encyclopedia you see : | In the encyclopedia you see : | ||
This text will be displayed | This text will be displayed | ||
| + | |||
| + | [[Category:Modding]] | ||
Latest revision as of 03:19, 27 November 2018
This is guide on the ingame encyclopedia edition.
Contents
- 1 Which files should I edit ?
- 2 How can I edit the encyclopedia ?
- 3 How to test the changes ?
- 4 What is the structure of GAME.NFO ?
- 5 Why it the first line of the article special ?
- 6 How do I create links between article ?
- 7 How do I go back to the line ?
- 8 How can I add a picture ?
- 9 How do I add comments ?
Which files should I edit ?
The encyclopedia is contained in the file GAME.NFO found in URW main directory. The pictures are stored in the "truegfx" directory
How can I edit the encyclopedia ?
Just open the file with a text editor. Personally, I use Notepad++ (it is freeware) : it will display correctly finnish accents, and has some usefull plugins such as "compare".
To be able to use new pictures, just add them in the "truegfx" directory
The structure and syntax is explained below.
How to test the changes ?
URW will automatically read the GAME.NFO file that is in the main directory (where URW.exe is). When you edit an existing article, you just need to read the article in the in-game browser, or to refresh it. If you have added new articles, or new article titles, you need to exit the browser, and come back to it.
What is the structure of GAME.NFO ?
The file is simply a succession of articles, separated by ***
Articles title :
Each article starts with its title written in capital letters, and limited by 2 points. Example :
.START.
There can be multiple titles (or topics) for an article :
.MARKING OF TIME.YEAR.
Those titles are very important : thats what the game uses to link find the article. For example, if there an article which as the same title as one of your objects in the inventory, then you will be proposed to go straight to it. URW will automatically create a link from the word which correspond to title of one article. For example, you have "start" written somewhere, a link will automatically be created to the "Start" article.
The file "debug_topics.txt" list every topics that the game found last time it started.
Why it the first line of the article special ?
The first line of the article is important : the game will sometimes propose you to jump straight to an article (for example when you are browsing the rituals, or examinating your inventory). If an article corresponds to the object you have selected, the first line of the article is displayed. So when creating or modifying an article, it is important to make sure that the first line will bring enough information to the reader.
How do I create links between article ?
As explained above, URW automatically finds the words in your text which corresponds to an article, and thus creates a link. But an article will normally be linked once only in page (if you have "year" written twice you article, the link will only be created on the first time that word is written). However, you can force a link to be created twice : writte the word into bracket, to make sure thathe link will be created (such as [year] )
Erkka worte a while ago usefull tool, which will let you know which articles link to and from your article. (run browsertool.exe in the same directory as GAME.NFO, select the correct file, then open the "infobrowser.debug" file which has been created in a text editor.
How do I go back to the line ?
In the past, you had to go back manually to the line when writting a text, otherwise the text would just keep going out of the page (you can have 86 characters max on a page). Lately, Sami changed that behaviour : the text now automatically goes back to the line. And if the editor, if you only go back to next line, in the encyclopedia, the text will keep going.
In the editor you write :
Hello, This is a test.
In the encyclopedia, you read :
Hello, This is a test.So to go back to the line, you need to add :
<br>
In the editor you write :
Hello,<br> This is a test.
In the encyclopedia, you read :
Hello, This is a test.
Another solution is to leave an empty line in the editor : In the editor you write :
Hello, This is a test.
In the encyclopedia, you read :
Hello, This is a test.
How can I add a picture ?
To add a picture, you need write :
%POP picturename.jpg
with picturename.jpg being the name of the file in truegfx directory.
You can also resize the picture :
%POP picturename.jpg 300x200
In that case, the picture will be resized to 300x200 pixels. Be carefull to keep the original ratio !
I you wish to organise the pictures in "truegfx" directory (to export more easily the pictures you have added to the encyclopedia for example), you can create a sub directory and call the pictures as follows : (lets image that we have created a "subdirectory" in truegfx called "example", with picturename.jpg in it
%POP example/picturename.jpg
How do I add comments ?
Anything right to the // signs will be ignored
In the editor you write :
//This text will not be diplayed This text will be displayed
In the encyclopedia you see :
This text will be displayed
