Tree [22ad67] streams /
 History

HTTPS access


File Date Author Commit
 examples 2009-01-29 Jaroslav Benkovsky Jaroslav Benkovsky [166202] Trying to merge iesh-infinity branch
 infinity 2010-05-14 Jaka Kranjc Jaka Kranjc [57a530] treat chr 2.1 as 2.0
 COPYING 2005-03-02 Jaroslav Benkovsky Jaroslav Benkovsky [42ca9f] Initial revision
 Makefile 2009-01-29 Jaroslav Benkovsky Jaroslav Benkovsky [166202] Trying to merge iesh-infinity branch
 README 2010-03-24 Jaroslav Benkovsky Jaroslav Benkovsky [2a9a33] Update copyright year
 TODO 2010-05-21 Jaroslav Benkovsky Jaroslav Benkovsky [22ad67] Added some todos
 examples.py 2008-02-27 Jaroslav Benkovsky Jaroslav Benkovsky [c14c3c] Moved things a bit
 ieparse.py 2009-06-05 Jaroslav Benkovsky Jaroslav Benkovsky [1906f8] Added -o option, allows setting options, e.g. s...
 iesh 2010-03-24 Jaroslav Benkovsky Jaroslav Benkovsky [8862f3] iAnother insignificant change
 iezip 2009-08-28 Jaroslav Benkovsky Jaroslav Benkovsky [ccb340] Enhanced the iezip utility - more options, fixe...
 mos2tis.py 2009-01-29 Jaroslav Benkovsky Jaroslav Benkovsky [166202] Trying to merge iesh-infinity branch
 setup.py 2009-01-29 Jaroslav Benkovsky Jaroslav Benkovsky [166202] Trying to merge iesh-infinity branch

Read Me

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.