NWNadm documentation (sort of)

How to upload a BIC file into an account

The steps are as follows:

  • 0 Prepare the file
  • 1 Upload the file
  • 2 Move it to the "incoming" vault.
  • (3 missing here as it is an informational step)
  • 4 Rename the uploaded account to the account to move the file into.
  • 5 Move this account from "incoming" to "vaultbase".
This way it is merged with the existing account.

Step zero: Prepare the file

You can upload the file (the BIC) directly, uncompressed. But you can ZIP the BIC file to save upload bandwidth. Sorry, RAR is not yet supported!

If you upload a file named this_is_the_name.bic, it will show up as "vault/incoming/this_is_the_name.bic/this_is_the_name.bic".

If you upload a files named "this_is_the_name.bic" in a ZIP named "this_is_the_zip.zip", the it will show up as "vault/incoming/this_is_the_zip.zip/this_is_the_name.bic".

So, to name the file, you have to give the correct filename. There is no way to rename the file later on.

Note that you can put more than one file into the ZIP.
Also note, that if you upload files which already exist in "incoming", the old files are not overwritten, but they are renamed "automagically" into something like "moveNNN.bic" where NNN is a number starting at 1. So the uploaded file gets the name of the upload and "pushes" away old files.

If you want to do it cleanly, move the data which is in "incoming" into "deleted" first, see "Cleanup Step" at the end.

First step: Upload it into the UpDown area

Go to "UpDown" (1), select the file you want to upload (2) and press "Upload" (3). The file is uploaded which may take quite a while.

The fist step, the upload.

If the window is not updated automatically, you can reload it:

Reload the upper frame

It shall look like in the next screenshot.

Second step: Move it to "vault" named "incoming"

The file is moved into a special vault named "incoming". This is not the vault where all the character files are stored, it's an intermediate vault such that you can test everything before you are sure that everything is ok.

Select the file you want to move and press "move to vault".

select the correct file and press "move to vault".

After you pressed the button, your screen looks like following:

the output after "moved to vault"

In the Viper logfile you will see something like following:
   473-2006-03-06 19:09:47 Viper: action act.tino.440c7aeaa8c8d: install  <upload/uploadarchive.zip> -> <vault/incoming>
   474-2006-03-06 19:09:47 Viper: created directory incoming/uploadarchive.zip 

Note that all "moves" are done by one script, regardless if "within a vault" or "into a vault". It's always a "merge", see Step 5. So if you happen to use one filename of an existing destination, the destination is "renamed away" (moveNNN.bic).

Third step: Go into "Logfiles" "vault" "incoming"

There you will find the directory named after the uploaded filename. The directory will contain the file, or if the upload was a .ZIP it will contain the contents (without path information).

As the uploaded file name was "uploadarchive.zip" you will find the directory under the letter "u". Press the "action" Link:

Select the uploaded file in the "incoming" vault

You can look into the directory by clicking on the name on the right of the text " action "

Fourth step: Rename the directory to the account name

This is case sensitive, so please be sure to use the correct spelling. You can find the correct spellin in ghe "vaultbase" vault (this is the main character vault). But please do not be confused, you must use the action in the "incoming" vault!

Let's say that the Accountname is "TinoTest", then it looks like:

rename "uploadachive.zip" to "TinoTest"

This, again, is done by Viper. In the Viper-log there will be something like:
   475-2006-03-06 19:34:33 Viper: action act.tino.440c80b8e196c: move  <incoming/uploadarchive.zip> -> <incoming/TinoTest>
   476-2006-03-06 19:34:33 Viper: created directory incoming/TinoTest

To "reload" the page click on "incoming" and then the letter "T" (as TinoTest starts with it) and there it is. Please note that the letter "u" vanished, as it is no more present:

"Logfiles" "vault" "incoming" after the rename action.

Fifth (last) step: Move it into the real character vault

Everything up to here has taken place in the "incoming" vault. This is a scratch area, where nothing shall harm the running NWN server. Now, if you are happy with the result, you can "merge" the new stuff into the real vault.

"Merge" means, files from the source "overwrite" existing files with the same name. Existing files with a different name are untouched. However, the files which are overwritten do not vanish. They are renamed "moveXXX.bic" where XXX is a number (counts up).

So if uploaded a file "a.bic" and another "a.bic" is present in the vault, the latter file "a.bic" is renamed to "move1.bic" (or similar) and the new "a.bic" is the file, you just uploaded. Please note that NWN does not look into file names, as the names can be mangled anyway (it, instead, looks into the contents).

So bring the character file active, you must move it into "another" (the main) vault. This is done as follows:

Transfer the data from "incoming" into "vaultbase" (the main character vault)

Again, Viper tells you something in the log:
   477-2006-03-06 19:51:01 Viper: action act.tino.440c8494a0d80: move  <incoming/TinoTest> -> <vaultbase/TinoTest>
   478-2006-03-06 19:51:01 Viper: created directory vaultbase/TinoTest
Note that if the account already exists, the line "created directory vaultase/XXX" will not show up. This here is an example, so the chosen Account did not exist before.

Cleanup step: If something goes wrong

Shit happens. This is normal. You upload something, and you are dissatisfied.

How to clean up things in "incoming" vault? There is a "bitbucket" called "deletebase" and listed as "deleted". The files are moved there, so they still exist (for some time), but they do no more harm this way.

So just "move" it to "deleted" instead of somewhere else.

Important! Be sure you are in "Incoming Vault". You start again like in the last picture of Step 4:

(same as above: "Logfiles" "vault" "incoming" after the rename action.)

Now, instead the last step, just move it into "deleted" as follows:
You can not do real harm, but you can get yourself in trouble if you do it in the wrong vault.

This works for all vaults, not only incoming. However, due to the "merge" feature, you might get into trouble, as Gravedigger already might have expired some accounts, and those will show up under "deleted", too! There is no real logfile which helps you to check if a BIC file was valid or not.