Package: dsfp
Darksouls Save File Parser==========================.. image:: https://travis-ci.org/tarvitz/dsfp.svg?branch=master:target: https://travis-ci.org/tarvitz/dsfp* DSFP means Darksouls Save File Parser.* `Dark Souls <http://darksouls.wikia.com/wiki/Dark_Souls>`_ is game ofNamco Bandai with pretty hard to get it finished without being killed.Lot's of death, fun and broken gamepads/keyboards.**DSFP** *serves* for getting/fetching your saved characters statistics purposes... contents:: :local::depth: 2Original source~~~~~~~~~~~~~~~Original source and some key knowledge were taken from this`gist <https://gist.github.com/infausto/8382836/>`_.Common features~~~~~~~~~~~~~~~Supports fetching data about character's death, his/her general stats, hp and stamina.Whole bunch of reversed stats you can see in datasheet document which is placed`here <docs/datasheet.rst>`_(*Help for reverse engineering DarkSouls save file is appreciated*).Installation~~~~~~~~~~~~For general installation you would probably need virtual environment with pipinstalled:Python 2.7``````````.. code-block:: bashuser@localhost$ virtualenv --no-site-packages venvuser@localhost$ source venv/bin/activateuser@localhost$ pip install -r requirements/base.txt*optional*.. code-block:: bashuser@localhost$ pip install -r requirements/docs.txtPython 3.x``````````document build requirements stored in py3.txt.. code-block:: bashuser@localhost$ virtualenv --no-site-packages venv3user@localhost$ source venv3/bin/activateuser@localhost$ pip install -r requirements/py3.txtDependencies------------* python 2.7* python 3.3* python 3.4Tests~~~~~Simply run ``python setup.py test`` orYou could run tests via `python -m unittest module` or via `run_tests.sh` script.. code-block:: bashuser@localhost$ ./run_tests.sh tests.TestDSFPReaderFast Usage~~~~~~~~~~You can parse Dark Souls save files and get data in standard pythondictionary format.. code-block:: python>>> import dsfp>>> ds = dsfp.DSSaveFileParser('saves/DRAKS0005.sl2')>>> data = ds.get_stats()>>> data[{'attunement': 8, 'body': 0, 'class': 0, 'color': 0, 'deaths': 0,'dexterity': 13, 'earned': 60, 'endurance': 12, 'face': 0, 'faith': 9,'gift': 0, 'hairs': 0, 'hp': 594, 'hp2': 594, 'hp_current': 594,'humanity': 0, 'intelligence': 9, 'level': 4,'male': False,  # False means female'name': u'TEST_2', 'resistance': 11, 'souls': 60, 'stamina': 95,'stamina2': 95, 'stamina3': 95, 'strength': 13,'time': 62, # in seconds'vitality': 11}]Datasheets~~~~~~~~~~There's no many information about Dark Souls save file format (as well as theother games), so there's not much complete around its format.Some knowledge represented `here <docs/datasheet.rst>`_.Please notify me here or by email (tarvitz [at] blacklibrary.ru)if you have something interesting around whole file format.Documentation~~~~~~~~~~~~~Whole bunch of the docs you can read by clicking this link`dsfp.readthedocs.org <http://dsfp.readthedocs.org>`_Development~~~~~~~~~~~.. note::Huge buch of data now represented in datasheets are still not covered indsfp "api" just cause whole file-format and its datasheet is the main priority.You can use it for build your own parser or just read some non-random datafrom *.sl2 files.Though dsfp is not complete as it should, please search/read information inthe docs mentioned above.Roadmap~~~~~~~I have no certain roadmap for this project and I inspect the data whenever I wantto do it. In general these moments could be very short/long from time to time. So don'texpect me finishing this work to some certain moment or something clear enough.Use ``./scripts/watcher.py`` and the other scripts (or may be another methods) to inspectdata you need, contact me if you want to share them and have fun ;).