Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.27 KB

README.md

File metadata and controls

56 lines (41 loc) · 2.27 KB

OrbitMines Bot

Automated logistics: Platform interoperability.


  • Initial setup by hand
  • Incorporate in the Library later

What platforms are supported?

Discord (discord.py, rate limits), Twitch, X (Twitter), YouTube, Cloudflare, GitHub, GitLab, LinkedIn, Meta: Instagram/Facebook, Substack, NPM

For more information on this (and other) interoperability, see OrbitMines' Library.


Local setup

git clone [email protected]:orbitmines/bot.git \
&& cd ./bot

Install dependencies

python3 -m pip install -U discord.py

(first setup) Generating an oauth url to add the bot to a server

DISCORD_CLIENT_ID="..." \
DISCORD_TOKEN="..." \
python3 ./bot/oauth2_url.py

Run bot:

# DISCORD_SKIP_HOOK=1 Skips manually syncing the Discord Interaction (i.e. AppCommands)`
DISCORD_SKIP_HOOK=0 \
DISCORD_GUILD_ID=1055502602365845534 \
BOT_CACHE_GIT_REPOSITORY="[email protected]:orbitmines/discord-mirror.git" \
BOT_CACHE_GIT_DIRECTORY="./.orbitmines/cache/git" \
BOT_CACHE_GIT_BRANCH="main" \
DISCORD_CLIENT_ID="..." \
DISCORD_TOKEN="..." \
python3 ./bot/run.py

License Magic

I'm not convinced putting licenses on the repo's in the usual case is anything other than Minecraft servers putting "Not affiliated with Mojang" in their stores just because everyone else does it. But here: after doing absolutely no research into the international ramifications: LICENSE a license for those who like to look at them. Try to reason to what that applies in this repository, obviously that doesn't cover everything not made by me or other contributions to OrbitMines or something. Just put a reference to me or this project somewhere if it's remotely interesting to you.