wc_robot

wc_robot

Brief introduction

A WeChat robot with simple functions and easy use

Supported functions:

• Supports automatic reply to "XX (city/region) weather" and "XX (city/region) air quality" keywords (weather data source: Xiaomi Weather)
• Supports automatic reply to "XX (city/province/country) epidemic" keywords (epidemic data source: Baidu real-time epidemic)
• Send weather forecast regularly every day
• Send messages regularly every day
• Important date reminder (similar to countdown day)

Optional features:

• After configuring alapi token, it supports automatic reply of "love words/chicken soup/famous quotes"
• Support GPT text model automatic reply

Use preconditions

• Use a WeChat account as a robot account to avoid being blocked (I have been using it for a few months and everything is fine. If you are brave, you can just use the large account)
• Accounts need real-name verification, otherwise they will not be able to log in to other platforms other than the mobile phone. You can refer to this article on how to authenticate using WeChat.
• If you need to monitor/reply to group chat messages, you need to save the group chat to your address book to avoid WeChat not giving the group chat data when you log in.

6 quick steps to use

1. Execute git clone https://github.com/leantli/wc_robot.git
2. Go to the project root directory and execute go mod tidy
3. Refer to the comments to modify the two fields in config.yaml -> robot_name and on_contact_nicknames
4. Execute go run main.go
5. Scan the QR code to log in to WeChat
6. Change the number and send "Shenzhen Weather" to the WeChat robot to test whether the configuration is successful. If successful, the Shenzhen weather forecast will be returned.

Deploy to Linux CentOS server

1. Execute the command env GOOS=linux GOARCH=amd64 go build -o wc_robot main.go in the project root directory
2. Upload the binary file wc_robot and the configuration file config.yaml to the server. It depends on you which directory to upload to the server.
3. chmod +x ./wc_robot gives execution permission to the file
4. nohup ./wc_robot > robot.log & run the program in the background and output the log to the robot.log file
5. tail -50f ./robot.log observe the log. The WeChat login QR code is also in the log. Scan the code to log in by yourself.

Some problems in use

1. It is easy to be disconnected when logging in when playing with a robot at the beginning, but if the robot chats like a normal person, it can generally last longer, so if you have nothing to do, you can ask the robot about the weather or set up several evenly distributed scheduled messages for the robot, which can be done to a certain extent. Improve survival time
2. It is recommended not to set all scheduled sending at the same time, and pay attention to flow control, otherwise sending large batches of information in a short time will obviously be easily monitored by WeChat security.
3. It is recommended to log out through WeChat on your mobile phone every time you log out.
4. When replying using keywords in a group chat, @bot is required, otherwise there will be no response.
5. 2022.12.14 Note: Recently, because chatGPT + WeChat is too popular, WeChat has been blocked very hard. Many people in the openwechat group have been warned/restricted from logging in. If you want to play recently, try to use a small account.
6. 2023.2.23 Around the beginning of this month, chatGPT became more popular. Many people used WeChat to access GPT, so WeChat detection became more stringent. Simulated client communication methods such as openwechat are easier to detect, so they are more recommended. Use hooks to build robots. It is recommended to search for hooks. If you are too lazy to work on the WeChat robot project, it is really more convenient to use mine. You must have a small account, and if the checking and killing intensity is strong, you may be found immediately after logging in for a while.

Follow-up development plan

2022.11.9 TODO(leantli):

1. "Weather", "Air Command" keyword reply setting does not need to set weather_msg_handle.city_code , match the corresponding city area according to other WeChat users' messages for weather broadcast (☑️)
2. Added "{city} epidemic" keyword reply (☑️)

2022.11.11 TODO(leantli):

1. Increase survival time recovery (☑️)
2. Add scheduled epidemic reporting configuration (there is no epidemic, delete this requirement)

2022.11.28 TODO(leantli):

1. Every time I go out to eat, I have several options, but I’m always hesitant. My girlfriend asked me to give the robot a random selection.

2022.12.9 TODO(leantli):

1. Add GPT chat reply(☑️)
2. Add hot configuration function

2023.2.23: I should not continue to update this project. I will start a new branch to try other ways of WeChat robots. I was laid off recently. Let’s check it out later when I have time.

some words

1. Developed based on openwechat, but did not import it directly, but referred to the relevant code. Based on the function I wanted to implement, I wrote it myself and modified part of the implementation logic according to my own ideas. The main body is still openwechat, and the main thing is to learn golang. Developed, thanks to eatmoreapple.
2. Can you help me with code review? If you have any suggestions on code details and refactoring, please contact me.
3. If you have any additional features, please contact me, or you can submit a PR yourself.
4. If this project can help you or you find this project interesting, you are very welcome to Star.

Function configuration

The following configuration modifications are based on config.yaml

"Weather", "Air quality" keyword reply

1. weather_msg_handle.switch_on Whether to enable automatic reply for this keyword, the default is true

"epidemic" keyword reply

1. covid_msg_handle.switch_on Whether to enable automatic reply for this keyword, the default is true

Send weather forecast regularly every day

1. weather_schedules.switch_on Whether to enable this scheduled task, the default is false , enable is set to true
2. weather_schedules.to_nicknames Who should the weather forecast be sent to? The filled content is the nickname of the WeChat user. Group chat nicknames are supported. If multiple people need to be filled in, separate them with English commas ','
3. weather_schedules.to_remarknames Who should the weather forecast be sent to? The filled-in content is the WeChat user's remarks. Group chat remarks are not supported. Group chat remarks are not returned during WeChat normal communication and cannot be recognized. If multiple people need to be filled in, use an English comma ',' separate
4. weather_schedules.times is the specific time for sending weather forecasts every day, the format is "00:00:00", multiple times are separated by English commas ','
5. weather_schedules.city_code The area where this weather forecast is broadcast defaults to the Nanshan area of ​​Shenzhen. If you need to change it, see https://wis.qq.com/city/like?source=pc&city=Nanshan, modify the last "Nanshan" by yourself, and search Get the corresponding city_code

Send messages regularly every day

1. clock_in_schedules.switch_on Whether to enable this scheduled task, the default is false , enable is set to true
2. clock_in_schedules.to_nicknames Who to send this message to? Fill in the nickname of the WeChat user. Group chat nicknames are supported. If multiple people need to be filled in, separate them with English commas ','
3. clock_in_schedules.to_remarknames Who should the message be sent to? The filled-in content is the WeChat user’s remarks. Group chat remarks are not supported. Group chat remarks are not returned during WeChat normal communication and cannot be recognized. If multiple people need to be filled in, separate them with English commas ','
4. clock_in_schedules.times is the specific time for sending messages regularly every day, the format is "00:00:00", multiple times are separated by English commas ','
5. The content of the clock_in_schedules.text message, such as "I miss my wife so much❤️", "Not getting off work yet?"

important day

1. days_matters.switch_on Whether to enable this scheduled task, the default is false , enable is set to true
2. days_matters.to_nicknames Who should the reminder be sent to? The filled content should be the nickname of the WeChat user. Group chat nicknames are supported. If multiple people need to be filled in, separate them with English commas ','
3. days_matters.to_remarknames Who should the reminder be sent to? The filled-in content is the WeChat user’s remarks. Group chat remarks are not supported. Group chat remarks are not returned during WeChat normal communication and cannot be recognized. If multiple people need to be filled in, separate them with English commas ','
4. days_matters.times is the specific time to send reminders every day, the format is "00:00:00", multiple times are separated by English commas ','
5. days_matters.date The specific dates of important days, in the format of "yyyy-MM-dd", such as "2021-4-3"
6. days_matters.content are the important days, such as "Being with my wife", "Paying salary"

Take "with my wife" as an example

If date is set to the past time, the message will be sent as "%s (with my wife) has been %d days"

If date is set to the time of the day, the message will be sent as "Today is %s (with my wife)"

If date is set to the future time, the message will be sent as "There are %d days until %s (with my wife)"

(optional function) "love words", "chicken soup", "famous quotes" keyword reply

1. alapi.switch_on Whether to enable automatic reply for this keyword, the default is false , if enabled, configure it to true , and pay attention to configuring token
2. alapi.token , you need to register on the ALAPI website to obtain it. Free users of the api support 1qps calls, which is more than enough for personal use.

(Optional feature) GPT text model reply

1. openai.api_key : open_ai’s authentication token, you need to register on the openai official website and obtain it from https://beta.openai.com/account/api-keys
2. openai.gpt_text_switch_on Whether to enable GPT text reply function, the default is false
3. openai.gpt_text_is_default_reply Whether to set gpt text reply as the default reply (that is, automatically call GPT when other keywords are not triggered), false When closed, the gpt reply needs to be triggered through the "gpt xxx" format; enabled by default