Skip to content

Commit

Permalink
簡化 Readme 將說明與下載引導至 Github page
Browse files Browse the repository at this point in the history
  • Loading branch information
CacaoRick committed Sep 13, 2016
1 parent 287114f commit f1887d7
Showing 1 changed file with 13 additions and 104 deletions.
117 changes: 13 additions & 104 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,25 @@

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

## 下載
## 使用說明與下載

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

[Windows X64](https://github.com/CacaoRick/GoPatrol/releases/download/v1.1.2/GoPatrol-win_x64.zip)
## 截圖
Telegram Desktop

![Mac Demo](screenshot/MacDemo.png)

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

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

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

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

### 更新內容

Expand Down Expand Up @@ -65,100 +71,3 @@ v1.0.1
- 刪除 `/start` 指令,改以 `/run` 取代,避免與機器人啟動指令衝突
- 新增 `/restart` 指令
- 新增 `/status` 指令

## 使用說明

- [啟動伺服器](https://github.com/CacaoRick/GoPatrol#啟動伺服器)
- [機器人指令說明](https://github.com/CacaoRick/GoPatrol#機器人指令說明)
- [建立 Telegram 機器人](https://github.com/CacaoRick/GoPatrol#建立-telegram-機器人)
- [使用廣播頻道模式](https://github.com/CacaoRick/GoPatrol#使用廣播頻道模式)
- [使用機器人模式](https://github.com/CacaoRick/GoPatrol#使用機器人模式)
- [使用群組機器人模式](https://github.com/CacaoRick/GoPatrol#使用群組機器人模式)

### 啟動伺服器
1.[Release](https://github.com/CacaoRick/GoPatrol/releases) 頁面根據作業系統下載對應的 zip 檔
2. 解壓縮後將資料夾中的 `example_config.js` 複製一份改名為 `config.js`
4. 以文字編輯器開啟 `config.js` 編輯設定檔(建議使用[nodepad++](https://notepad-plus-plus.org/download/v6.9.2.html)等文字編輯器開啟)
5. 點兩下資料夾中的 `start.bat``start.command`

### 機器人指令說明

`(括號為指令縮寫)` `<尖括號為參數>`

- `/help` (`/h`) 查看說明
- `/getmap` (`/m`) 取得附近寶可夢地圖

以下指令限管理員使用:

- `/run` 開始巡邏和通知
- `/stop` 停止巡邏和通知
- `/restart` (`/re`) 強制重啟巡邏
- `/status` (`/stat`) 取得伺服器狀態
- `/setsteps <數字>` (`/step`) 更改巡邏範圍,例如 `/setsteps 2`
- 傳送位置訊息可更改巡邏中心位置(行動裝置版 Telegram)

### 建立 Telegram 機器人
1. 在 Telegram 中搜尋 `@BotFather`
2.`/newbot` 建立機器人
3. 輸入機器人名稱(例如 公司GoPatrol)
4. 輸入機器人使用者名稱,限英文且結尾須為 `bot`(例如 GoPatrol123_bot)
5. 將 BotFather 給你的 token 複製貼到 `config.js` 中的 `telegramBotToken`

![Create Bot](tutorial/bot.png)

### 使用廣播頻道模式
程式單純的將找到的寶可夢廣播至該頻道中,沒有指令功能。

1. 在 Telegram 建立頻道 (New Channel)
2. 需選擇公開頻道 (Public Channel),並設定頻道連結,請記住你設定的連結,他就是你的頻道ID

![Create Channel](tutorial/channel.png)

2. 將你的機器人邀請為頻道管理員

![Channel Admin](tutorial/channel_admin.png)

3.`config.js` 中將你的頻道ID前面加上`@`填入 `telegramChannelID`

### 使用機器人模式
可對機器人下指令來操控伺服器,發現寶可夢時會通知到與機器人的聊天對話中。

1. 將機器人加為好友
2.`config.json` 中的 `telegramAdminUsernames` 填入你的使用者名稱(username)
3.`config.json` 中的 `telegramChannelID` 設為 `null`
4. 啟動伺服器後,在你與機器人的聊天中輸入 `/run` 就會開始巡邏和通知

### 使用群組機器人模式
將機器人邀請進入群組中,供大家一起使用,並且將發現的寶可夢通知到群組中。

1.`@BotFather` 下達 `/setjoingroups` 指令
2. 選擇要加入群組的機器人並按下 `Enable`
1.`@BotFather` 下達 `/setprivacy` 指令
2. 選擇要加入群組的機器人並按下 `Disable`
3. 建立群組(New Group),將機器人邀請加入群組中
4. 開啟群組的管理員設定,將 `All Members Are Admins` 取消勾選,並將你的機器人設為管理員

![Group Admin](tutorial/group_admin.png)

5.`config.json` 中的 `telegramAdminUsernames` 填入你的使用者名稱(username)
6.`config.json` 中的 `telegramChannelID` 設為 `null`
7. 啟動伺服器後,在群組中輸入 `/run` 就會開始巡邏和通知

## 警告
用這個一定有被BAN的風險,使用前自己考慮要不要用,請勿使用主帳號登入!

## 截圖
Telegram Desktop

![Mac Demo](screenshot/MacDemo.png)

Telegram iOS APP

![iOS Demo](screenshot/iOSDemo.png)

![iOS Demo](screenshot/getmapDemo.png)

## 感謝
感謝`柯姊`提供 Icon host
感謝`Joseph Tsai` 提供部分程式碼
感謝[自己的廣播自己架](https://telegram.me/joinchat/DoTGVEFiQS0UGIg8atBTWw)的大家提供各種意見

0 comments on commit f1887d7

Please sign in to comment.