XML:Basic tutorial: Difference between revisions
Paradox-01 (talk | contribs) m (link to demokratos gui updated) |
Paradox-01 (talk | contribs) m (fixing link to particle page, changing ONIE's dot to red: there're a few imgs but no docu) |
||
Line 272: | Line 272: | ||
: List of weapons in a specific level which are spawned at level load. Actually only the position of them is set there. | : List of weapons in a specific level which are spawned at level load. Actually only the position of them is set there. | ||
|- | |- | ||
|'''BINA/[[OBD_talk:BINA/ONIE|ONIE]]''' [[Image:Aqua Dot- | |'''BINA/[[OBD_talk:BINA/ONIE|ONIE]]''' [[Image:Aqua Dot-Red.png]] | ||
: ONIE is a list of all impacts effects which can happen in the game. That includes weapon particle, hand-to-hand combat and movements. The impact effects depends on | : ONIE is a list of all impacts effects which can happen in the game. That includes weapon particle, hand-to-hand combat and movements. The impact effects depends on source type and the material which is hit. | ||
|- | |||
|'''[[OBD_talk:BINA/PAR3#XML_section|BINA/PAR3]]''' [[Image:Aqua Dot-Yellow.png]] | |||
: 3D particle. Particle are used as weapon's damage doer, decals and light effects. | |||
|- | |- | ||
|'''BINA/[[OBD_talk:BINA/TMBD|TMBD]]''' [[Image:Aqua Dot-Green.png]] | |'''BINA/[[OBD_talk:BINA/TMBD|TMBD]]''' [[Image:Aqua Dot-Green.png]] | ||
Line 326: | Line 329: | ||
|'''[[OBD_talk:OPge|OPge]]''' [[Image:Aqua Dot-Green.png]] | |'''[[OBD_talk:OPge|OPge]]''' [[Image:Aqua Dot-Green.png]] | ||
: Objective page. That's the place where you can write the objective for a new or modified level. | : Objective page. That's the place where you can write the objective for a new or modified level. | ||
|- | |- | ||
|'''[[OBD_talk:PSpc|PSpc]]''' [[Image:Aqua Dot-Green.png]] | |'''[[OBD_talk:PSpc|PSpc]]''' [[Image:Aqua Dot-Green.png]] |
Revision as of 14:42, 4 August 2009
mini-tutorial for 2009-7 AE release
What is XML modding?
- Binary data becomes converted into more human-readable form which allows easier modding. All supported file types can be seen HERE.
Okay, what do I need?
- OniSplit will be your tool. It's part of AE. Installing AE spares you some work because it splits the level achieves right away and globalize some more data. Global data can be used in any level.
AE installed. What now?
- OniSplit cannot be opened in a classic way. But you are lucky. Now we have a GUI (graphical user interface) for it.
- Mac user will want to get "AETools (Beta)"
- Unpack and put "AETool" and "AETools_Data" into your "edition" folder.
- Windows user will want to get "OniSplit GUI"
- Unpack and put the executables into your "GameDataFolder" inside "edition" folder.
- Mac user will want to get "AETools (Beta)"
What mod possibilities do I have?
- See HERE again. It's an overview what you could do. But note that some types can be more difficult to mod than other.
- If you need some ideas look at this page: modding brainstorms.
- If you want to contribute AE: bug-fixes and feature requests.
- Check also AE's current To-Do page and maybe there are fields that need a modder.
Is there an easy exercise to get me started?
- Just see at the following table. Read left side if you use a Macintosh, read right side if you use Windows.
converting an ONI file into an XML file | |||
---|---|---|---|
Update comes soon.Open AETools. Click on "Export" tab, select checkbox "Export as .xml file", then click on "Export .oni file" and chose "ONCCk4_L.oni". See "XMLfiles" in "AETools_Data". There you should find "ONCCk4_L.xml". | Open the GUI. Chose "ONI - XML" tab. Write "level0_Characters/ONCCk4_L.oni" into the first line. "XML" into the other. After clicking on "Convert" you should see a new folder named "ONI". |
||
modifing the XML file | |||
Open the extracted file with a simple text editor. Search for "HasSupershield" tag and set its value to "1". Save file. | Open the extracted file with a simple text editor. Search for "HasSupershield" tag and set its value to "1". Save file. | ||
creating the ONI file | |||
Write into the bottom line (manual input): "-create ONIfiles XMLfiles/ONCCk4_L.xml".
|
Goto GUI's "XML -> ONI" section and write "XML/ONCCk4_L.xml" into its first line and "ONI" into its second line. After clicking "Convert" you should see a new folder named "ONI".
|
||
creating and installing a mod package | |||
Download this package barebone.
|
|
Download this package barebone.
|
|
testing the modification | |||
Let's test our modification. Therefore we start TCTF HQ redux (pre-last level). The supershield becomes automatically switched on at 51% overpower (301 healh points). "chenille" cheat works too. | Let's test our modification. Therefore we start TCTF HQ redux (pre-last level). The supershield becomes automatically switched on at 51% overpower (301 healh points). "chenille" cheat works too. |
mini-tutorial for pre-2009-7 AE release
What is XML modding?
- Binary data becomes converted into more human-readable form which allows easier modding. All supported file types can be seen HERE.
Okay, what do I need?
- OniSplit will be your tool. It's part of AE. Installing AE spares you some work because it splits the level achieves right away and globalize some more data. Global data can be used in any level.
AE installed. What now?
- OniSplit cannot be opened in a classic way. But you are lucky. Now we have a GUI (graphical user interface) for it.
- Mac user will want to get "AETools (Beta)"
- Unpack and put "AETool" and "AETools_Data" into your "edition" folder.
- Windows user will want to get "OniSplit GUI"
- Unpack and put the executables into your "edition" folder.
- Mac user will want to get "AETools (Beta)"
What mod possibilities do I have?
- See HERE again. It's an overview what you could do. But note that some types can be more difficult to mod than other.
- If you need some ideas look at this page: modding brainstorms.
- If you want to contribute AE: bug-fixes and feature requests.
- Check also AE's current To-Do page and maybe there are fields that need a modder.
Is there an easy exercise to get me started?
- Just see at the following table. Read left side if you use a Macintosh, read right side if you use Windows.
converting an ONI file into an XML file | |||
---|---|---|---|
Open AETools. Click on "Export" tab, select checkbox "Export as .xml file", then click on "Export .oni file" and chose "ONCCk4_L.oni". See "XMLfiles" in "AETools_Data". There you should find "ONCCk4_L.xml". | Open the GUI. Chose "ONI - XML" tab. Write "GameDataFolder/level0_Final/ONCCk4_L.oni" into the first line. "extracted" into the other. After clicking on "Convert" you should see a new folder named "extracted". | ||
modifing the XML file | |||
Open the extracted file with a simple text editor. Search for "HasSupershield" tag and set its value to "1". Save file. | Open the extracted file with a simple text editor. Search for "HasSupershield" tag and set its value to "1". Save file. | ||
creating, debugging, and transporting the file | |||
Let's choose the "Import" tab now. Click on the first drop down menu in case there is not level0_Final already chosen. AETools will create the ONI file in that folder.
|
Goto GUI's "XML -> ONI" section and write "extracted/ONCCk4_L.xml" into its first line and "created" into its second line. After clicking "Convert" you should see a new folder named "created".
|
||
recombining the level archive | |||
Click on "Select Level to rebuild" and then "LEVEL 0: GLOBAL DATA". | Let's choose the GUI's first tab now, "Compile". Write "GameDataFolder/level0_Final" into the first line, "level0_Final" into the second and "GameDataFolder" into the third line. Click now on "Compile" and wait until onisplit's black window disappears again. | ||
testing the modification | |||
Let's test our modification. Therefore we start TCTF HQ redux (pre-last level). The supershield becomes automatically switched on at 51% overpower (301 healh points). "chenille" cheat works too. | Let's test our modification. Therefore we start TCTF HQ redux (pre-last level). The supershield becomes automatically switched on at 51% overpower (301 healh points). "chenille" cheat works too. |
supported file types
General information.
|
BINA/OBCJ/CHAR
|
BINA/OBCJ/CONS
|
BINA/OBCJ/CMBT
|
BINA/OBCJ/DOOR
|
BINA/OBCJ/FLAG
|
BINA/OBCJ/FURN
|
BINA/OBCJ/MELE
|
BINA/OBCJ/NEUT
|
BINA/OBCJ/PART
|
BINA/OBCJ/PATR
|
BINA/OBCJ/PWRU
|
BINA/OBCJ/SNDG
|
BINA/OBCJ/TRGV
|
BINA/OBCJ/TRIG
|
BINA/OBCJ/TURR
|
BINA/OBCJ/WEAP
|
BINA/ONIE
|
BINA/PAR3
|
BINA/TMBD
|
CONS
|
DPge
|
FILM
|
HPge
|
IGHH
|
IPge
|
Impt
|
Mtrl
|
ONCC
|
ONCV
|
ONGS
|
ONLD
|
ONSK
|
ONVL
|
ONWC
|
OPge
|
PSpc
|
PSpL
|
PSUI
|
TRAC
|
TRAM
|
TRGE
|
TRMA
|
TXMB
|
TXMP
|
TxtC
|
WMCL
|
WMDD
|
WMM
|
WPge
|
working with XML files: good to know
- capitalization rules (use of capital and small initial letters): You need to care about it because also Onisplit does.
- text position in a line: most tags have some distance towards line begin. It is not needed but preserve the overview.
- structure: some tags have children. It doesn't hurt to break the structure but is also not good for the overview. Example:
<Instance id="4" type="IGSA"> <Strings> <Link>#7</Link> </Strings> </Instance>
<Instance id="4" type="IGSA"><Strings><Link>#7</Link></Strings></Instance>
- code folding: don't destroy the structure to compress code. There are tools which can handle large xml files. (e.g. Microsoft Visual ... Express and xcode both for free)
- You can fold whole instances and parent tags.
- Folded code can be previewed in Microsoft Visual Express applications, although xcode provides an extra scroll popup.
Windows (Visual C++) |
way without Windows GUI: window address bar
Put the newest OniSplit.exe into the "edition\GameDataFolder" folder and use the window's address bar (that's where you can see the directory in full length).
Delete that address, type (for example) the code below, and hit enter.
onisplit -extract:xml xml_dir level0_Final/ONCCkonoko*.oni
The star is good for mess extraction/creation and good for shorten long unique file names. ("ONCCkonoko_generic" will be extracted in new folder "edition\GameDataFolder\xml_dir".)
It's also a good idea to keep the code in a temporary opened text file. There you can easily modify the code for other files and doesn't need you to type it from beginning into the address bar. (Be aware of Windows' short cut "shift + c" for coping marked text and "shift + v" for pasting text.)
way without Windows GUI: local called CMD
Useful for debugging. Copy the code into an empty text file and save it as whatever.reg, then double click it.
REGEDIT4 [HKEY_CLASSES_ROOT\Directory\shell\cmd] @="Open Command Window Here" [HKEY_CLASSES_ROOT\Directory\shell\cmd\command] @="cmd.exe /k \"cd %L\"" [HKEY_CLASSES_ROOT\Drive\shell\cmd] @="Open Command Window Here" [HKEY_CLASSES_ROOT\Drive\shell\cmd\command] @="cmd.exe /k \"cd %L\""
Now you can goto "Oni/edition" and mark the GameDataFolder, right-click it, a popup menu appears, click "Open Command Window Here".
way without Mac GUI: the terminal
Put the newest OniSplit.exe into the "Oni/GameDataFolder" folder.
Open the Terminal program then "change directory" to the GameDataFolder (Type "cd " then drag the GameDataFolder into the Terminal window, now press the RETURN key)
At this point you can enter the OniSplit commands, such as:
mono onisplit.exe -extract:xml xml_dir level0_Final/ONCCkonoko*.oni
("ONCCkonoko_generic" will be extracted in new folder "GameDataFolder/xml_dir".)
XML advanced tutorial
Read on HERE.