如何使用本项目

[systemannounce]

本Issue旨在帮助各位可以快速地上手这个项目

别设置私密了，这样子获取不到你的好友列表会报错的。

视频教程： https://www.bilibili.com/video/BV1gEpzeCE5p/

---

如果你想在本地运行这个程序的话，可以用下面这条命令来运行。 #3

把web_api和id的参数值换成你自己的就行了

后面的proxy的参数看自己需求，有代理就挂代理然后写上自己的端口，没有就删掉。

python3 .\steam.py --web_api XDXXXXXXXXD0XX5XX24XXXXD1AXXXXX2 --id 70000000000000004 --proxy  http://127.0.0.1:10086

---

1. Fork或者下载一份源码上传到你的仓库

因为这里篇幅还有考虑到麻烦程度，我这里以及下面只介绍Fork的方法。

---

---

这里没什么问题，直接点击右下角那个CreateFork即可

---

---

2. 删除默认的好友列表

README文件这里默认的两个人随你喜好，删了也好，不删也罢。下面介绍一下怎么删除

首先点击右上角的笔符号

---

---

将红色方框和深色底色的部分全部删除，然后点击右上角的绿色按钮提交即可。

---

---

3. 添加web_api和你的steamID

我们依次点击仓库里面的Settings，Secrets and variables， Actions。然后在下面的红框内添加两个Secrets即可。

---

---

注意：web_api及其重要和私密，如果没有特殊情况请绝对不要和他人共享！！！！！！

如果已经遭遇泄露请及时注销更换。

Name	Secret
web_api	获取网址
id	id有17位，一般来说，就在你的steam个人信息页面，见下图

---

---

添加好后，你的应该和这个一样，那就没错了。

---

---

4. 启用Actions自动更新

在刚刚Fork以后，Actions不会自动启用，得手动设置为启用状态才能自动更新。

点击 Actions 和 I understand my workflows, go ahead and enable them

然后再在新界面中点击左边的SteamFriends，上面有黄色横幅点击启用即可。

---

---

5. 题外话（关于注意事项和手动更新）

Remark是你可以手动记录的内容，你可以手动编辑，更新不会把这里清空。

因为steam给每个人的API限制了额度，每人每天好像100w次吧，我这个项目估计更新一次请求了大概2-30次（根据你好友数量的多少。）

如果没有特殊情况放在那就好，如果实在有需求需要手动更新可以在这里执行

---

[systemannounce]

如果遇到任何问题，请去新建一个Issue🔗，不要在这下面回复了，处理问题太不方便了