https://github.com/sleeplessone1917/lemmy-translator-bot

A bot for lemmy that translates posts and comments on request.
https://github.com/sleeplessone1917/lemmy-translator-bot

bot deepl fediverse fediverse-bot lemmy lemmy-bot translation

Last synced: 15 days ago
JSON representation

A bot for lemmy that translates posts and comments on request.

• Host: GitHub
• URL: https://github.com/sleeplessone1917/lemmy-translator-bot
• Owner: SleeplessOne1917
• License: agpl-3.0
• Created: 2023-04-15T23:48:33.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-02T03:49:48.000Z (5 months ago)
• Last Synced: 2024-10-31T03:12:16.839Z (2 months ago)
• Topics: bot, deepl, fediverse, fediverse-bot, lemmy, lemmy-bot, translation
• Language: TypeScript
• Homepage:
• Size: 107 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lemmy-translator-bot

This is a bot for [lemmy](https://github.com/LemmyNet/lemmy), the fediverse link aggregator. It translates posts and comments when mentioned.

# Setup

Clone the repository and install the dependencies with your choice of javascript package manager.

Create a file named `.env` in the same directory as `package.json`. There are 4 environent variables that need to be assigned in this file:

- `INSTANCE`: the instance the bot's account is on

- `USERNAME_OR_EMAIL`: username or email of the bot

- `PASSWORD`: password for the bot account

- `DEEPL_API_KEY`: API key required to use DeepL API. [This will require making an account with DeepL](https://www.deepl.com/pro-api?cta=header-pro-api/)

When the bot is setup, it can be started by running `npm start`.

# Usage

To use the bot, mention it and include the name of the language you are translating into. The name of the language must be in the language being translated into, e.g. English is "English", German is "Deutsch", Russian is "Русский", etc.