=======================
BinIPL Manager by UZI-I
=======================
version 0.0.1

UZI-I Production 2008

release date 3.March.2008

=====================================================================
a tool to compile and de-compile binary ipl files for GTA San Andreas.
======================================================================



=====================================================================
in order to use binary ipl's you must first understand how they work.
=====================================================================

1.Binary ipl's are linked to a parent ide and ipl file pair. 

example (with example filenames) :-
-----------------------------------
gtaforums.ide (normal map ide)
gtaforums.ipl (normal map ipl)
gtaforums_stream0.ipl (binary ipl to be added to the gta3.img)

2.you can have up to 9 (as far as we know atm) binary ipl files for any given mapped ide/ipl pair.

examples:-
----------
gtaforums_stream0.ipl
gtaforums_stream1.ipl
gtaforums_stream2.ipl
gtaforums_stream3.ipl
gtaforums_stream4.ipl
gtaforums_stream5.ipl
gtaforums_stream6.ipl
gtaforums_stream7.ipl
gtaforums_stream8.ipl

3.binary ipl line entries do not use normal model names for streaming from the img, after compiling the model name will be deleted within the compiled binary ipl, you can still use normal ipl model names with your ipl file that will be compiled and this process will be done automatically by BinIPL_Manager.

example of pre_compiled ipl line:-
----------------------------------

1283, MTraffic1, 0, 399.567, 1889.72, 22.0769, 0.0, 0.0, 1.0, 0.0, -1

example of the change made to the binary ipl when de_compiled:-
---------------------------------------------------------------

1283, ModelName, 0, 399.567, 1889.72, 22.0769, 0.0, 0.0, 1.0, 0.0, -1

4.in order to get binary ipl's to show your mapped models properly ingame you need to make sure that at least
one of the ipl line entries has a corresponding definition line in the ide, you cannot use a binary ipl filled with only standard SA generics, they will not show up ingame, the defined ipl entry can be placed anywhere within the binary ipl, but was only tested at the start and the end of the test file (after "inst" and before "end").

example:-
---------

ide entry
---------
obj
6765, illurb_BM7, myriad_prt, 300, 128
end

binary.ipl entry
---------
inst
6765, illurb_BM7, 0, 627.281, 2589.65, 14.6588, 0.0, 0.0, 0.0, 1.0, -1
1283, MTraffic1, 0, 399.567, 1889.72, 22.0769, 0.0, 0.0, 1.0, 0.0, -1
1283, MTraffic1, 0, 400.433, 1909.7, 22.0769, 0.0, 0.0, 1.50996e-007, 1.0, -1
1283, MTraffic1, 0, 400.433, 1710.28, 12.077, 0.0, 0.0, 1.50996e-007, 1.0, -1
1283, MTraffic1, 0, 399.568, 1689.72, 12.077, 0.0, 0.0, 1.0, 1.62921e-007, -1
1283, MTraffic1, 0, 739.722, 1900.43, 39.5766, 0.0, 0.0, -0.707107, 0.707107, -1
1283, MTraffic1, 0, 620.156, 1699.69, 18.3268, 0.0, 0.0, 0.707107, 0.707107, -1
1283, MTraffic1, 0, 589.723, 1700.44, 18.327, 0.0, 0.0, -0.707107, 0.707107, -1
1283, MTraffic1, 0, 589.723, 1550.43, 21.9299, 0.0, 0.0, -0.707107, 0.707107, -1
1283, MTraffic1, 0, 200.432, 1720.28, 12.077, 0.0, 0.0, 0.0, 1.0, -1
end

5. you can use comment (#) lines but ONLY before "inst" and after "end" in your binary ipl text file, but they will no longer be there when you de_compile the file again.

6. at the time of release, we did not get LOD entries to work, they crash the game atm. The ParkedCar section isn't supported yet.

-----------------------------------------------------------------------------------------

================================================================
Instrutions on how to make binary ipl files with BinIPL_Manager.
================================================================


============================================================================
****Important!!All files are worked on within the BinIPL_Manager folder.****
============================================================================

There are 2 methods we can use for compiling and de-compiling binary ipl's.
===========================================================================


==========================
1st method is as follows:-
==========================

Using the included compile.bat for compiling your binary ipl.
=============================================================
1.create a binary_stream0.txt file that contains all the ipl lines you want to compile into a binary_stream0.ipl.(remember to include "inst" and "end" )
2.run the compile.bat and you will see a new file in your BinIPL_Manager folder called binary_stream0.ipl
3.you can then rename the binary_stream0.ipl file to whatever name you want it to be.
4.add your binary ipl to the gta3.img. 

Using the included de_compile.bat for de_compiling your binary ipl.
===================================================================
1.Rename the binary ipl you want to de-compile to binary_stream0.ipl.
2.run de_compile.bat and a file called binary_stream0.txt will be created in your BinIPL_Manager folder.
3.you can now edit your binary_stream0.txt file to contain whatever you want.

=================
****Important**** 
=================
remember to backup any existing binary_stream0.ipl or binary_stream0.txt files you may have previously created that you want to keep as they will be overwritten.


==========================
2nd method is as follows:- 
==========================

===================================
compiling using your own .bat file.
===================================
1.make a .txt file with whatever name you want.

Example:- compile.txt

2.edit it to contain the following line, using whatever filename you have used for your binary_stream0.txt.

BinIPL_Manager.exe compile binary_example.txt binary_example.ipl

3.save file then rename .txt to .bat

Example:- compile.bat

4.run your compile.bat file and a new binary_example.ipl file will be created in your BinIPL_Manager folder with whatever filename you used.

5.add your new binary_example.ipl file to the gta3.img

======================================
De_compiling using your own .bat file.
======================================
1.make a .txt file with whatever name you want.

Example:- de_compile.txt

2.edit it to contain the following line, using whatever filename you have used for your binary_stream0.ipl.

BinIPL_Manager.exe compile binary_example.ipl binary_example.txt

3.save file then rename .txt to .bat

Example:- de_compile.bat

4.run your .bat file and a new binary_stream0.txt file will be created in your BinIPL_Manager folder with whatever filename you used.

5.you can now edit your binary_example.txt.

======================================
Information.
======================================

In this pack you will find all the original binary ipl files. And the script for decompile them. Have Fun :)

====================================================================================================================
****Important**** if you want to host this tool please email/PM UZI-I via the following websites with a link to your forum/website where hosting
====================================================================================================================

dkill.uzi@gmail.com (Email and MSN)
www.gtaforums.com
www.gtaforums.fr

Read me by Gforce 03.March.2008

