https://github.com/twixes/somsiad
🤖 The Polish Discord bot
https://github.com/twixes/somsiad
bot discord discord-bot discord-py poland polish
Last synced: 3 months ago
JSON representation
🤖 The Polish Discord bot
- Host: GitHub
- URL: https://github.com/twixes/somsiad
- Owner: Twixes
- License: gpl-3.0
- Created: 2018-07-31T14:57:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T22:04:33.000Z (7 months ago)
- Last Synced: 2025-03-20T00:22:48.664Z (7 months ago)
- Topics: bot, discord, discord-bot, discord-py, poland, polish
- Language: Python
- Homepage: https://somsiad.net
- Size: 2.62 MB
- Stars: 20
- Watchers: 4
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
##### *[polski](#somsiad--po-polsku), [English](#somsiad--in-english)*
### *Dołącz do społeczności! https://discord.gg/c8DhX28wZx*
### *Szukasz instrukcji? Spróbuj komendy `!pomocy`*
### *Sprawdź status: https://somsiad.net*
---
# Somsiad – po polsku
Polski bot discordowy. Napisany w Pythonie.
## Funkcje
* własne serwerowe prefiksy komend
* odtwarzanie muzyki na czacie głosowym
* wysyłanie emotikon (tableflip, shrug, lenny face itp.)
* Magic 8-Ball
* wybieranie jednej z podanych opcji
* rzucanie kośćmi do gry
* reagowanie na wiadomości podanymi znakami
* liczenie oofnięć
* odliczanie do końca roku szkolnego (w Polsce)
* wyszukiwanie stron i obrazków za pomocą [Google](https://www.google.com)
* wyszukiwanie wideo na [YouTube](https://www.youtube.com)
* wyszukiwanie artykułów w [Wikipedii](https://www.wikipedia.org) w dowolnym języku
* wyszukiwanie filmów i seriali w [TMDb](https://www.themoviedb.org/)
* wyszukiwanie książek w [goodreads](https://www.goodreads.com)
* uzyskiwanie informacji i przeprowadzanie obliczeń z [Wolfram Alpha](https://www.wolframalpha.com/)
* udostępnianie obecnie słuchanego na [Spotify](https://spotify.com) utworu
* udostępnianie obecnie lub ostatnio słuchanego przez [Last.fm](https://last.fm) utworu
* wyszukiwanie definicji w [Urban Dictionary](https://www.urbandictionary.com)
* informacje o subredditach i użytkownikach [Reddita](https://reddit.com)
* rozpoczynanie głosowań z opcją opublikowania wyników po określonym czasie
* przypomnienia
* zapamiętywanie urodzin użytkowników serwera i automatyczne składanie życzeń
* statystyki aktywności serwera/kanału/użytkownika wraz z wykresami
* samodzielne wybieranie koloru nicku przez użytkowników
* archiwizacja przypiętych wiadomości do wyznaczonego kanału
* funkcje moderacyjne: ostrzeganie, wyrzucanie, banowanie
* rejestrowanie zdarzeń związanych z członkami serwera (ostrzeżenia, wyrzucenia, bany, dołączenia, opuszczenia)
## Wymagania
* `docker` oraz `docker-compose`.
* Discordowy token bota. By go uzyskać utwórz aplikację w Portalu Deweloperskim Discorda i dodaj do niej bota:
https://discordapp.com/developers/applications/me
* Klucz API Google z obsługą API YouTube Data i Google Custom Search Engine, a także identyfikator wyszukiwarki Google
Custom Search Engine:
https://console.developers.google.com/apis/dashboard
https://cse.google.com/cse/all
By twoja wyszukiwarka Google Custom Search Engine działała prawidłowo, musisz podczas jej tworzenia przypisać do niej
dowolną stronę (może być to https://example.com). Następnie musisz udać się do zakładki Konfiguracja / Podstawy
wyszukiwarki, usunąć dodaną stronę i zaznaczyć pola: "Wyszukiwarka grafiki" oraz "Wyszukiwanie w całej sieci".
* Klucz API goodreads:
https://www.goodreads.com/api
* Klucz API TMDb:
https://developers.themoviedb.org/3/getting-started/introduction
* Klucz API Last.fm:
https://www.last.fm/api/account/create
* ID aplikacji Wolfram Alpha:
https://developer.wolframalpha.com/portal/myapps/
## Instalacja
#### Poniższe instrukcje zostały opracowane z myślą o Debianie lub Ubuntu. Kroki na innych dystrybucjach Linuksa albo macOSie lub Windowsie będą lekko się różniły.
1. Pobierz kopię najnowszego wydania:
https://github.com/Twixes/somsiad/releases/latest
2. Rozpakuj pobrane archiwum i wejdź do nowo utworzonego katalogu:
`tar -xvf somsiad-.tar.gz`
`cd somsiad-`
3. W głównym katalogu skopiuj plik `.template.env` jako `.env`, a następnie wypełnij ten `.env` ustawieniami i kluczami według wzoru.
4. Uruchom bota:
`docker-compose -f docker-compose.dev.yml up`
Ten pierwszy raz może chwilę potrwać, gdyż wszystko musi zostać zainstalowane i ustawione od zera – na szczęście następne uruchomienia będą prawie natychmiastowe.
5. Zapraszaj Somsiada na serwery za pomocą linku podanego w konsoli po uruchomieniu.
Jeśli chcesz przełączyć bota na działanie w tle, użyj skrótu klawiszowego `Ctrl + P` + `Ctrl + Q` lub od razu używaj `docker-compose up` z opcją `-d`.
6. Ekstra – przeprowadź release + deployment Sentry:
`docker exec $(docker ps | grep somsiad_bot | awk '{print $1}') /bin/sh sentry_release_deploy.sh`
## Środowisko deweloperskie
By najwygodniej prowadzić prace nad kodem bota, skorzystaj ze skryptu, który przygotuje ci pythonowe wirtualne środowisko z zainstalowanymi zależnościami:
`./develop.sh`
Możesz wejść wtedy do tego środowiska wybierając je spośród wersji Pythona w pasku dolnym VS Code lub przy użyciu komendy basha:
`source venv/bin/activate`
## Licencja
Kod tego projektu udostępniony jest na licencji GPLv3.
---
# Somsiad – in English
The Polish Discord bot. Written in Python.
## Features
* custom server command prefixes
* music playback over voice chat
* emoticon sending (tableflip, shrug, lenny face, etc.)
* Magic 8-Ball
* choosing one of provided options
* dice rolling
* reacting to messages with given characters
* oof counting
* counting down to the end of the school year (in Poland)
* website and image search powered by [Google](https://www.google.com)
* [YouTube](https://www.youtube.com) video search
* [Wikipedia](https://www.wikipedia.org) article search, in any language
* [TMDb](https://www.themoviedb.org/) movie and TV show search
* [goodreads](https://www.goodreads.com) book search
* obtaining information and making calculations with [Wolfram Alpha](https://www.wolframalpha.com/)
* sharing the song currently played on [Spotify](https://spotify.com)
* sharing the song currently or previously played with [Last.fm](https://last.fm)
* [Urban Dictionary](https://www.urbandictionary.com) definition search
* subreddit and [Reddit](https://reddit.com) user information
* vote commencement with optional publication of results after a specified amount of time
* reminders
* calculation of mathematical expressions
* remembering birthdays of server members and automatic wishes
* server/channel/user activity statistics with charts
* self-selection of nick color by users
* moderation commands: warn, kick, ban
* recording of server member events (warnings, kicks, bans, joinings, leavings)
* archivization of pinned messages to a specified channel
## Prerequisites
* `docker` and `docker-compose`.
* A Discord bot token. In order to obtain it create an app in the Discord Developer Portal and add a bot to it:
https://discordapp.com/developers/applications/me
* A Google API key with YouTube Data and Google Custom Search Engine APIs support, and also a Google Custom Search
Engine's identifier:
https://console.developers.google.com/apis/dashboard
https://cse.google.com/cse/all
In order to make your Google Custom Search Engine work correctly, you must assign any website to it during creation
(it might as well be https://example.com). Then you must go into the CSE's Setup / Basics, remove the website and
check boxes: "Image search" and "Search the entire web".
* A goodreads API key:
https://www.goodreads.com/api
* A TMDb API key:
https://developers.themoviedb.org/3/getting-started/introduction
* A Last.fm API key:
https://www.last.fm/api/account/create
* A Wolfram Alpha app ID:
https://developer.wolframalpha.com/portal/myapps/
## Installation
#### Below instructions have been compiled with Debian or Ubuntu in mind. Steps on other Linux distributions or macOS or Windows will differ slightly.
1. Grab a copy of the latest release:
https://github.com/Twixes/somsiad/releases/latest
2. Unpack the downloaded archive and enter the newly created directory:
`tar -xvf somsiad-.tar.gz`
`cd somsiad-`
4. In the root directory copy file `.template.env` as `.env` and complete that `.env` with settings according to the template.
5. Run the bot:
`docker-compose -f docker-compose.dev.yml up`
This first time may take a while as everything must be set up from nothing – luckily after that launching will be almost instant.
6. Invite Somsiad to servers with the link provided in the console upon launch.
If you want to switch the bot to running in the background, use combination `Ctrl + P` + `Ctrl + Q` or just run `docker-compose up` with option `-d`.
7. Extra – perform a Sentry release + deployment:
`docker exec $(docker ps | grep somsiad_bot | awk '{print $1}') /bin/sh sentry_release_deploy.sh`
## Development environment
To most comfortably work on the bot's code, use the script that will prepare for you a Python virtual environment with dependencies installed:
`./develop.sh`
You can then enter the environment by choosing it from Python versions in VS Code's bottom bar or with bash command:
`source ./venv/bin/activate`
## License
The code of this project is licensed under GPLv3.