README.mde

# Meatspace Chat
[![Build Status](https://travis-ci.org/meatspaces/meatspace-chat.png)](https://travis-ci.org/meatspaces/meatspace-chat)

## Before you send a pull request

Note that we are not taking any new features or changes - if you feel like something is that important to the chat, please contact [jen@meatspac.es](mailto:jen@meatspac.es) or [ednapiranha](http://twitter.com/ednapiranha) before sending something that might be rejected.

If you want to create a browser add-on or plugin feel free to do so and follow the API instructions below. Then send us a pull request with your link at [https://github.com/meatspaces/meatspace-chat-hackers](https://github.com/meatspaces/meatspace-chat-hackers).

## Setting up
    brew install zeromq redis
    redis-server &
    cp local.json-dist local.json
    cp clients.json-dist clients.json
    cp whitelist.json-dist whitelist.json
    npm install
    npm -g install nodemon
    bower install
    npm run-script build
    npm start

## Create a Twitter Application for Meatspace

Sign in with your Twitter account to https://dev.twitter.com and create a new application.

Fill in the details for your local setup like so:

![Twitter settings](http://cl.ly/U9t7/Create_an_application___Twitter_Application_Management.png)

Save your settings then go back and edit the settings again. Check off the 'Allow this application to be used to Sign in with Twitter' and save.

Open your browser at http://127.0.0.1:3000

# Messages

You can listen to the socket to receive incoming messages or use long polling at either https://chat.meatspac.es or http://chat-staging.meatspac.es.

A meatspace chat message is a nested dictionary in the form

    {
        chat:
        {
            value:
            {
                media: data:image/gif;base64,<base64 data>,
                message: '<message; may be empty>,
                ttl: 600000,
                created: <time-string>,
                fingerprint: <32-byte hex>
            },

            key: <unique message key>
        }
    }

## Mute feature

If you mute a user then you won't see any new posts from them at that machine and IP. There is an unmute button in the menu in the top right corner.

## Native apps (iOS/Android) or Non-web clients

If you need an apiKey to post from your app, contact me at jen@meatspac.es and I will try to hook you up! You will get access to [staging server](http://chat-staging.meatspac.es) to see if everything works and see if it is appropriate for the production server (which I will give you a new apiKey).

If you plan on using node and the [socket.io-client](https://www.npmjs.org/package/socket.io-client) for a bot or other purposes, ensure you have socket.io-client ~0.9, as ~1.0 isn't compatble with the socket.io ~0.9.
### API

If you are doing native or non-web calls to the API, you will first need a valid apiKey and then you can make the following calls:

Push a new message through a socket request and provide the following data:

    {
        apiKey: <apiKey>,
        message: <text message; can be empty>,
        picture: data:image/gif;base64,<a base64 blob of the gif data>,
        fingerprint: <a unique identifier for the user posting from the client, preferably md5-hashed>
    }