File	Date	Author	Commit
src	2012-02-21	Brandon Invergo	[5f188e] remove unnecessary importing of os.path on top ...
COPYING	2011-08-11	Brandon Invergo	[cdefc6] Updated COPYING for better formatting
COPYING.README	2011-08-13	Brandon Invergo	[200163] Added COPYING.README
MANIFEST	2011-08-13	Brandon Invergo	[f4d738] Updated MANIFEST
PKG-INFO	2011-06-25	Brandon Invergo	[68a6ff] Added the files from grotesque-0.2.1 for real now.
README	2011-08-27	Brandon Invergo	[817e9e] Updated README
grotesque	2012-01-29	Brandon Invergo	[41e95b] updated main grotesque script to choose the gui...
setup.py	2011-08-28	Brandon Invergo	[5d0710] Fixed setup.py

Read Me

 ####################################
#                                    #
#             Grotesque              #
#                                    #
#       Version 0.9.3 (8/2011)       #
#                                    #
#  http://grotesque.sourceforge.net  #
#                                    #
 ####################################


0.9.3 Release Notes
-------------------
* Fixed IFID extraction/computation in TADS and ZCODE games
* Fixed IFID extraction/computation and metadata extraction from blorbed files
* Added IFID computation for AGT, Alan, DOS executable, Hugo, Level 9 and
  Magnetic Scrolls story formats
* Added coverart extraction for TADS and blorbed story formats
* Added support for local coverart (cover art stored in the same folder as
  the story file, which must have the word "cover" somewhere in its name and
  be a JPEG or PNG image)
* Added a field for story TUID and the ability to search the IFDB by TUID
  in the edit dialog
* Removed Python 2.7 dependencies (2.6 is now the required version)
* Fixed bug in improper clearing of filter values when removing stories from
  the library
* Fixed wonky progress dialog behavior when handling large file names
* Fixed a bug in which editing a story's genre or authors resulted in spurious
  filter values
* Fixed a bug in which edits made via searching IFDB didn't appear in the 
  library list.
* Fixed a bug in zeroes being ommited from custom format file extensions.
* Fixed the install location of the README and COPYING documents on Linux
* Changed the default location of the configuration files in Linux to be in
  $XDG_CONFIG_HOME/grotesque, which defaults to /home/<user>/.config/grotesque
  if the environment variable is not set, and the data files to
  $XDG_DATA_HOME/grotesque, or /home/<user>/.local/share/grotesque
  
!!NOTE!! 
Linux users, pay attention to that last one. You must manually move
~/.grotesque/grotesque.cfg to $XDG_CONFIG_HOME/grotesque and you must move
local_library.dat and the covers folder to $XDG_DATA_HOME.
I could have done this automatically but I do not like the idea of moving
files around in your home directory without you knowing.



 *******
* About *
 *******
Grotesque is a program for organizing and exploring your interactive fiction
library. 

Grotesque is copyright 2009, 2010 Per Liedman and 2011 Brandon Invergo.
See the file COPYING for licensing information.


 **************
* Requirements *
 **************
Python 2 (>= 2.6)  (Python 3 is currently not supported)
GTK: For GTK2, pygtk is required (any reasonably current version should be fine)
     For GTK3, pygobject is required (the newer, the better)

Currently, two separate versions exist, one for GTK2 and one for GTK3. It is not
sane to try to maintain a single Python application that supports both. If you 
are not sure which version of GTK you are using, choose the GTK2 version of the
program. However, be advised that the GTK2 version will not be supported past
Grotesque version 1.0. However, with most major Linux distributions moving to
GTK3 this year, this probably won't be a problem.

The Windows version includes all the necessary files to run it. For that reason,
it's 8mb and contains a lot of files. I'll work on paring this down if possible.
To run it, just run grotesque.exe.


 **************
* Installation *
 **************
In a terminal, simply type:
$ python setup.py install

Note that you may need root priveledges to install. If you wish to install it 
yourself manually, you may instead type:
$ python setup.py build
Then copy the contents of the src directory to somewhere in your PYTHON_PATH. 
The file grotesque may be used to launch the application.

For installing it in your desktop environment (ie Gnome), there is an 
application icon in the directory src/grotesque/data.


 **********************
* How to use Grotesque *
 **********************
Grotesque is an interactive fiction library manager. This, of course, means that 
you need some interactive fiction to get started. Hop over to 
http://ifdb.tads.org to find some good ones. You'll also need some interpreters 
to read the interactive fiction files, as Grotesque does not handle that 
directly. For Linux, Gargoyle (http://ccxvii.net/gargoyle/) can handle most 
formats.

Use of Grotesque is pretty straight-forward. If this is your first time running 
it, it will walk you through setting up your preferred interpreters. Once you're
in the program you can import stories into your library by clicking on the 
folder icon (recursively import a directory) or on the '+' icon (import file(s) 
from a directory).

Grotesque will attempt to extract metadata from the story files, however in the
event that it fails, it will retrieve the information from IFDB. Likewise, the 
program can also retrieve cover art from IFDB. This feature can be turned off in
the preferences.

If you have used a previous version of Grotesque, your library may need 
updating, which the program will do the first time you run the new version. 
Since this version stores more metadata for each story than previous versions, 
it will also optionally fetch more data from IFDB. This process may take some 
time with larger libraries so please be patient!

You can filter your library by such things as author or publishing date using 
the filter list on the left. In the main library list, you can sort according 
to any of the columns. If you start typing, you can search for a particular 
title (you may need to click somewhere on the list first). If you right click 
on the column headers (in GTK3) or on the list itself (in GTK2), you'll find a 
pop-up menu which allows you to show/hide columns. Double-clicking a story, 
hitting enter while it's selected, or hitting the play button while it's 
selected will launch a story. It will change from being in bold text to having 
a normal weight to indicate that you've tried this story (handy for big 
libraries or for junkies who download stories faster than they can complete 
them). Right-clicking on the list itself (both GTK2 and GTK3) will allow you to 
toggle the played state of a game directly.


 *************************
* Bugs & Feature Requests *
 *************************
Grotesque is currently beta software. While it can probably be considered close 
to "feature-complete", it's may still be a few bugs short of a 1.0. If you 
happen to encounter one or if you have a great idea of how to improve the 
application, please visit http://sourceforge.net/projects/grotesque/ and either 
leave a bug report or drop a note in the forum, and we'll see what we can do. 
For bug reports, please include as much of the fololwing information as you can:

-> Operating system & version
-> Python version
-> Grotesque version (gtk2 or gtk3)
-> GTK version installed on your system
-> pygtk or pygobject version


 *************
* Development *
 *************
If you would like to help out with development, you're more than welcome! Please
contact me in that case.


 *********
* Contact *
 *********
Brandon Invergo <b.invergo@gmail.com>