README.md

PUBG BOT

ㅈ # Introduce

한국어 기반의 배틀그라운드 전적을 알려주는 디스코드 봇입니다. 사용자의 전적과 매치 로그를 확인할 수 있습니다.

전적 기능(/전적)

전적 기능을 통하여 배틀그라운드 플레이어의 전적을 확인해보세요! 일반 모드와 경쟁 모드를 보다 편리하게 확인하실 수 있습니다. 특히 버튼 기능을 활용하여 특정 모드 전적을 세세히 확인할 수 있습니다.

매치 히스토리 기능(/매치)

매치 히스토리 기능을 통하여 플레이 내역을 확인해보세요. 누구랑 팀원을 했는지, 누가 버스를 안탔는지, 어디서 누구를 잡았는 지등의 다양한 정보를 제공합니다.

Clone

본 프로젝트를 사용하기 위해서는 라이센스를 지킨다는 조건 아래에 사용이 가능합니다.

NAME	VERSION	TESTED
Windows	Windows 11 22H2	✔️ (Development)
Mac	Mac OS Ventura	✔️ (Development)
Ubuntu	Ubuntu 20.04.6 LTS	✔️ (Production)
Python	v3.11.2	✔️
Python	v3.8.6	❌️( ≤ v3.0 )
Python	v3.7.3	❌️( ≤ v2.0 )
MariaDB	10.3.23-MariaDB	✔️

• v2.1 버전 부터 discord.py의 요구 사항이 Python3.8 이상인 것을 반영하여 Python3.8 미만의 버전은 v2.0 까지만 사용이 가능합니다.
• v3.0 버전 부터 discord.extension.interaction의 요구 사항이 Python3.10 이상인 것을 반영하여 Python3.11 에 따라 제작되었습니다.

사용 전, 아래 과정을 거쳐주세요.

1. config 파일을 설정해주세요.

config_example.ini 를 config.ini로 변경한 후, 파일 내에 설정을 해주세요.

cd PUBG_BOT
mv config/config_example.ini config/config.ini

2. setup.py를 실행시켜주세요.

데이터베이스 테이블 설정 작업이 진행됩니다.

2. requirements.txt 안에 있는 모듈을 모두 설치해 주세요.

PUBG BOT이 정상적으로 구동되기 위해 필요한 파일입니다. 꼭 설치해 주세요.

pip install -r requirements.txt

Structure

PUBG BOT의 구성은 다음과 같습니다.

• assets : PUBG BOT의 에셋 파일입니다.
• cogs : discord.ext.interaction에서 제공하는 cogs입니다. 주로 명령어를 처리합니다.
• config : PUBG BOT의 설정 파일입니다.
• models : PUBG BOT의 데이터 모델 클래스 입니다.
• module : PUBG BOT이 구성되기 위한 "자체 모듈"입니다. pubgpy가 포함되어 있습니다.
• process : 처리 과정의 소스코드 입니다. 상호작용과 주요 기능의 메세지 출력은 해당 코드에서 이루어 집니다.
• utils : PUBG BOT이 정상적으로 구동되기 위한 유틸리티 파일 입니다.

License

프로젝트의 라이센스의 구성은 다음과 같습니다.

MIT License

아래의 파일들은 MIT License가 적용됩니다.

• PUBGpy

GNU General Public License v3.0

아래의 파일들은 GNU(General Public License v3.0)가 적용됩니다.

• assets/layout
• cogs/*
• models/*
• module/*
• utils/*
• main.py