https://github.com/Ategon/Lemmy-Frank-Bot

A lemmy bot that auto posts threads in communities at given times
https://github.com/Ategon/Lemmy-Frank-Bot

bot bots fediverse fediverse-bot javascript lemmy lemmy-bot

Last synced: 26 days ago
JSON representation

A lemmy bot that auto posts threads in communities at given times

• Host: GitHub
• URL: https://github.com/Ategon/Lemmy-Frank-Bot
• Owner: Ategon
• License: agpl-3.0
• Created: 2023-06-21T00:32:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-31T17:36:12.000Z (over 1 year ago)
• Last Synced: 2024-08-03T17:09:18.438Z (4 months ago)
• Topics: bot, bots, fediverse, fediverse-bot, javascript, lemmy, lemmy-bot
• Language: JavaScript
• Homepage:
• Size: 68.4 KB
• Stars: 6
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-lemmy - Lemmy-Frank-Bot - Frank-Bot)  (Projects / Tools)

README

        
# Frank Bot

A lemmy bot that auto posts threads in communities at given times

This bot is made for the https://programming.dev/ gamedev communities but the source code can be modified to accomodate any community

## Notes

- If running on windows the environment variables may act up. You can insert them manually into the bot by replacing the things like process.env.USERNAME and the other things starting with process.env with the value for username in .env or their other respective value

- NOTE: Not updated for v0.18 yet

## Setup

1. Clone the repository

2. Create an account in the instance you want the bot to have as its home (just make a regular user)

3. Create a file called .env in the bot folder and give it values in this format with the data in the quotes (dont add the slashes or the part after the slashes)

```

INSTANCE="" // The instance the bot account is in

USERNAME="" // The bot username

PASSWORD="" // The bot password

```

4. Change the data for the communities and posts variables based on what you want set. Cron determines what time the bot will post at (does an interval) and theres a calculator to help you here https://crontab.guru/ (note theres an extra digit on the left for the bot thats for seconds that isnt in the calculator). For lemmy bot docs look at https://github.com/SleeplessOne1917/lemmy-bot

5. Open a terminal in the bot folder and run `npm install` to install dependendies and then `node main.js` to run the bot (whenever you want to start the bot again you can just do ctrl+c to interrupt the process and node main.js to start the bot)

I recommend installing something like [forever.js](https://www.npmjs.com/package/forever) for making it run continually

If you run into issues feel free to dm me on Matrix [here](https://matrix.to/#/@ategon:matrix.org)