abocn/kowalski
3
0
Fork 0
mirror of https://github.com/abocn/TelegramBot.git synced 2025-04-28 17:15:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Lucas Gabriel 2024-09-08 11:27:19 -03:00
parent dac6ebf032
commit 7070a0e51f
No known key found for this signature in database
GPG Key ID: D9B075FC6DC93985
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -7,12 +7,15 @@ Lynx is a a simple Telegram bot made in Node.js.
- Node.js 20 LTS (or above) - Node.js 20 LTS (or above)
- Python 3 (or above, for use with SpamWatch API) - Python 3 (or above, for use with SpamWatch API)
- Python dependencies: use ``pip install -r requirements.txt`` - Python dependencies: use ``pip install -r requirements.txt``
- Node.js dependencies: use ``npm install`` - Node.js dependencies: use ``npm install .``
## Run it yourself, develop or contribute with Lynx ## Run it yourself, develop or contribute with Lynx
First, clone the repo and init the submodules with First, clone the repo with Git:
``` ```
git clone https://github.com/lucmsilva651/lynx git clone https://github.com/lucmsilva651/lynx
```
And now, init the submodules with these commands (this is very important):
```
cd lynx cd lynx
git submodule update --init --recursive git submodule update --init --recursive
``` ```
@ -20,17 +23,21 @@ Next, inside the repository directory, go to props folder and create a config.js
``` ```
{ {
"botToken": "0000000000:AAAaaAAaaaaAaAaaAAAaaaAaaaaAAAAAaaa", "botToken": "0000000000:AAAaaAAaaaaAaAaaAAAaaaAaaaaAAAAAaaa",
"admins": [0000000000, 1111111111, 2222222222] "admins": [0000000000, 1111111111, 2222222222],
"lastKey": "0000a000a0000aaa0a00a0aaa0a000000",
"lastSecret": "0000a000a0a0000aa0000aa00000000a"
} }
``` ```
- **botToken**: Put your bot token that you created at [@BotFather](https://t.me/botfather), as the example above. - **botToken**: Put your bot token that you created at [@BotFather](https://t.me/botfather), as the example above.
- **admins**: Put the ID of the people responsible for managing the bot (as the example above). They can use some administrative + exclusive commands on any group. - **admins**: Put the ID of the people responsible for managing the bot (as the example above). They can use some administrative + exclusive commands on any group.
- **lastKey**: Last.fm API key, for use on lastfm.js functions, like see who is listening to what song.
- **lastSecret**: Last.fm API secret (optional), which has the "same" purpose as the API key above.
After editing the file, save all changes and run the bot with ``npm start``. After editing the file, save all changes and run the bot with ``npm start``.
- To deal with dependencies, just run ``npm install`` or ``npm i`` at any moment to install any of them. - To deal with dependencies, just run ``npm install .`` or ``npm i .`` at any moment to install any of them.
## Note ## Note
- Take care of your ``config.json`` file, as it is so much important and needs to be secret (like your passwords), as anyone can do whatever they want to the bot with this token! - Take care of your ``config.json`` file, as it is so much important and needs to be secret (like your passwords), as anyone can do whatever they want to the bot with this token!
## About/License ## About/License
MIT - 2024 Lucas Gabriel (lucmsilva). BSD-3-Clause - 2024 Lucas Gabriel (lucmsilva).