Documentation

[lylver]

I know Zantigui and Mostal as leader of the french neverwinternights2 community site where I contribute in Babel project also.
As an advanced user (nwnx2 & nwn-ff), perhaps I'll be implied in the translation.

Already now, I can say that we are enthousiast about the project.
NWNX4 will be used, as early as possible, on our "Lodoss Nwn2" project and also, as far as I know, in then "Tryhades Nwn2" project.
So you'll get feed back if documentation lacks I think.

[caloup]

[j_dunn]

Hey Paps... I'll help you out with the Docs if you like. I am starting up NWMush again to port it over to NWN2/NWNX^4, and figured I would write a journal on how I did everything to help people out, so I guess I can use that idea instead and make it into documentation for setting up, configuring, and working with NWNX instead using examples from my own tools if you like. Just drop me a note or let me know if you want the help.

-J_Dunn

[Papillon]

Your offer is seriously appreciated

What type of systems (database, plugins, and so on) are you going to set up ?
_________________
Papillon

[j_dunn]

Well I still need to play around with the toolset to see what the scripting limitations are compared to NwN, but before I shut down the NWMush program back with NWN it was pretty in depth DB... Basically the whole purpose of the project is to take the features/capabilities of something like the TinyMU* line of servers and implement them into NWN persistant worlds. Basically it boiled down to only having to use the toolset for building the heavily static parts of the world (basically anything that could not be put into the game via a script command like terrain tiles), and having wands/widgets instead that allowed realtime building of the world from within the game client itself (i.e. setting up NPC's, waypoints, decorating the areas, etc.) so you could leave the server running 24/7 and only have to shut down and update to add the new empty areas.

Basically the short of how it worked is thus:

1. Server starts up with all of the areas being empty at launch.
2. When a player enters a "zone"/"Area" the server checked to see if anyone was present in the zone/area.
3. If someone was not in there it referenced the DB table for that area and then ran a loop for the number of entries which essentially spawned all of the placeables, NPCs, etc. for that area as the player was loading in using the create commands.
4. When the last person left the area it then destroyed all of the objects in the area essentially shutting it down until someone re-entered the area.

Had it working with dynamic area linking, storage, etc. etc... And due to the DB/scripting requirements it basically required a full on complete DB structure for everything from User accounts, to item storage/vaults, and the like... Actually that is one reason I loved NWNX so much when it first came out as simply giving access to SQL DB's and the simple ability to pass SQL calls directly from the engine totally expanded what could be done with the game. I'm kind of hoping the scripting capabilities of NWN2 is just as plentiful (kind of worried about if we can drop placeables as easily as now it appears they may have to be "baked" into the level) as setting up a NWNX server like that could dramatically lower the size of the areas as everything is essentially kept in the DB.... Especially since apparently you can now use buildings as placeables, but again I don't know the scripting limitations... This weekend I'm going to get around to firing up the toolset for more than piddling around and try testing by simply using a wand with a create script on it and see if I can drop buildings on the fly, and see if I can't get doors to do the same or not....

Anyways sorry for the long convoluted post, it's late here, I'm tired, and the idea of getting back into the NWMush project is actually getting me fired up again. Quit it last time because after 2 months of working straight on it with no assistance (other than various PWs lobbing their ideas at me) kinda burned me out... But that's neither here nor there, and the community has grown quite abit since then. But if you want just let me know what you are looking for and I am sure I can work it in. As I said my project is basically just a barebones system/toolkit to help ease development of PWs and it's going to require everything from the most basic account DB table functions up to item/placeable storage and the like.

[Papillon]

From an NWNX perspective, this sounds like a relatively basic setup, since you are using the main program and a DB plugin only. The fact that you are creating complex data structures in the database is interesting. Maybe you could also write something about the tools you are using ? Not a full documentation, just some pointers to downloads or howtos would be of help for new users.

I guess what an average newcomers wants to know is:

1) What can I do with NWNX and how does it work (architecture) ?
2) How do I install a database ?
3) How do I use the database (initial table setup, querying data)
4) How do scripts interact with the database ?
5) What other plugins are there (in the future, that is)

I could give some inputs on those points, if required.
_________________
Papillon

[Papillon]

Here is a small example for a plugin documentation: NWNX Timer docs.

It's short, but I think it contains enough information. Something like this would be the minimum for each NWNX plugin.
_________________
Papillon

[j_dunn]

Pap, sorry I haven't been back here since my last post. Daughter destroyed the computer at home the next day and I just got a new one last Friday. Getting NWNX4 tonight and I'll see what I can whip up. I take it that it is pretty much still identical to NWNX in terms of the "basic" calls? Regardless I'll get it tonight when I get home and see what I can do...

As for the tools... I'm not really using anything "special" just Access from work to get into the DB itself and set up the various tables and cells, everything else is purely from NWNX/NWN/SQL from within the scripts calls.

[Carter_DC]

Actually, i wasn't able to find anywhere a proper step-by-step installation process.
So i wrote it, here : http://www.neverwinternights2.fr/modules/newbb/viewtopic.php?topic_id=1361&start=20#forumpost10580

unfortunately, it's written in french... and i could've translated it, but it's a bit late and..whatever...
I guess my felows of neverwintenights2.fr will translate it (if it's somewhat accurate) and submit it up here for approval.

and "more" unfortunalety, i just discovered that pap wanted something a bit more specific....

[Papillon]

Hey, great! My french is limited, but this sounds already very good!

One suggestion: You do not need to copy the contents of the ZIP package into the NWN2 folder. Actually, the idea is to create one ore more NWNX4 directories somewhere, and start the controller from there. This way, you can have multiple installations of NWNX with different settings. Later on, you will be able to start multiple servers with that.

The installation process will become simpler, when the nwnx installer is ready. I think if you would like to invest more time, it would be wise to spend it on points 2) and 3). Of course, only 2) can be written right now, since the table setup (which will be done be the demo module for the SQL plugins) is not ready yet.

If you guys could come up with an english version, I'd happily post it on the nwnx.org website.
_________________
Papillon

[La_Crampe]

I cannot help much with scripting but here my contribution.
Translated the Carter_DC tutorial.

[Papillon]

Thanks, I'll make some small edits and will post it soon !
_________________
Papillon

[caloup]

I'll work with carter to do a tutorial, basically in french but our team (Babel) on neverwinternights2.fr will probably translate it into an english version...

The summary would be something like that :

[Grinning Fool]

[Papillon]

Yeah, this could be a bit daunting to new users. It would have to be very clear to them what is required to get NWNX up, and what is optional. You could split it into two documents:

first: "basic setup"