Showing
1 changed file
with
100 additions
and
20 deletions
| 1 | -# 스터디용 챗봇 | 1 | +# 디스코드 스터디 챗봇 |
| 2 | 2 | ||
| 3 | 3 | ||
| 4 | 4 | ||
| 5 | 5 | ||
| 6 | >디스코드 상에서 스터디 진행할 수 있는 툴. | 6 | >디스코드 상에서 스터디 진행할 수 있는 툴. |
| 7 | 7 | ||
| 8 | -------------------- | 8 | +<br/> |
| 9 | + | ||
| 10 | +## About The Project | ||
| 11 | +------------------ | ||
| 9 | 12 | ||
| 10 | -## 핵심기능 | 13 | +### 개요 |
| 14 | +~ 공부합시다 우리 ~<br/> | ||
| 15 | +블라블라 | ||
| 11 | 16 | ||
| 12 | -### 1. 오늘 얼마나 공부했는지 (시간, 공부시작, 공부중지, 등)<br/> | 17 | +### 핵심기능 |
| 13 | -+ 어제보다 얼마나 공부했는지<br/> | 18 | + |
| 14 | -+ 주간 평균, 한달 평균 공부 시간 | 19 | +1. **오늘 얼마나 공부했는지 (시간, 공부시작, 공부중지, 등)<br/>** |
| 20 | + + 어제보다 얼마나 공부했는지<br/> | ||
| 21 | + + 주간 평균, 한달 평균 공부 시간<br/> | ||
| 22 | +<br/> | ||
| 23 | +2. **공부시간 순위<br/>** | ||
| 24 | + + 일간 순위<br/> | ||
| 25 | + + 주간 순위<br/> | ||
| 15 | <br/> | 26 | <br/> |
| 27 | +3. **D-day 기능<br/>** | ||
| 28 | + | ||
| 29 | +#### 4. 음악 재생 기능 | ||
| 30 | ++ 공부에 집중되는 백색소음 재생 기능<br/> | ||
| 31 | ++ 유튜브에서 원하는 노래 재생 기능 | ||
| 16 | 32 | ||
| 17 | -### 2. 공부시간 순위<br/> | ||
| 18 | -+ 일간 순위<br/> | ||
| 19 | -+ 주간 순위 | ||
| 20 | <br/> | 33 | <br/> |
| 21 | 34 | ||
| 22 | -### 3. D-day 기능 | 35 | +### Built With |
| 36 | + | ||
| 37 | ++ Node.js | ||
| 38 | + | ||
| 39 | +## Getting Started | ||
| 40 | +---------------------------- | ||
| 41 | + | ||
| 42 | +* 이 챗봇 프로그램은 디스코드 상에서 동작합니다. 먼저 [디스코드를 설치](https://discord.com/)해 주신 후 다음의 과정을 진행해주시기 바랍니다. | ||
| 43 | + | ||
| 44 | +* [**여기**](https://discord.com/api/oauth2/authorize?client_id=907956665113018408&permissions=8&scope=bot)를 클릭하여 챗봇을 서버에 초대하시기 바랍니다.<br/>(본인이 관리자인 서버에서만 초대 가능) | ||
| 45 | + | ||
| 46 | +### Module Installation | ||
| 47 | + | ||
| 48 | ++ discord.js | ||
| 49 | +```sh | ||
| 50 | +npm install discord.js@12.5.3 | ||
| 51 | +``` | ||
| 52 | ++ moment | ||
| 53 | +```sh | ||
| 54 | +npm install --save moment | ||
| 55 | +``` | ||
| 56 | ++ simple-youtube-api | ||
| 57 | +```sh | ||
| 58 | +npm install simple-youtube-api | ||
| 59 | +``` | ||
| 60 | ++ ytdl-core | ||
| 61 | +```sh | ||
| 62 | +npm install ytdl-core | ||
| 63 | +``` | ||
| 64 | ++ ffmpeg-binaries | ||
| 65 | +```sh | ||
| 66 | +npm install --save ffmpeg-binaries | ||
| 67 | +``` | ||
| 68 | + | ||
| 69 | +### API Installation | ||
| 70 | + | ||
| 71 | ++ Discord Developer Applications (https://discord.com/developers/applications) | ||
| 72 | ++ Youtube API (https://console.developers.google.com/) | ||
| 23 | 73 | ||
| 24 | <br/> | 74 | <br/> |
| 25 | 75 | ||
| 26 | -### 4. 음악 재생 기능 | 76 | +## Usage |
| 27 | -+ 공부에 집중되는 백색소음 재생 기능<br/> | 77 | +------------------------ |
| 28 | -+ 유튜브에서 원하는 노래 재생 기능 | 78 | + |
| 79 | +### 명령어 | ||
| 29 | 80 | ||
| 81 | + | ||
| 82 | +<br/> | ||
| 83 | + | ||
| 84 | +## Roadmap | ||
| 85 | +---------------- | ||
| 86 | + | ||
| 87 | +<br/> | ||
| 88 | + | ||
| 89 | +## Contributing | ||
| 30 | ----------------- | 90 | ----------------- |
| 31 | 91 | ||
| 32 | -## Getting Started | ||
| 33 | 92 | ||
| 34 | -_이 챗봇 프로그램은 디스코드 상에서 동작합니다. 먼저 [디스코드를 설치](https://discord.com/)해 주신 후 다음의 과정을 진행해주시기 바랍니다._ | 93 | +<br/> |
| 94 | + | ||
| 95 | +## License | ||
| 96 | +--------------- | ||
| 35 | 97 | ||
| 36 | -1. 디스코드 챗봇 생성 | 98 | +MIT License |
| 37 | 99 | ||
| 38 | - 먼저 [**디스코드 개발자포탈**](https://discord.com/developers/docs)에 접속하여 디스코드 로그인을 합니다. | 100 | +Copyright (c) 2021 김건우 |
| 39 | 101 | ||
| 40 | -2. 좌측 상단 삼단바를 클릭 -> Application | 102 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 103 | +of this software and associated documentation files (the "Software"), to deal | ||
| 104 | +in the Software without restriction, including without limitation the rights | ||
| 105 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| 106 | +copies of the Software, and to permit persons to whom the Software is | ||
| 107 | +furnished to do so, subject to the following conditions: | ||
| 41 | 108 | ||
| 109 | +The above copyright notice and this permission notice shall be included in all | ||
| 110 | +copies or substantial portions of the Software. | ||
| 42 | 111 | ||
| 43 | ----------------------- | 112 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 113 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| 114 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| 115 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| 116 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| 117 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| 118 | +SOFTWARE. | ||
| 119 | + | ||
| 120 | + | ||
| 121 | +<br/> | ||
| 44 | 122 | ||
| 45 | -## | 123 | +## Contact |
| 124 | +------------------ | ||
| 46 | 125 | ||
| 126 | +김건우 - kgu0515@khu.ac.kr | ... | ... |
-
Please register or login to post a comment