source: XmlTools2/trunk/readme.txt @ 961

Last change on this file since 961 was 961, checked in by s10k, 8 years ago

XmlTools
Uploaded javascript documentation

File size: 3.6 KB
Line 
1Readme.txt
2~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3XmlTools v2.0a
4~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
6----------------------------------
7Description:
8----------------------------------
9
10XmlTools is a command-line modding tool that operates on XML files.
11
12It supports many operations in XML files and even non implemented operations using custom javascript code.
13
14It is developed in C++ and works in both Mac OS and Windows.
15
16An additional guide with examples can be read here: http://wiki.oni2.net/XmlTools
17
18----------------------------------
19Full Features:
20----------------------------------
21
22-Update all values in a set of XML elements. (e.g., to reposition an OBAN animation or adjust pelvis height for a TRAM).
23
24-Inverts a set of XML elements. (e.g., invert an OBAN animation).
25
26-Add new values to a set of XML elements (e.g., add the 'unkillable' flag to some characters in a level).
27
28-Remove values from a set of XML elements (e.g., remove boss shields from characters in a level).
29
30-Replace values in a set XML elements (e.g., increase the health of characters by replacing the old HP value).
31
32-Patch file support allows the modder to list multiple commands in a file, to all be performed at once.
33
34-Add custom XML to existing files (patch only).
35
36-Remove XML from existing files (patch only).
37
38-Select elements using element name, parent element name, attribute name/value and XPath 1.0.
39
40-Powerful custom XML editing using javascript (for what you can't do with native operations) (patch only).
41
42----------------------------------
43Installation (standalone version):
44----------------------------------
45
46Extract XmlTools folder to any place in your computer. Open it with command line on windows or terminal in Mac OS.
47
48----------------------------------
49Contacts:
50----------------------------------
51
52Script10k, "faob2@hotmail.com"
53
54Oni Central Forum:
55http://oni.bungie.org
56->Select forum
57
58Oni Wiki:
59http://wiki.oni2.net
60
61----------------------------------
62Change Log:
63----------------------------------
642.0a, 20-02-2014
65-Added multithreading support for @CUSTOM_COMMAND, use wildcards in multiple files for the same js code to
66take advantage of this (performance may increase over 2.5 times)
67-Now a warning is given if a user javascript code (@CUSTOM_COMMAND) takes too much time to finish
68-Fixed small bug when applying patches with @COMMAND + --no-verbose where some std output should not be displayed
69-Added double single quotes in @COMMAND to allow single quotes in XPath expressions
70----------------------------------
712.0, 08-02-2014
72-Rewrite XmlTools fom the scratch from C# to C++ in order to increase (much!) the performance of the program
73-The program now uses the following libraries: Qt5, pugixml and jsxml js library
74-The commands were simplified (they now use unix like syntax)
75-Update node operation (old updatechainvalues) it now receives the DIFFERENCE between the old value
76and the new value instead of the new value
77-Update node operation (old updatechainvalues) relation parameter was removed
78-The program now only edits files with .xml extension
79-The program now only reads patches files with .patch or .oni-patch extensions
80-The patch files now have a XmlTools minimum version
81-Some patch files operations were renamed and some extra arguments added
82-Added option to select xml elements by attribute name and value
83-Added option to select xml elements by XPath 1.0 (should reduce further the need of javascript)
84-The insertion of xml via patch now support multiple nodes inside <xml></xml> tags
85-Added exclusive option for AEI which allows AEI to pass a list of .oni-patches to process
Note: See TracBrowser for help on using the repository browser.