git » fp-git.git » commit a16efd2

Added documentation change log and a sample resources.xml

author ecalot
2003-10-17 13:56:29 UTC
committer ecalot
2003-10-17 13:56:29 UTC
parent 080baea890db217edbbde2315aedb2b838d76fcc

Added documentation change log and a sample resources.xml

PR/doc/changelog.txt +66 -0
PR/resources.xml +75 -0

diff --git a/PR/doc/changelog.txt b/PR/doc/changelog.txt
new file mode 100644
index 0000000..06bcc1e
--- /dev/null
+++ b/PR/doc/changelog.txt
@@ -0,0 +1,66 @@
+Princed Resources Editor V0.6 beta
+(c) Copyright 2003 - Princed Development Team
+http://www.princed.com.ar
+This program is open source under the GNU General Public License terms
+
+1) Change Log
+ * PG
+  - Added support to export .bmp files
+  - Added bitmap decompression
+  - Added static palette extraction
+ * PS
+  - Added support to .mid files
+  - Added support to indexed dat files
+ * PR 0.1 Alpha
+  - Merged PS and PG into one extractor.
+  - Added resource.txt parser.
+  - Solved several bugs.
+  - Coded type header verification
+  - Added dynamic palette extraction
+  - Added support to export JASC palette for .pal files.
+  - Added support to .wav files.
+ * PR 0.2 Alpha
+  - Added support to import .bmp files
+  - Source files were abstracted
+  - Added classifing dat type feature
+  - Implemented CGI output support for UNIX versions
+ * PR 0.3 beta
+  - Added pr.dll compiling
+  - Added modifiers -x[rnu] -c[r]
+  - Solved bugs in bitmap format
+  - Solved segmentation fault in title.dat
+  - Images bigger than 256 pixels lenght or width now are recognized
+  - Improved decompression algorithm in bigger images
+  - Optimized bitmap handling
+  - Bitmaps aren't upside down anymore 
+ * PR 0.4 beta
+  - Fixed a memory bug since v0.3
+  - Pop2 DAT files detected (file type 11)
+ * PR 0.5 beta
+  - Optimized bmp saving algorithm
+  - Abstracted format handling
+  - Solved and optimized decompression for big images
+  - Some Pop2 graphics are extracted (palettes aren't supported yet)
+ * PR 0.6 alpha
+  - Optimized PG algorithms and reserved memory sizes
+  - Completed and tested bmp reading algorithm
+  - Coded full import/export bmp (in separate files not included in this distribution)
+ * PR 0.6 beta
+  - Added full import bmp support
+
+2) ToDo List
+ i)   Fix bug in palette compiling
+ ii)  Improve support of bitmap compiling
+ iii) Codify the compression algorithms (B1 to B4) to optimize the bitmap compiled dat files
+ iv)  Move PG to bmp.c (only when all bitmaps are Ok)
+ v)   Add full pop2 support
+ vi)  Add resources tree. See the sample resources.xml
+ vii) Change the code to ANSI C
+
+3) Versions:
+  PR v0.6 beta: unestable, added ii, iv, first full working version
+  PR v0.7:      vii, tested & stable
+  PR v0.8 beta: added i,iii,vi
+  PR v0.9:      tested and stable
+  PR v1.0:      First optimized & stable version for win32 and linux
+
diff --git a/PR/resources.xml b/PR/resources.xml
new file mode 100644
index 0000000..71c6e27
--- /dev/null
+++ b/PR/resources.xml
@@ -0,0 +1,75 @@
+
+<?xml version="1.0" ?>
+ <itemtypes version="0.5">
+  <folder name="Prince of Persia 1" type="game">
+   <folder name="Sounds">
+    <folder name="Wave" itemtype="wave">
+     <item value="10058" file="digisnd1.dat">Door close</item>
+    </folder>
+    <folder name="Midi" itemtype="midi">
+    </folder>
+    <folder name="Speaker" itemtype="speaker">
+    </folder>
+   </folder>
+   <folder name="Images">
+    <folder name="Palettes" itemtype="palette">
+     <item value="11022" file="title.dat" external="pal1.bmp">Palette 1</item>
+    </folder>
+    <folder name="Animations" itemtype="image">
+     <folder name="Jaffar walking to princess" palette="11022">
+      <item value="11023" file="title.dat" external="walk1.bmp">Frame 1</item>
+      <item value="11024" file="title.dat" external="walk2.bmp">Frame 2</item>
+      <item value="11025" file="title.dat" external="walk3.bmp">Frame 3</item>
+      <item value="11026" file="title.dat" external="walk4.bmp">Frame 4</item>
+     </folder>
+    </folder>
+    <folder name="Titles" itemtype="image" palette="200">
+     <item value="203" file="title.dat" external="palace.bmp">Outside palace presentation</item>
+    </folder>
+
+    <folder name="Eviornment" itemtype="image">
+     <folder name="Dungeon"></folder>
+     <folder name="Palace"></folder>
+    </folder>
+    <folder name="Others" itemtype="image">
+    </folder>
+   </folder>
+   <folder name="Prince of Persia 2" type="game">
+   </folder>
+  </folder>
+ </itemtypes>
+
+<!--
+Attributes:
+ itemtypes:
+  o version: the version of the file (mandatory)
+ folder:
+  o type: the type of the folder
+    * game
+    * none
+  o itemtype: the type of the items below (if not specified)
+    * image
+    * palette
+    * level
+    * wave: digital audio
+    * midi: midi audio
+    * (...): extensible
+  o palette: the palette ID associated to the images in this folder if applicable
+  o name: the name of the folder (mandatory)
+  o desc: a description
+ item:
+  o value: the item ID (mandatory)
+  o file: the file where the item is located (mandatory)
+  o itemtype: see folder itemtype
+  o desc: a description
+  o external: the name of the file it will be extracted
+
+Notes:
+ - type images need a palette
+ - items need an itemtype (no matter if it is in folder or item)
+   in case it isn't set, PR will try to detect it.
+ - items need an external file name
+   in case it isn't set, PR will use (filename).(item id).(type extension)
+ - Distributed versions are read only and MUST have the GPL header
+ 
+-->
\ No newline at end of file