Skins: |

NWN SCRIPTS

- Jump to comments -

Title

Persistent Journal System

Author

Dauvis

Submitted / Updated

06-30-2003 / 11-22-2006

Category

Database Related

Expansions

Works on all versions

View Code

Readme for Journal System
=========================
Version 1.2
7/15/03
by Dauvis

This is a persistant journal system that uses campaign variables to store
player journal information.  While it could be useful for single player
and DM directed module, it probably most useful for PW modules.  This
system provides three function calls for managing the journal.  Two of these
functions are intended to replace the standard functions.

Installation
------------
1.  Import the DHJournal.erf file into the module.  Ignore any errors about
    missing scripts.

2.  If there isn't any script for OnClientEnter, go to step 4

3a. Open the OnClientEnter script.

3b. At the top of the script (somewhere before main()), add the following:

	#include "journal_include"

3c. At the top of the script's code (after main()), add the following:

    dhLoadJournalQuestStates(GetEnteringObject());

3d. Go to step 5.

4.  Set the OnClientEnter script to journal_gnrc_oce

5.  Installation complete.

Configuration
-------------
There is only two configuration options for the journal system.  In the
journal_db_name file, there is a string constant called strJournalDatabaseName.
Set this constant to the your campaign's name.  Also, for more control, you
can modify the dhGetJournalDatabaseName function to return the name of the
campaign that you wish to use for a specific player.

The other configuration option can be found in the journal_include file.  This
variable is a constant integer named bHideFinishedQuests.  If this variable
is set to TRUE, journal entries will not be loaded on a player character when
entering a module.  Conversely, if it is set to FALSE, the journal entries
will be loaded on the player character when entering the module.  By default,
this is set to FALSE.

Usage
-----
This system is a set of function calls that you can use to control the
player's journal.  Add '#include "journal_include"' at the top of your 
script file.  You need to use functions instead of the standard
AddJournalQuestEntry() and RemoveJournalEntry() functions.  Additionally, 
you should not use the journal information under the other actions tab
for conversations.  See the Functions.html file for more information.

ChangeLog
---------
Version 1.2:
	Added the bHideFinishedQuests configuration option and code to
        support it.

	Added the dhHideJournalQuestEntry function to allow manual hiding
	of quests.  See Functions.html for more information.

Version 1.1:  
	Modified the system to take advantage of the const keyword
	introduced in 1.30/SoU.  The call to dhJournalModuleLoad is no
	longer necessary but is still present for backwards compatibility.
	
	Added the dhGiveQuestItem function (see functions.html for more
	info).  

	Added dhGetJournalDatabaseName to allow customization of how the
	campaign name is determine (for example individual databases
	for each player).

Select All Text | View Code in separate window

Format

Code Only

Type

Type - Journal related

Includes

BioWare Standard

Description

This is a persistant journal system that uses campaign variables to store player journal information. While it could be useful for single player and DM directed module, it probably most useful for PW modules. This system provides three function calls for managing the journal. Two of these functions are intended to replace the standard functions.

Files

Name	Type	Size	Downloads
DauvisJournalSystem12.zipDauvisJournalSystem12.zip Submitted: 06-30-2003 / Last Updated: 07-15-2003	zip	9.47Kb	1175
--

SCORE OUT OF 10

9.75
3 votes
View Stats
Cast Your Vote!

PORTFOLIO

Add this entry to your portfolio so you can track it

Manage your existing portfolios or create a new one.

SCREENS

No Images

You Must Be Logged In to Participate.

Comments (18):

Posted by issendriel at 2008-01-03 17:57:30 Voted 9.75 on 01/03/08

Brilliant system, exactly what I needed for use with the Forgotten Realms Moonsea and Dalelands PW.

Posted by The Amethyst Dragon at 2005-12-01 15:05:50 Voted 9.50 on 12/01/05

Always great to have useful scripts like these.
_________________________
World of Aenea (Hall of Fame PW and the origin of all my works)
Vault Entries: The Complete List (50+ entries, including 17 Hall of Fame awards)

Self-Promotional Honesty: If you have opinions on stuff I've made, or if you use any of it (as a player or builder), I like comments/votes/feedback...so do other content makers and builders. Keep us motivated. :)

---------------------------- Neverwinter Nights Community Site: The Unofficial Homepage for NWN ----------------------------

Posted by The Amethyst Dragon at 2005-12-01 15:05:24 Voted 9.50 on 12/01/05

Posted by Anatida04 ( 216.59.xxx.xxx ) at 2004-07-13 16:28:00

I'd LOVE to have this system for APS/NWNX! Splief are you watching? :)

Posted by Gomisan at 2004-06-28 06:35:00

I'd like to see the converted script. I'm about to implement a NWNX system for my PW and need to move quests and journals over as painlessly as possible.

Posted by Old_Scores_Transfered at 2004-02-20 10:29:26 Voted 10.00 on 02/20/04

This is a compilation of the old system into a single score. There were 5 that made this score of 9.80 then rounded to 10.

Posted by Splief at 2004-02-19 21:35:00

I wrote to Dauvis shortly after converting this to work under NWNX/APS asking if he wanted it to post as an optional system. I never got a reply. So if there is enough interest, I will post what I use converted to work with APS.

Posted by I. Royo ( ..xxx.xxx ) at 2003-11-17 00:18:00

First, i LOVE that script, it is easy to use, it has some useful notes, it is somewhat simple and works... i want to join Richard's religion and praise to Dauvis.

However... it is not working so fine with my module. I'm using SoU and the last patches. My module i very simple, i think that nothing is interfering with the Journal System- I followed the installation guide and finally I make only one change, the name of the database file.
It didn't work, after a pair of hours of desperation y opened the folder NWN/Database. There i saw two database files, one had the name it should have, the other not -it was called JOURNALDATABASE.CDX-. Both seemed to contain similar information. Finally I decided that it was wrong. So i modified the name of databasefile in the script, to be called 'JOURNALDATABASE'.
And it Works!!! However i'm afraid, i don't understand why it doesn't worked before. And maybe now i'm going to damage something.

Please, take a look on it.
Thanks in advance

Posted by Richard Simons ( ..xxx.xxx ) at 2003-11-13 19:10:00

Praise, praise unto Dauvis! Hey man, sorry it�s taken me so long to let you know how great your changes work. I love this system. I�ve printed out your scripts and sleep with them. At the end of every week I perform a primitive blood ritual and devour the pages, hoping that through some bizarre process of osmosis I will attain the level of enlightenment allowing me to script such marvelous systems. I will name my first son Dauvis, and my second Journal_Include. Maybe _Include will be his middle name. Journal_Include does have a rather odd sound to it, but in China people have names that seem like FirstMiddle names. Like Xiang Xiang and WeiLing�but I�m not in China, nor do I plan on raising a family there. No matter, I have plenty of time to decide.

Good work Dauvis, and thank you again!

Posted by Splief ( ..xxx.xxx ) at 2003-11-08 11:40:00

Beats me why more people arent using this system for peristent journal entries. With a little alteration, this seems to be working fine under NWNX/APS.

[We don't neeed no stinkin' NWN database!]

Posted by Dauvis ( ..xxx.xxx ) at 2003-07-17 05:50:00

Bioware did say that the changes they were going to make in 1.31 was going to be incompatible. I, personally, would hold off until 1.31.

If I can get hold of the 1.31 beta, I'll see how they changed it.

Posted by Dominus ( ..xxx.xxx ) at 2003-07-15 23:55:00

Any plans or suggestions on how to deal with the change when Bioware releases patch 1.31? I would love to intigrate this system into the PW I do scripting for. It would be great to keep track of quests, instead of the token based sytem in place. But I fear loosing all the info when we upgrade to 1.31. Any help would be welcomed.

Seth(Dominus)

Posted by Dauvis ( ..xxx.xxx ) at 2003-07-13 16:54:00

That sounds like a good feature to have. The journal entries that have been marked as finish not showing is a feature. I was trying to emulate the quest log on DAoC (as well as to improve performance). The next version will have a flag that can be set to specify if the finsihed entries should disappear.

Posted by Richard Simons ( ..xxx.xxx ) at 2003-07-13 15:45:00

Dauvis,

You da man! Thanks for turning this around so quickly. I imported the new script and it is working very well. Though, at first I think I made the variable name too long (PersistentJournal) as it didn�t put the name on the database and the journal entries were not recording, though they were being applied like normal non-persistent journal entries. After making the database name smaller this worked fine.

Another question: once a journal entry is marked as completed it does not load back into the journal. Is there a way to turn this off so I can control when journal entries are removed? This may actually be commented in your script but I have not yet had time to look over it.

Thanks again for your help and for creating this great script!

Posted by Dauvis ( ..xxx.xxx ) at 2003-07-13 08:13:00

I had a bit of insomnia so I made the change. The campaign name is controlled by a function. I released a new version and it should be available with the next update. Send me an e-mail if you would like a copy before then.

Posted by Richard Simons ( ..xxx.xxx ) at 2003-07-12 17:42:00

Dauvis,

Incredible work on this! Question: I wanted to change this script around a bit so that I could assign the database to a single PC rather then just dump all the data into one database. So I changed the line in SetCampaign* from GetModule() to GetPCPlayerName(oPC)+GetName(oPC). I also modified and put dhJournalModuleLoad(); in OnClientEnter so that it would set as a local variable on the PC. Unless I�m really missing something (or I really am dumber than I look) it would seem to me that this should work, but it does not. In fact, the database is never created. I can email you the altered script if you�re interested. Any help you or anyone could lend would be great.

Posted by ffbj ( ..xxx.xxx ) at 2003-07-10 20:09:00

This is sweet. From my point of view one of the biggest stumbling blocks for persistence, is now a thing of the past. Great job and thanks for the help.

Posted by Foolish Demon ( ..xxx.xxx ) at 2003-07-04 00:22:00

Cool! No more having to re-apply journal entries for me!

You must be Logged In to post comments in this section.