Skip to content

Commit f1887d7

Browse files
committed
簡化 Readme 將說明與下載引導至 Github page
1 parent 287114f commit f1887d7

File tree

1 file changed

+13
-104
lines changed

1 file changed

+13
-104
lines changed

README.md

+13-104
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,25 @@
66

77
作者 Telegram [@CacaoRick](http://telegram.me/CacaoRick),問題與討論請至 Telegram 群組[自己的廣播自己架](https://telegram.me/joinchat/DoTGVEFiQS0UGIg8atBTWw)
88

9-
## 下載
9+
## 使用說明與下載
1010

11-
目前最新版本為 [v1.1.2](https://github.com/CacaoRick/GoPatrol/releases/tag/v1.1.2),請詳閱[使用說明](https://gopatrolteam.github.io/GoPatrol/)
11+
<https://gopatrolteam.github.io/GoPatrol/>
1212

13-
[Windows X64](https://github.com/CacaoRick/GoPatrol/releases/download/v1.1.2/GoPatrol-win_x64.zip)
13+
## 截圖
14+
Telegram Desktop
15+
16+
![Mac Demo](screenshot/MacDemo.png)
1417

15-
[Mac OSX](https://github.com/CacaoRick/GoPatrol/releases/download/v1.1.2/GoPatrol-mac.zip)
18+
Telegram iOS APP
1619

17-
其他系統可下載 Mac 版並自行下載 v6.4.0 以上之 [Node.js](https://nodejs.org/en/download/current/) 使用。
20+
![iOS Demo](screenshot/iOSDemo.png)
1821

19-
32位元之 Windows 可下載 Win_x64 版並刪除資料夾中之 `node.exe`,再安裝 v6.4.0 以上之 Node.js。
22+
![iOS Demo](screenshot/getmapDemo.png)
2023

21-
不支援 Windows XP。
24+
## 感謝
25+
感謝`柯姊`提供 Icon host
26+
感謝`Joseph Tsai` 提供部分程式碼
27+
感謝[自己的廣播自己架](https://telegram.me/joinchat/DoTGVEFiQS0UGIg8atBTWw)的大家提供各種意見
2228

2329
### 更新內容
2430

@@ -65,100 +71,3 @@ v1.0.1
6571
- 刪除 `/start` 指令,改以 `/run` 取代,避免與機器人啟動指令衝突
6672
- 新增 `/restart` 指令
6773
- 新增 `/status` 指令
68-
69-
## 使用說明
70-
71-
- [啟動伺服器](https://github.com/CacaoRick/GoPatrol#啟動伺服器)
72-
- [機器人指令說明](https://github.com/CacaoRick/GoPatrol#機器人指令說明)
73-
- [建立 Telegram 機器人](https://github.com/CacaoRick/GoPatrol#建立-telegram-機器人)
74-
- [使用廣播頻道模式](https://github.com/CacaoRick/GoPatrol#使用廣播頻道模式)
75-
- [使用機器人模式](https://github.com/CacaoRick/GoPatrol#使用機器人模式)
76-
- [使用群組機器人模式](https://github.com/CacaoRick/GoPatrol#使用群組機器人模式)
77-
78-
### 啟動伺服器
79-
1.[Release](https://github.com/CacaoRick/GoPatrol/releases) 頁面根據作業系統下載對應的 zip 檔
80-
2. 解壓縮後將資料夾中的 `example_config.js` 複製一份改名為 `config.js`
81-
4. 以文字編輯器開啟 `config.js` 編輯設定檔(建議使用[nodepad++](https://notepad-plus-plus.org/download/v6.9.2.html)等文字編輯器開啟)
82-
5. 點兩下資料夾中的 `start.bat``start.command`
83-
84-
### 機器人指令說明
85-
86-
`(括號為指令縮寫)` `<尖括號為參數>`
87-
88-
- `/help` (`/h`) 查看說明
89-
- `/getmap` (`/m`) 取得附近寶可夢地圖
90-
91-
以下指令限管理員使用:
92-
93-
- `/run` 開始巡邏和通知
94-
- `/stop` 停止巡邏和通知
95-
- `/restart` (`/re`) 強制重啟巡邏
96-
- `/status` (`/stat`) 取得伺服器狀態
97-
- `/setsteps <數字>` (`/step`) 更改巡邏範圍,例如 `/setsteps 2`
98-
- 傳送位置訊息可更改巡邏中心位置(行動裝置版 Telegram)
99-
100-
### 建立 Telegram 機器人
101-
1. 在 Telegram 中搜尋 `@BotFather`
102-
2.`/newbot` 建立機器人
103-
3. 輸入機器人名稱(例如 公司GoPatrol)
104-
4. 輸入機器人使用者名稱,限英文且結尾須為 `bot`(例如 GoPatrol123_bot)
105-
5. 將 BotFather 給你的 token 複製貼到 `config.js` 中的 `telegramBotToken`
106-
107-
![Create Bot](tutorial/bot.png)
108-
109-
### 使用廣播頻道模式
110-
程式單純的將找到的寶可夢廣播至該頻道中,沒有指令功能。
111-
112-
1. 在 Telegram 建立頻道 (New Channel)
113-
2. 需選擇公開頻道 (Public Channel),並設定頻道連結,請記住你設定的連結,他就是你的頻道ID
114-
115-
![Create Channel](tutorial/channel.png)
116-
117-
2. 將你的機器人邀請為頻道管理員
118-
119-
![Channel Admin](tutorial/channel_admin.png)
120-
121-
3.`config.js` 中將你的頻道ID前面加上`@`填入 `telegramChannelID`
122-
123-
### 使用機器人模式
124-
可對機器人下指令來操控伺服器,發現寶可夢時會通知到與機器人的聊天對話中。
125-
126-
1. 將機器人加為好友
127-
2.`config.json` 中的 `telegramAdminUsernames` 填入你的使用者名稱(username)
128-
3.`config.json` 中的 `telegramChannelID` 設為 `null`
129-
4. 啟動伺服器後,在你與機器人的聊天中輸入 `/run` 就會開始巡邏和通知
130-
131-
### 使用群組機器人模式
132-
將機器人邀請進入群組中,供大家一起使用,並且將發現的寶可夢通知到群組中。
133-
134-
1.`@BotFather` 下達 `/setjoingroups` 指令
135-
2. 選擇要加入群組的機器人並按下 `Enable`
136-
1.`@BotFather` 下達 `/setprivacy` 指令
137-
2. 選擇要加入群組的機器人並按下 `Disable`
138-
3. 建立群組(New Group),將機器人邀請加入群組中
139-
4. 開啟群組的管理員設定,將 `All Members Are Admins` 取消勾選,並將你的機器人設為管理員
140-
141-
![Group Admin](tutorial/group_admin.png)
142-
143-
5.`config.json` 中的 `telegramAdminUsernames` 填入你的使用者名稱(username)
144-
6.`config.json` 中的 `telegramChannelID` 設為 `null`
145-
7. 啟動伺服器後,在群組中輸入 `/run` 就會開始巡邏和通知
146-
147-
## 警告
148-
用這個一定有被BAN的風險,使用前自己考慮要不要用,請勿使用主帳號登入!
149-
150-
## 截圖
151-
Telegram Desktop
152-
153-
![Mac Demo](screenshot/MacDemo.png)
154-
155-
Telegram iOS APP
156-
157-
![iOS Demo](screenshot/iOSDemo.png)
158-
159-
![iOS Demo](screenshot/getmapDemo.png)
160-
161-
## 感謝
162-
感謝`柯姊`提供 Icon host
163-
感謝`Joseph Tsai` 提供部分程式碼
164-
感謝[自己的廣播自己架](https://telegram.me/joinchat/DoTGVEFiQS0UGIg8atBTWw)的大家提供各種意見

0 commit comments

Comments
 (0)