[22ad67]: README  Maximize  Restore  History

Download this file

134 lines (101 with data), 3.5 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
iesh - Simple Python shell for exploring Infinity Engine-based data files
=========================================================================


Installation:
-------------
If you are installing from the source package, type

# python ./setup.py install

If you are installing from the binary package, untar the tarball
to a usual directory, e.g. /usr/local

Package contents:
  iesh - the shell
  infinity - python module package dealing with the reading of IE files
  infinity/formats/* - various modules for reading the specific IE file formats

  infinity/stream.py
  infinity/format.py
  infinity/core.py
  infinity/builtins.py
  
  data/ - directory for storing exported data, provided for convenience
  examples/ - some example code snippets


Configuration:
--------------

Edit ie_shell.py:

game_dir 
    - directory where the game you are interested in is installed

chitin_file
dialog_file 
    - names of RESREF and STRREF index files, located in game_dir.
      Edit the names if the case does not match

Other files:
  $HOME/.iesh_profile
  $HOME/.iesh_history
  $HOME/.iesh_save
  $HOME/.iesh_save-*


Running:
--------
Just type ./iesh or python ./iesh and you should see 
dots marking progress as the program loads CHITIN.KEY and DIALOG.TLK.

!!! This might take *extremely* long time on a slow computer and
a significant portion of memory. If it's too slow or too big, then
this proggie just is not for you :( !!! 

Once the files are loaded, you get Cmd: prompt, where you can type
python statements.

Now you can load files, inspect their contents, search them and export
objects out of them.

Getting help:
-------------
?, help
help (object)
help (infinity)
help (infinity.builtins)
...

The following resource formats are recognized in this version:
  2DA
  AREA V1.0
  BAM V1
  BAMC V1
  BIFF V1
  BIF V1.0
  CHUI V1
  CRE V1.2
  DLG V1.0
  IDS
  ITM V1.1
  KEY V1
  MOS V1
  MOSC V1
  PRO V1.0
  SPL V1
  STOR V1.1
  TIS V1
  TLK V1
  VVC V1.0
  WED V1.3
  WFX  V1.0
  WMAP V1.0

Type list_formats() to print list of recognized file formats.
  
Type `?' or `help' to get some online help and `q', `quit' or ^D
to exit the program.


Struc format:
-------------
key - field name, used as a key in the resulting object
type - data type used for read/write and presentation
off - field offset, relative to struc's offset 0x0000
enum - map of field values to their descriptions or IDS filename
mask - map of bit masks[FIXME: or bit nums?] to their descriptions
size - num of bytes for BYTES data type
count - count of fields of the same type and description
label - label printed for this field



License, disclaimer and similar stuff:
--------------------------------------

Copyright (C) 2004-2010 by Jaroslav Benkovsky, <edheldil@users.sf.net>

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

JavaScript is required for this form.





No, thanks