Paraworld modding tool version 0.0.0.1

[Adder]

Kharg asked me to make a modding tool for SEASMOD.

In the zip file, look in example/bin for modpw.exe. This is the java program that you are looking for. Look in doc/readme.txt for a small howto.
I am appending the text of the howto to this post.
I am also uploading the sourcecode. This does not indicate that I am releasing it under an open or free software license at the moment - the tool is too undeveloped for it atm.
-------------------------
doc/readme.txt
-------------------------
This is the first version of the modpw modding tool for ParaWorld.
It should be useful for other modding projects as well.

This version does not have a GUI yet.
It is barely tested, so please do make backups.

In general, an error will cause the program to terminate.
However, if the error is encountered during the file switching step, a rollback will be attempted of all previous reversible changes.

Modding is control by scripts placed in modpw files.
To execute "example.modpw" for the example in the "example" directory, create a link like the one that is already there, or click the existing link(which will give an error). As "target" of the link, give the full path to modpw.exe, and append a space and the word "example". As "working directory" give the directory where the "example.modpw" file is in.

A script file starts with an an [install] section.
In this section, place "copyfromto", which take two arguments seperated by a semicolon.
This will create the backup files of the original files, which will later be use to undo all changes made by the mod.
It will write a file named "example.pwmod.installed", which does indicate whether not to run the [install] section a second time.

In the [switch] section, place "copyfromtowithbackup" commands, which takes 3 arguments, the modded file, the file to change, and the backup file of the original file. You may also use "deletewithbackup" commands, which take 2 arguments, the file todelete, and the backup file of the deleted file. In the lauch section, place the program to be called after the mod has been installed. Use the "execute" command,followed by a semicolon and the commandline to execute. In the example, this will call notepad with the modded file.

In the [restore] section, place commands to restore the original application. However, before this section is executed, all undoable commands are being undone. Undoable commands are: "copyfromtowithbackup" and "deletewithbackup".

There are also a "delete" command, which takes one argument and is not undoable. In general, all commands may be used in all sections, but it is recommended to use only undoable commands in the [switch] section.

Finally, there is the "set" command, which at the moment mayb be used to turn off the verification step for large files, which at the moment is used by default to verify that the files have been correctly copied. The commands are "set;verify;off" and "set;verify;on".

You need to have java 1.6.0 or better installed. Please download it from Sun for free if you don't have it.

Have fun modding.
Again, do have backups, as the program will do as told even if your script contains a typo.

Peter Schäfer, peter.schaefer@gmail.com aka Adder on http://www.para-welt.de

(c)2010 Peter Schäfer

The program may be used and distributed for non-commercial modding projects.
It is provided as is, with potential defects.
Before making changes to the java program, consult with me for a license.
When the program has been tested enough, it might be available from sourceforge.

[Adder]

Because of a problem with "side-by-side"-configuration in vista,
here is a new exe to try out. Maybe it doesn't throw the error.

[demetrius]

1 not working on xp x64??
2 what can we change with this tool??

[Kharg]

1 not working on xp x64??
2 what can we change with this tool??

1) not working on xp x86 too lol T_T
2) we can overwrite the file temporarily cause some files can't be overwrited with folder system

[Adder]

1 not working on xp x64??
2 what can we change with this tool??

The tool mainly is aimed at replacing files in base that cannot be overriden by the default paraworld mechanisms for mods, but can do other stuff as well.

[Adder]

Kharg, please try placing the dll file inside the zip in the directory of the application(.exe) If there is still an error message copy that to me.

BTW.: I have improved the code a little and will soon post a new version.

[AnthonyCole]

Ich habs probiert und hat nix gebracht

[Adder]

Here is the new version of the modding tool.
The executable should have been created differently, so new fun in trying it out.
--Adder
----------------------------------------
readme.txt
----------------------------------------
This is the first version of the modpw modding tool for ParaWorld.
It should be useful for other modding projects as well.

This version does not have a GUI yet.
It is barely tested, so please do make backups.

In general, an error will cause the program to terminate.
However, if the error is encountered during the file switching step, a rollback will be attempted of all previous reversible changes.

Modding is controlled by scripts placed in modpw files.
To execute "example1.modpw" for the example in the "example" directory, create a link like the one that is already there, or click the existing link(which will give an error). As "target" of the link, give the full path to modpw.exe, and append a space and the word "example1". As "working directory" give the directory where the "example1.modpw" file is in.

A script file starts with an an [install] section.
In this section, place "copyfromto", which take two arguments seperated by a semicolon.
This will create the backup files of the original files, which will later be use to undo all changes made by the mod.
It will write a file named "example.pwmod.installed", which does indicate whether not to run the [install] section a second time.

After the commands in the [install] section have been executed, the autoinstall commands will execute. More about that later.

In the [switch] section, place "copyfromtowithbackup" commands, which takes 3 arguments, the modded file, the file to change, and the backup file of the original file. You may also use "deletewithbackup" commands, which take 2 arguments, the file todelete, and the backup file of the deleted file. In the lauch section, place the program to be called after the mod has been installed. Use the "execute" command,followed by a semicolon and the commandline to execute. In the example, this will call notepad with the modded file.

In the [restore] section, place commands to restore the original application. However, before this section is executed, all undoable commands are being undone. Undoable commands are: "copyfromtowithbackup" and "deletewithbackup".

There are also a "delete" command, which takes one argument and is not undoable. In general, all commands may be used in all sections, but it is recommended to use only undoable commands in the [switch] section.

Finally, there is the "set" command, which at the moment mayb be used to turn off the verification step for large files, which at the moment is used by default to verify that the files have been correctly copied. The commands are "set;verify;off" and "set;verify;on".

A feature that is by default enabled is the "autoinstall" option, which may be turned off with "set;autoinstall;off" and be re-enabled with "set;autoinstall;on". When autoinstall is enabled, all of the two commands that use backups will also create an autoinstall command that creates the backup file automatically. You can see the feature in action if you remove the backups directory and the example.modpw.installed file and run example2 instead of example1.

In addition to your mod, you should prepare a mymod_restore.modpw mod that just copies the backup files to the original files. This will be useful when the computer reboots in the middle of an active mod. You should deliver it together with a mymod_restore.modpw.installed file to disable making backups, as the mod when running will create the backups.

You need to have java 1.6.0 or better installed. Please download it from Sun for free if you don't have it.

It appears the executable wrapper I am using, Launch4j, is requiring a download and install of the .NET 1.1 redistributable runtime.
So I have tried out packaging with JSMotth. Please try the new exe if you had problems.

Have fun modding.
Again, do have backups, as the program will do as told even if your script contains a mistake.

Peter Schäfer, peter.schaefer@gmail.com aka Adder on www.para-welt.de

(c)2010 Peter Schäfer

The program may be used and distributed for non-commercial modding projects.
It is provided as is, with potential defects.
Before making changes to the java program, consult with me for a license if possible.
When the program has been tested enough, it might be available from sourceforge.

[AnthonyCole]

There is no error
But i dont see any use for this execpt for filereplacing and that stuff, but its nice ^^
Maybe a tool for Modifiing the techtree would also be helpful?

[Kharg]

There is no error
But i dont see any use for this execpt for filereplacing and that stuff, but its nice ^^
Maybe a tool for Modifiing the techtree would also be helpful?

notepad LOL