https://github.com/kaakaa/bopher

Bot + Gopher = Bopher :exclamation:
https://github.com/kaakaa/bopher

Last synced: 23 days ago
JSON representation

Bot + Gopher = Bopher :exclamation:

• Host: GitHub
• URL: https://github.com/kaakaa/bopher
• Owner: kaakaa
• License: mit
• Created: 2016-08-26T13:21:32.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-08-29T12:18:16.000Z (over 8 years ago)
• Last Synced: 2024-06-20T10:16:50.813Z (7 months ago)
• Language: Go
• Size: 1.72 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Bopher

`Bot` + `Gopher` = `Bopher`

Bopher is client application connecting Mattermost(3.3.0~) as Bot.

You can call Gopher from chat!

## Requirements

* Mattermost 3.3.0~

* [mattn/gopher](https://github.com/mattn/gopher) binary file (named `gopher.exe`)

## Setup

#### 1. Download bopher.exe

* [Releases · kaakaa/bopher](https://github.com/kaakaa/bopher/releases)

#### 2. Build gopher binary

* [mattn/gopher](https://github.com/mattn/gopher)

#### 3. Write config.json

* place [bopher/config\.json](https://github.com/kaakaa/bopher/blob/master/config.json) in the same direcoty with bopher.exe

```

{

  // Your Mattermost settings

  "mattermost": {

    "host": "localhost",

    "port": "8065",

    "bot": {

      "email": "[email protected]",

      "password": "admin",

      "name": "Bot",

      "first_name": "Go",

      "last_name": "Bot"

    },

    "team": "tttt",

    "channel": {

      "name":"botting",

      "display_name": "BotRoom",

      "purpose": "bot_test"

    }

  },

  // path to gopher.exe (Even if you use windows, this value is like `$GOPATH` not `%GOPATH%`)

  // details -> https://github.com/golang/go/issues/8469

  "gopher": "$GOPATH/bin/gopher.exe",

  // The maximum number of gophers on display

  // If you set a large number, gopher will eat all of your machine resource)

  "max_of_gophers": 10                 

}

```

#### 4. Run bopher

```

bopher.exe

```

#### 5. Call gopher on mattermost

![](https://raw.githubusercontent.com/kaakaa/bopher/master/bopher.gif)

## Commands

Message         | Action

----------------|----------------

`gopher`        | Call a gopher

`bye gopher`    | kill all gophers :scream:

`jump gopher`   | jump all existing gophers

`hello gopher`  | a gopher say hello 

`whats gopher?` | r u sure?

## Build

#### 1. Clone this repository

```

go get github.com/kaakaa/bopher

cd $GOPATH/src/github.com/kaakaa/bopher

```

#### 2. Make build

```

make build

```

## License

This code is provided under the MIT license.