pyifbabel
Not logged in

About

pyifbabel is a pure-Python implementation of the Treaty of Babel, a standard for identifying and handling the metadata of interactive fiction files. This module was originally written for Grotesque but it has been packaged separately to be easily used by other developers.

pyifbabel provides tools for extracting metadata from interactive fiction files, for working with IFiction XML files, and for building an object-oriented representation of an interactive fiction story file in Python. For more information, see the Tutorial.

This module is currently in beta. The necessary functionality to handle all of the story formats and wrappers covered by the Treaty of Babel exists and is well-tested. Some IFiction XML file handling functions, particularly the verification and lint routines covered by the official babel commandline tool, have not been written yet. Finally, the module does not yet handle creating blorbed files.

Please note that the module API might change slightly as it is developed.

Contributing

Patches are welcome! Development takes place using Fossil. You can clone it using:

$ mkdir pyifbabel
$ fossil clone http://pyifbabel.invergo.net/fossil pyifbabel.fossil
$ cd pyifbabel && fossil open ../pyifbabel.fossil

See the Fossil documentation for more information.

Author

Brandon Invergo

License

pyifbabel 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 3 of the License, or (at your option) any later version.

pyifbabel 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.

For more information, see http://www.gnu.org/licenses/