ThorsHammer

ThorsHammer copied to clipboard

🔨 ThorsHammer

A Simple Moderation Bot For Telegram

"The Hammer That Was Promised"

Background

This is a simple group moderation bot that complements existing group moderation bots. It is written in JavaScript and uses mongoDB as the database. Most of the strings are hardcoded in English, but the help information is available in several languages!

Commands

You can use either /, !, or # as command prefixes

Inline Mode

You can get help information in any chat by using the inline mode:

# Type In The Message Field
@thorshammerbot help [language-code]

Filters

Setup

Node.JS

You need Node.js version > 4, inorder to download dependencies and run this bot. For Windows users, simple click here to install it. For Unix users, use the preffered method here.

Telegram

• Create a bot, read on how to do that here
• Disable bot privacy, send /setprivacy to @BotFather. Read more about privacy here
• Enable inline mode, send /setinline to @BotFather. Read more about inline here
• Create a log channel, and get its id by simply forwarding a message from the channel to @getidsbot. The id always starts with '-100'.
• Using the same bot above, get your own id.
• Open core/config.js and input the token and id's in their respective fields.

MongoDB

You need MongoDB to run this bot, You can get a free deployment from mongolab. Follow the instructions below (skip if deploying to Openshift):

• Open the mongolab website
• Click the yellow Sign up button
• Fill in your user information then hit Create account
• From the dashboard, click on ⚡️Create new button
• Select any cloud provider (I usually go with AWS, region EU)
• Under Plan click on Single-node (development) tab and select Sandbox (it's free)
• Leave MongoDB version as is - 2.4.x
• Enter Database name, can be anything you like
• Then click on ⚡️Create new MongoDB deployment button
• Now, to access your database you need to create a DB user
• Click to the recently created database
• You should see the following message: A database user is required to connect to this database. Click here to create a new one.
• Click the link and fill in DB Username and DB Password fields
• Add the mongodb link to core/config.js, it looks something like: mongodb://USERNAME:[email protected]:27479/DATABASE_NAME

You can have the following deployment strategies:

ZEIT (Free & Easy)

# Ensure You Have Node.JS Installed! 
$ node -v

# Zeit Webhook
# Clone The Repo
$ git clone https://github.com/kamikazechaser/ThorsHammer.git -b zeit/webhook
# Expermimental Websocket Updates: git clone https://github.com/kamikazechaser/ThorsHammer.git -b zeit/socket
$ cd ThorsHammer

# Install Zeit
$ npm install -g now

# Ensure all fields in core/config.js are present! 
$ now

Running On Your Own Server (Recommended)

Polling Strategy

# Ensure You Have Node.JS Installed!
$ node -v

# Polling Strategy: Low Traffic, Low Load
# Clone The Repo
$ git clone https://github.com/kamikazechaser/ThorsHammer.git
$ cd ThorsHammer

# Install Dependencies
$ npm install
$ npm install -g forever

# # Ensure all fields in core/config.js are present! 
$ forever start bot.js

Webhook Strategy (Via Ngrok Tunnel)

# Ensure You Have Node.JS Installed!
$ node -v

# Webhook Strategy: Moderate Traffic, Moderate Load
# Clone The Repo
$ git clone https://github.com/kamikazechaser/ThorsHammer.git -b ngrok
$ cd ThorsHammer

# Install Dependencies
$ npm install
$ npm install -g forever

# # Ensure all fields in core/config.js are present! 
$ forever start bot.js

Openshift

# Ensure You Have Node.JS Installed! 
$ node -v

# Clone The Repo
$ git clone https://github.com/kamikazechaser/ThorsHammer.git -b openshift
$ cd ThorsHammer
# Ensure all fields in core/config.js are present! Except the MONGODB_URL, leave it as is!

# Log into your Openshift web console
# Create a new app
# Select Node.js [Latest]
# Launch the app
# Add a cartridge > Install your own cartridge
# Enter this => https://raw.githubusercontent.com/icflorescu/openshift-cartridge-mongodb/master/metadata/manifest.yml
# Add your ssh keys to Openshift and ensure they are available in $HOME/.ssh locally
# Copy your git address from the side, on the web console

$ git remote add openshift [REMOTE GIT ADDRESS, COPIED FROM ABOVE]
$ git push openshift master --force

Other Strategies

You can modify core/telegram.js to implement your own strategy, such as clustering or websockets.

Issues And Contribution

Star and Fork the repository and submit a pull request for whatever change you want to be added to this project. If you have any questions, just open an issue.

Translations

Translations are welcome. Languages given priority are:

• 🇪🇸 Español - Translated by @keijodputt
• 🇧🇷 Português
• 🇮🇷 Farsi
• 🇸🇦 Arabic - Translated by @rix4r - full arabic fork
• 🇮🇹 Italiano
• 🇮🇩 Bahasa Indonesia - Transalted by @rizaumami - full bahasa indonesia fork

Edit the respective fields in core/locale.json and submit a pull request. be careful of Markdown elements and \n, they are important!

License

Released under AGPL-v3.0, see the LICENSE file.