scp079/scp-079-tip repository overview

⁠SCP-079-TIP

This bot is used to send tips.

⁠How to use

• Demo⁠
• Read the document⁠ to learn more
• README⁠ of the SCP-079 Project's demo bots
• Discuss group⁠

⁠Requirements

• Python 3.6 or higher
• Debian 10: sudo apt update && sudo apt install opencc pybind11-dev -y
• Google RE2⁠ installed
  • sudo apt install build-essential git python3-dev -y
  • git clone https://github.com/google/re2.git ~/re2
  • cd ~/re2
  • make
  • make test
  • sudo make install
  • make testinstall
  • sudo ldconfig
• pip: pip install -r requirements.txt

⁠Files

• examples
  • config.ini -> ../data/config/config.ini : Configuration example
  • join.txt -> ../data/config/join.txt : Join template example
  • start.txt -> ../data/config/start.txt : Start template example
• plugins
  • functions
    • channel.py : Functions about channel
    • command.py : Functions about command
    • config.py : Functions about group settings
    • decorators.py : Some decorators
    • etc.py : Miscellaneous
    • file.py : Save files
    • filters.py : Some filters
    • group.py : Functions about group
    • ids.py : Modify id lists
    • markup.py : Get reply markup
    • program.py : Functions about program
    • receive.py : Receive data from exchange channel
    • telegram.py : Some telegram functions
    • timers.py : Timer functions
    • tip.py : Functions about tips
    • user.py : Functions about user and channel object
  • handlers
    • callback.py : Handle callbacks
    • command.py : Handle commands
    • message.py: Handle messages
  • checker.py : Check the format of config.ini
  • glovar.py : Global variables
  • start.py : Execute before client start
  • version.py : Execute before main script start
• .gitignore : Ignore
• Dockerfile : Assemble the docker image
• LICENSE : GPLv3
• main.py : Start here
• README.md : This file
• requirements.txt : Managed by pip

⁠Contribution

Contributions are always welcome, whether it's modifying source code to add new features or bug fixes, documenting new file formats or simply editing some grammar.

You can also join the discuss group⁠ if you are unsure of anything.

⁠Translation

• Choose Language Tags⁠
• Language Subtag Registry⁠

⁠License

Licensed under the terms of the GNU General Public License v3⁠.