Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
##crawl bot Sequell; depends on https://github.com/crawl/go-sequell
Ruby Perl Perl6 Python HTML CSS Other
branch: master
Failed to load latest commit information.
bin Allow use of parallel fetch tool.
commands Fix help for !learn move.
config Make cue the official name for clan.
docs Add ntv to common fields list.
lib Look for help requests; can be hooked up with behaviors.
rc Add HTTP LearnDB interface (gammafunk).
scripts Add /crawl-build/ endpoint to tell Sequell to update Crawl.
server-xlogs Generate the henzell schema from crawl-data.yml metadata.
services/http Reduce rebuild debounce to 10s.
spec Update to recent rspec, fix specs.
src Use -playable-json for !apt.
t Fix !learn move
tests Add regexp_replace to SQL functions.
tpl Add hAxis baseline of 0 for numeric hAxis.
utils Add utility scripts to save ntv across db rebuilds.
web Allow userdef tables to wrap.
www Reorganize CSS, make LearnDB html less crowded.
.ackrc Expand !kw parse to include any fragment, not just keywords.
.gitignore Ignore server-xlogs subdirs.
CREDITS Add some missing names to credits.
Gemfile Superior LearnDB correction.
Gemfile.lock Update to recent rspec, fix specs.
Makefile Update seqdb path.
PerlModules Add dependency on YAML::XS
README.md Link to current orafce home.
TODO Fix errors in listgame doc.
sequell.pl Log all Sequell commands.

README.md

Sequell

Sequell is the stats IRC bot for ##crawl on Freenode IRC.

Sequell is the successor to the original ##crawl Henzell which at one point shared the same code. There are still many references to Henzell in the source and configuration.

Dependencies

  • Go 1.3 or better from http://golang.org/ or installed via your package manager.

    Your GOPATH environment variable must be correctly set, and $GOPATH/bin must be in your PATH for the seqdb tool.

  • PostgreSQL 9

    1. Install PostgreSQL, create a database 'sequell' and a user 'sequell', and give the user access to the database with password 'sequell'.

    2. In the 'sequell' database, install the PostgreSQL citext and orafce extensions by running (as an admin user): CREATE EXTENSION citext; CREATE EXTENSION orafce;

      citext is available as part of Postgres contrib; orafce is available at: https://github.com/orafce/orafce

      Sequell needs the CITEXT extension for case-insensitive comparison and grouping and the orafce extension for the median aggregate function. You may choose to skip the orafce extension if you do not need the median() aggregate function.

      You can use the seqdb tool to create the database and extensions if you run it as a Postgres admin user:

      Build seqdb from the Sequell root directory:

      $ make
      

      Then create the database:

      $ seqdb createdb --admin postgres --adminpassword xyzzy
      

      Depending on what authentication mode you're using for Postgres, you may need to run seqdb as the postgres Unix user (if using ident auth), and/or override the host and port you're connecting on.

      If you're connecting to Postgres using Unix sockets, specify the Unix socket directory as the --host option:

      $ seqdb --host /var/run/postgresql createdb
      

      Note that you still have to install the orafce and citext extensions for Postgres system-wide before you can create a database that uses these extensions. seqdb createdb merely automates the process of creating the database and sequell database user and creating the extensions in the database; it cannot install the extensions system-wide.

    3. Set up the database:

      Build Sequell's DB ops tool using make (this requires Go 1.3):

      $ make
      

      Create the database tables in the schema:

      $ seqdb create-tables
      

      Populate the database: first fetch the server logs, then load them:

      $ seqdb fetch && seqdb load
      

      Create indexes and constraints on the database after loading logs:

      $ seqdb create-indexes
      

      You can change the database seqdb connects to, and how it connects. Run seqdb for an overview.

  • RE2

    1. Install RE2 using the package manager on your system (libre2-dev on the Debian family).
  • Ruby

    Sequell requires ruby 1.9 or better. You may need to install rubygems and the ruby headers (ruby-dev), depending on your system.

  • Perl

    Perl >= 5.14

Sequell wants Perl modules for IRC, YAML parsing, DB connectivity, etc. In addition the SQL query commands require several Ruby gems. To install Sequell's dependencies, use:

# ./scripts/install-libs

You can also install the Perl and Ruby dependencies independently:

# ./scripts/install-perl-modules
# gem install bundler && bundle install

Configuring Sequell

Sequell has three primary functions:

  1. Providing a repository for user-maintained content (the LearnDB).
  2. Storing records of all games on public serves and making them available to query.
  3. Serving a playlist of games enqueued for FooTV. This is one half of the configuration for FooTV. The FooTV service must separately be configured to connect to Sequell's playlist server.

Sequell also provides additional utility commands.

You configure Sequell by supplying an rc/sequell.rc in the directory from which you run Sequell. You can alternatively specify the rc filename as a command-line option with:

perl sequell.pl --rc=some/path/to/myweirdrc
Something went wrong with that request. Please try again.