Open Source Rule Set

'NWNWiki Rule Set'

The NWNWiki Rule Set is also known as "NRS", the "Wiki Rules", and the "Wiki Rule Set".

Description of the Wiki Rules
NRS provides a set of predefined functionality for scripting your NWN module. It is not so much an "ERF" as it is a new way of building ERFs. 

The Wiki Rules provides a list of NRS Features.

NWNWiki maintains versioning of NRS Features and NRS Builds, allowing anyone to rollback (or undo) edits made by someone else.

Frequently Asked Questions about NRS
FAQ: Why should I use NRS? Isn't there already a lot of frameworks out there already that I can use? That have code? That can do something for me right now? Answer: Yes, there are existing frameworks that have been around for many years. Wiki Rules is public domain. Having many eyes look at the same code and having the ability to immediately change it is a Good Thing. Visit later on perhaps when more code is posted.

FAQ: Who will maintain all this code?

Answer: The NRS will be maintained by the public through the Wiki interface. Users can browse the code online, and make changes as they see fit while they are browsing the code. This is a very powerful concept, and is very different from managed code development. 

FAQ: I have a script to submit. How do I do this?

Answer: Create an Article like normal. In the body of the Article, enclose your script within the tags "pre" and "/pre" so it becomes exempt from Wiki interpretation. Assign it to the Category of each NRS Feature that it supports. You might have to create those Features separately by yourself before you can assign them into that Category. 

FAQ: I have an NRS Feature that I would like to see, but I don't have any code to submit. I want someone else to write that code. How can I make them write the code to make my game do what I want it to do?

Answer: This entry is equivalent to NWVault's "Idea Database", in that it is an idea, but does not have any implementation (code). Submit the Feature anyway like a normal Article, but don't include any code because you don't have any. It is generally understood that all Wiki Articles can be modified by anyone, but you may want to include a request to have the script coded. After it has been on the Wiki for some time, someone may have attended to it and filled out your request! Somebody may take it to writing the code, then placing it in a build.

FAQ: I see two separate NRS Features that are really the same, or they are related in someway that is not currently written into either Article. What should I do?

Answer: Edit the NRS Feature article just as you would edit any Wiki Article. Place links to the other Feature in each one. Someone will work out the issues and make it clearer later on when they review your changes.

FAQ: Why is this Wiki Rules system any better than NWVault? Answer: The Wiki Rules and NWVault are not competitors. NWVault maintains a storehouse of wealth of code, all donated free by the authors. Module builders who want to add Features to their world, however, are left to try and integrate the code by themselves. Many module builders are integrating the same code over and over. Greater time savings could be realized, and more productivity gained, if there was a system that not only held the code, but also implementations of the code. NRS tries to have the coders integrate their code once and then allow them to post their progress back for public display and further modification.

FAQ: Where do I get an ERF from? I want to try the NRS. Answer: An ERF is released with an NRS Build. When a Build is created, it's author attaches a file to the article. Click on the link to that file within the article, and it will be downloaded to your computer just like any other downloadable.

FAQ: How do I create a new Feature that I want to see in the Wiki Rules? Answer: Create an Article, and describe the Feature that you want to see. When a Build comes out that implements it, you would go to the Feature that you entered into Wiki, and then edit that Feature so that it is a member of the Build article you saw. Features can include other Features by declaring themself to be a member of that other feature, as a Category.

FAQ: What is included in a Build? Answer: Each Build should list the files that are included in the ERF, along with a short explanation/Justification for it's reason for existence in the ERF. For an example, see NRS Build 0.

FAQ: What about management? Doesn't the NRS need a single strong manager to guide the project so that there is useful content? Answer: This is not the case with Wiki. In traditional development systems, a manager is needed to focus the participants upon their individual goals. With Wiki, the participants monitor and manage themselves, according the subjects they are interested in. There will be public discussion within Wiki, and changes will be introduced that I am personally not happy with at all. In general, however, the quality and construction and design of the public will stabilize and create consistently good output from it's community. The participants will determine the results, not any one specific person.

FAQ: What if I don't like some feature I see in a Build? Answer: You can create your own Build to try to focus attention upon what results you would like to see. If others participate with you, then the Build will become a success. If others do not participate with you, then you are on your own, coding and all.

FAQ: Why do the Wiki Rules exist? Answer: NRS was initiated by me as a response to dealing with slow turn-around of managed code frameworks.

FAQ: How are the Wiki Rules different from the Hard Core Rule Set? Answer: NRS is public domain code. Scripters won't have to ask anyone to get permission to improve the code you see available, nor when you submit your own code. The public maintains and manages the scripts and the resulting ERF submissions.

FAQ: What can the NRS do for me? I see there aren't any ERF's that interest me. Answer: Initially after launch, there will be only the initial ERF known as NRS Build 0. This should serve as an example as to how the system will work, and will hopefully kick start the entire scripting contribution process as an example (for better or for worse).

FAQ: What are the restrictions on using NRS in my own module? What about posting on other sites? Answer: NRS is released under the terms of GPL license and of course the EULA. Basically this means you can do what you want with whatever code you can use.