README

The VNDB.org Source Code
------------------------


Installation & documentation

  Documentation is lacking, you're pretty much on your own if you want to
  get things running. :-(

  Development notes for specific features or ideas can be found in data/notes/.
  Keep in mind, however, that these notes are often mostly technical and may
  not reflect the actual (current) implementation. They do elaborate on various
  design decisions and may be useful for understanding how certain things work.


Requirements

  global requirements:
    Linux, or an OS that resembles Linux. Chances are VNDB won't run on Windows.
    PostgreSQL 9.3+ (don't try older versions or other SQL databases, it won't work)
    perl 5.20 recommended, 5.10+ may also work
    A webserver that works with TUWF (lighttpd and Apache are known to work)

  (perl 5.20 core modules are not listed.)

  General:
    Crypt::ScryptKDF
    Crypt::URandom
    DBD::Pg
    DBI
    Image::Magick
    JSON::XS
    Tie::IxHash

  util/vndb.pl:
    Algorithm::Diff::XS
    TUWF
    FCGI                 (optional, for running as a FastCGI script)
    PerlIO::gzip         (optional, for output compression)

  util/multi.pl:
    APIDump:
      PerlIO::gzip
    Core:
      AnyEvent
      AnyEvent::Pg
    IRC:
      AnyEvent::IRC
    Maintenance:
      PerlIO::gzip
    RG:
      XML::Parser
      graphviz           (/usr/bin/dot is used by default)

  util/skingen.pl
    CSS::Minifier::XS    (optional, minimizes CSS output)

  util/jsgen.pl
    JavaScript::Minifier::XS (optional, minimizes JS output)
    uglifyjs                 (optional, slower but better JS compression)

  util/spritegen.pl
    pngcrush             (optional)


Contact

  IRC:   #vndb @ irc.synirc.net
  Email: contact@vndb.org


License

  GNU AGPL, see COPYING file for details.