김건우 / studyChatBot

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

개요

~ 공부합시다 우리 ~
블라블라

핵심기능

1. 오늘 얼마나 공부했는지 (시간, 공부시작, 공부중지, 등)
   
   • 어제보다 얼마나 공부했는지
     
   • 주간 평균, 한달 평균 공부 시간
     
     
2. 공부시간 순위
   
   • 일간 순위
     
   • 주간 순위
     
     
3. D-day 기능
   
   
4. 음악 재생 기능

• 공부에 집중되는 백색소음 재생 기능
  
• 유튜브에서 원하는 노래 재생 기능

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Node.js
• discord.js

(back to top)

Getting Started

• 이 챗봇 프로그램은 디스코드 상에서 동작합니다. 먼저 디스코드를 설치해 주신 후 다음의 과정을 진행해주시기 바랍니다.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm npm install

API Installation

• Discord Developer Applications (https://discord.com/developers/applications)
• Youtube API (https://console.developers.google.com/)

위의 두 API를 다운받으신 후에 config.json 파일에 입력해주어야합니다.

config.json
{
    "prefix": "~",  
    "token": "이곳에 디스코드 봇 API를 입력해주세요",
    "youtubeAPI": "이곳에 유튜브 API를 입력해주세요"
}

Usage

---

명령어

• ~ping
  쿠옹이와 탁구를 칩니다.
• ~현재시간
  현재시간을 알려줍니다.
• ~공부시작
  공부 시작!
  스톱워치가 켜집니다.
• ~공부끝
  공부 끝!
  스톱워치가 멈춥니다.
• ~순위
  공부한 시간 순위를 알려줍니다.
• ~디데이설정 ① ②
  디데이를 설정합니다.
  ① : 이벤트이름
  ② : 이벤트날짜 (mm/dd)
  ex) ~디데이설정 기말고사 12/15
• ~디데이보기
  설정된 디데이를 보여줍니다.
• ~디데이삭제 ①
  입력한 이벤트를 삭제합니다.
  ① : 이벤트이름
  ex) ~디데이삭제 기말고사
• ~재생 ①
  ①을 재생합니다.
  ① : 노래제목
  (먼저 음성채널에 입장해야합니다)

(back to top)

Roadmap

• Discord API 연동
  • Discord ChatBot 구현 through discord.js
• StopWatch 구현
  • StudyTime Ranking 구현
• dDay 구현
• Youtube API 연동
  • Music Play Function in Discord Bot 구현
• AWS EC2 활용
  • Amazon Cloud Server Hosting
  • DiscordBot Demo online for 24/7 구현

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

김건우 - kgu0515@khu.ac.kr

Project Link: http://khuhub.khu.ac.kr/2020104050/studyChatBot.git

(back to top)

Acknowledgments

(back to top)