Difference between revisions of "Fiction Viewer"
From FreeSpace Wiki
(New page: thumb|right|250px|The Fiction Viewer with Goober5000's sample story (click to enlarge) '''Fiction Viewer''' is a feature of [[Source Code Project|FreeSpace Ope...) |
(updated) |
||
| Line 5: | Line 5: | ||
The Fiction Viewer is the first window that will come up in a mission, followed by the Command Briefing—if the mission has both. | The Fiction Viewer is the first window that will come up in a mission, followed by the Command Briefing—if the mission has both. | ||
| − | ==Using the Fiction Viewer== | + | ==Using the Fiction Viewer (3.6.12. RC1 and newer)== |
| + | Open the mission in FRED. Select Editors --> Fiction Viewer and type in the file's name that you want to display, with its extension (for example: intro.txt). | ||
| + | |||
| + | ==Using the Fiction Viewer (pre-3.6.12. RC1)== | ||
To use the Fiction Viewer, take the following steps: | To use the Fiction Viewer, take the following steps: | ||
*Go to [http://www.hard-light.net/forums/index.php/topic,50565.0.html this] thread and download the interface art. Extract the VP file from the ZIP file and put it into FreeSpace 2/data or FreeSpace 2/<the name of your mod's directory> | *Go to [http://www.hard-light.net/forums/index.php/topic,50565.0.html this] thread and download the interface art. Extract the VP file from the ZIP file and put it into FreeSpace 2/data or FreeSpace 2/<the name of your mod's directory> | ||
| Line 16: | Line 19: | ||
$File: YourFileName.txt | $File: YourFileName.txt | ||
| − | === | + | ===Pre-3.6.12.-specific notes=== |
*Perhaps most importantly: Every time you save the mission in FRED, this piece of code will disappear! Add the Fiction Viewer code last before publishing the mission. | *Perhaps most importantly: Every time you save the mission in FRED, this piece of code will disappear! Add the Fiction Viewer code last before publishing the mission. | ||
| + | *The Fiction Viewer code must precede the Command Briefing code, otherwise the mission file will be broken. | ||
| + | *There is a colon (:) after "File", but there isn't anything after "Fiction Viewer". | ||
| + | |||
| + | ==General notes= | ||
*The code is not case-sensitive | *The code is not case-sensitive | ||
*You must provide the file's extension (.txt), otherwise the game engine will assume the file has no extension, and look for that. | *You must provide the file's extension (.txt), otherwise the game engine will assume the file has no extension, and look for that. | ||
| − | |||
| − | |||
*Since the text file is not in the mission file, semicolons (;) and double quotation marks (" ") will not break the mission code. | *Since the text file is not in the mission file, semicolons (;) and double quotation marks (" ") will not break the mission code. | ||
*Color tags such as $r and $h will work. | *Color tags such as $r and $h will work. | ||
Revision as of 19:52, 23 February 2010
Fiction Viewer is a feature of FreeSpace Open 3.6.10 implemented by Goober5000. It is sort of an advanced Command Briefing that mission designers could use to deepen the story that they want to tell without using the actual Command Briefing.
The Fiction Viewer is the first window that will come up in a mission, followed by the Command Briefing—if the mission has both.
Contents
Using the Fiction Viewer (3.6.12. RC1 and newer)
Open the mission in FRED. Select Editors --> Fiction Viewer and type in the file's name that you want to display, with its extension (for example: intro.txt).
Using the Fiction Viewer (pre-3.6.12. RC1)
To use the Fiction Viewer, take the following steps:
- Go to this thread and download the interface art. Extract the VP file from the ZIP file and put it into FreeSpace 2/data or FreeSpace 2/<the name of your mod's directory>
- Download the most stable official 3.6.10 here or get an experimental build from this board.
- Create a text file (.txt) that you want to show off with the Fiction Viewer, then put it into FreeSpace 2/data/fiction or FreeSpace 2/<your mod's directory name>/fiction.
- Create a mission which you want to use the Fiction Viewer, then open it in a text editor, adding the following line before "#Command Briefing":
#Fiction Viewer $File: YourFileName.txt
Pre-3.6.12.-specific notes
- Perhaps most importantly: Every time you save the mission in FRED, this piece of code will disappear! Add the Fiction Viewer code last before publishing the mission.
- The Fiction Viewer code must precede the Command Briefing code, otherwise the mission file will be broken.
- There is a colon (:) after "File", but there isn't anything after "Fiction Viewer".
=General notes
- The code is not case-sensitive
- You must provide the file's extension (.txt), otherwise the game engine will assume the file has no extension, and look for that.
- Since the text file is not in the mission file, semicolons (;) and double quotation marks (" ") will not break the mission code.
- Color tags such as $r and $h will work.
- Characters that are not in the English alphabet (such as á, é) will not be displayed..
- The interface art can be modified by extracting the files from the VP.
External links
- Fiction Viewer release thread
- Official FreeSpace Open 3.6.10 release thread (There are newer builds, but this one the most stable one)
