Skip to content
This repository has been archived by the owner on Apr 25, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added description for new features + update info for old ones.
  • Loading branch information
sadellie committed Jan 16, 2021
1 parent ea6ba27 commit 99e9f7b
Showing 1 changed file with 52 additions and 13 deletions.
65 changes: 52 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![Cover](./project_files/pics/Cover.png)
# About
Чат бот для студентов
Чат бот для студентов. Мой первый проект на Python, создан лишь для изучения языка.

# Основные функции
### Начало
Expand Down Expand Up @@ -50,27 +50,58 @@
> /звонок <br>
## Препод
### Поиск
### Поиск имени
Найдёт имя препода по названию его предмета.<br>
> /препод **[Предмет]**<br>
> /препод найти **[Предмет]**<br>
### Добавление
### Добавление записи
Если кого-то не хватает, то можно добавить самому.<br>
> /добавь **[Препод=Предмет]**<br>
> /препод добавить **[Препод=Предмет]**<br>
### Удаление
### Удаление записи
Накосячил, когда добавлял препода? Хотя бы эту ошибку можно исправить...<br>
> /удали **[Препод=Предмет]**<br>
> /препод удалить **[id препода (номер даётся в сообщении при поиске)]**<br>
Пример:<br>
Команда **/препод Философия** возвращает следующее сообщение:<br>
`🔍 Результаты поиска:`<br>
`3. Философия (Иван Иванов Иванович)`<br>
Для удаления этой записи (если она была добавлена Вами) нужно отправить:
> /препод удалить **3** <br>
## Важное сообщение
Сделать объявление на весь чат (@everyone).<br>
> /важно **[Сообщение]**<br>
## Экзамен
### Ближайший экзамен
Выдаст ближайший экзамен в соответствии с учебной группой.<br>
> /экзамен <br>
### Ближайшие несколько экзаменов
Выдаст несколько ближайших экзаменов в соответствии с учебной группой.<br>
> /экзамен **[количество]**<br>
### Добавить экзамен
Добавит экзамен вашей учебной группе.<br>
> /экзамен добавить **[ДД-ММ-ГГГГ ЧЧ:ММ=Название экзамена]** <br>
Пример:<br>
> /экзамен добавить **31-12-2077 23:59=Философия** <br>
### Удалить экзамен
Удалит экзамен вашей учебной группе.<br>
> /экзамен удалить **[id экзамена (см. "/препод удалить")]** <br>
# Помощь
### Карусель, карусель...
Карусель с самым необходимым.<br>
> /помощь <br>
### Все команды
Отправит все команды (длинное сообщение + не все могут быть доступны).<br>
> /команды <br>
# Misc.
## Клавиатура бота
### Показать клавиатуру
Expand All @@ -87,24 +118,32 @@
## Random reply
Бот что-то отправит...<br>
> sadbot <br>
> /sadbot <br>
## Остановить работу бот (отключено)
## Остановить работу бот
Требуются права админа. Сохраняет анонимную статистику и убивает бота.
> Стоп <br>
> Stop <br>
> Kill <br>
> /kill
## Кастомные скрипты
Доступ к консоли через чат с ботом.
> /run **[команда]**
# Console commands
Если вы хотите запустить бота у себя. <br>
### Если вы хотите запустить бота у себя. <br>

`--initiate` Создаст пустую базу данных и добавит в неё group0, чтобы вы сразу могли внести изменения.
Не забудьте отредактировать расписание звонков в groups. <br>

`--generate_template` Создаст пустой .xls файл, необходимый для регистрации новой группы.
Отредактируйте его, заполнив туда ваше расписание для верхней и нижней недели в соответсвии с заголовком столбца.
1 означает нижняя неделя, 2 — верхняя. <br>

`--register_new_group` Добавит новую группу в базу данных. Требуется .xls файл (см. выше). <br>

`--update_group` Обновит расписание и/или название группы <br>

`--start` Запустит бота. Не забудьте проверить config.py <br>

# Credits:
#### Design
defaulterror (Derek Clark): [Commando Font](https://www.dafont.com/commando.font) <br>
Expand Down

0 comments on commit 99e9f7b

Please sign in to comment.