https://github.com/ejamesc/jarvisbot

A Telegram bot, for friends.
https://github.com/ejamesc/jarvisbot

Last synced: 12 days ago
JSON representation

A Telegram bot, for friends.

• Host: GitHub
• URL: https://github.com/ejamesc/jarvisbot
• Owner: ejamesc
• Created: 2015-08-31T15:17:13.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-11-01T16:58:25.000Z (about 6 years ago)
• Last Synced: 2024-07-31T12:07:23.805Z (3 months ago)
• Language: Go
• Homepage:
• Size: 27.7 MB
• Stars: 34
• Watchers: 5
• Forks: 15
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-telegram-bots - jarvisbot - Telegram bot for friends by ejamesc (Examples / Go)

README

        


  


    
Jarvis

    
A Telegram bot for friends

  

  

    

  



------

Current featureset includes: 

* Grabs images

* Grabs GIFs

* Does Google searches

* Does Youtube searches

* Does Urban Dictionary searches

* Does location searches

* Does exchange rate conversions

* Notifies everyone in a chatroom using their usernames

* Displays the current air pollution index for all areas in Singapore

* Clears your NSFW stuff

## Build dependencies

Jarvis relies on go-bindata to package assets in the data/ folder into the

binary. If you'd like to add to the assets when implementing your own response functions, 

install the go-bindata tool using:

```go get -u github.com/jteeuwen/go-bindata/... ```

If you're running a Go version < 1.4, you'll need to manually run the following

command in the top level dir. 

```go-bindata -pkg jarvisbot -o assets.go data/```

(Otherwise, you can run `go generate` to achieve the same results).

## Instructions 

Compile Jarvis for your target platform and upload the binary to your server. 

In the same directory as the binary, create a config.json file. (A

config-sample.json has been provided for you to modify.) Remember to include the API keys

in your config.json:

* `name`: Your bot's @username - this is currently unused, but may be used in the

  future for @replies to your bot.

* `telegram_api_key`: Your bot's Telegram bot api key, from Botfather.

* `open_exchange_api_key`: An API key from https://openexchangerates.org/

* `youtube_api_key`: A Google API key with Youtube enabled.

* `maps_api_key`: A Google API key with Maps enabled.

**New**: you may now choose to use one `custom_search_api_key`, or use key cycling

to get around Google custom search's 100 searches per day limit.

To use key cycling, add any number of additional Google API key and Google

custom search engine id pairs to config.json, with the following key schema:

* `"custom_search_credentials": [{"api_key": "x", "search_id": "y"}]`

... and so on, where `api_key` is a Google API key with custom search enabled,

and `search_id` is a Google custom search engine id. You'll need to use multiple Google accounts to create these key pairs, using these [instructions](http://stackoverflow.com/a/11206266). If this sounds like a hack, that's because it *totally is*. Or, stick to the old way and use just one key pair:

* `custom_search_api_key`: A Google API key with custom search enabled.

* `custom_search_id`: A Google Custom Search id, which has to be created at https://cse.google.com/cse/ according to these instructions: http://stackoverflow.com/a/11206266

Last, but not least, make sure the user running the program has write permissions to its directory, 

as Jarvis creates a jarvis.db file.

## Screenshots