====== libevecache ======

libevecache is a portable C++ library for digesting EVE-Online cache files. It also includes the "dumper" utility which can print or transform cache files into various other formats as supported by libevecache.
===== Support =====

Support is available by asking kindly. We expect you to have some basic understanding of software. Bug fixes are always welcome.

[[http://www.eveonline.com/ingameboard.asp?a=topic&threadID=1139114|EVE Online thread (not for quick responses)]]

IRC: #eve-dev on irc.coldfront.net or #evecentral on irc.freenode.org

E-mail: atrus@stackworks.net

Bugzilla: http://bugs.stackfoundry.org


===== Running dumper =====

Included in libevecache is a utility named "dumper", which can, amongst other things, transform cache files into EVE-compatible .CSV market export files. To use dumper:

  - Download the source or pre-packaged binary.
  - Open a command prompt.
  - Run dumper  
       
  dumper %%--%%market "c:\documents and settings\....\CachedMethodCalls\*.cache" > alllogs.csv

''NOTE:'' Windows does not do filename globbing as part of the shell. dumper.exe does not attempt to re-implement operating system functionality. To allow globbing to work, you will need to use a real shell.

Which will produce a single file for all market logs, delineated by the header in the file. 

You can also run dumper with the ''%%--%%structure'' option to get an AST dump of the cache file. 

===== Source and Binary Downloads =====

A copy of dumper.exe and the corresponding evecache.dll is made available for stand-alone usage. If you intend to integrate libevecache into your project, you will need to compile from source (the entry point library is not provided).

The download location is: [[http://dl.stackfoundry.org/libevecache/]] Files are signed by the GPG key B790A0EC (Yann Ramin). 

Source code can be fetched via [[http://gitorious.org/libevecache/|Gitorious]], which doesn't even require the use of Git. Simply hit the [[http://gitorious.org/libevecache/libevecache/archive-tarball/master|download link ]] on any branch. 

===== Compiling =====

Code is available at [[http://gitorious.org/libevecache]]

==== Compiling on Linux ====

Pre-requisites: 
  - g++ (4.0 series preferable) (Debian/Ubuntu: ''apt-get install build-essential'')
  - Working binutils
  - Python
  - Python-Dev (''apt-get install python-dev'')
  - Swig (''apt-get install swig'')
  - scons (''apt-get install scons'')
  - git (''apt-get install git-core'')

To compile:

  scons

To run:

libevecache.so is built as a shared library. You may need to adjust your LD_LIBRARY_PATH if you want to run it locally. An example

  export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/user/libevecache/lib
  util/dumper file.cache






==== Compiling on Windows ====


Compiling pre-requisites (Windows): 
  - Visual C++ 2008 Express (Pro works too)
  - scons (latest development snapshot) http://www.scons.org/
  - Python 2.5, 2.6 (for scons) http://python.org/
  - Git (if you want to keep up to date without downloading a new tarball all the time)

Open the Visual Studio 2008 Command Prompt (aka vcvars.bat), which is located at Start->All Programs->Microsoft Visual Studio 2008->Visual Studio Tools->Visual Studio 2008 Command Prompt

Navigate to the directory which contains libevecache.

Run scons:
  c:\python26\scripts\scons

You should now have evecache.dll and util\dumper.exe available.