|
1 | 1 |  |
2 | 2 | # About |
3 | | -Чат бот для студентов |
| 3 | +Чат бот для студентов. Мой первый проект на Python, создан лишь для изучения языка. |
4 | 4 |
|
5 | 5 | # Основные функции |
6 | 6 | ### Начало |
|
50 | 50 | > /звонок <br> |
51 | 51 |
|
52 | 52 | ## Препод |
53 | | -### Поиск |
| 53 | +### Поиск имени |
54 | 54 | Найдёт имя препода по названию его предмета.<br> |
55 | | -> /препод **[Предмет]**<br> |
| 55 | +> /препод найти **[Предмет]**<br> |
56 | 56 |
|
57 | | -### Добавление |
| 57 | +### Добавление записи |
58 | 58 | Если кого-то не хватает, то можно добавить самому.<br> |
59 | | -> /добавь **[Препод=Предмет]**<br> |
| 59 | +> /препод добавить **[Препод=Предмет]**<br> |
60 | 60 |
|
61 | | -### Удаление |
| 61 | +### Удаление записи |
62 | 62 | Накосячил, когда добавлял препода? Хотя бы эту ошибку можно исправить...<br> |
63 | | -> /удали **[Препод=Предмет]**<br> |
| 63 | +> /препод удалить **[id препода (номер даётся в сообщении при поиске)]**<br> |
| 64 | +
|
| 65 | +Пример:<br> |
| 66 | +Команда **/препод Философия** возвращает следующее сообщение:<br> |
| 67 | +`🔍 Результаты поиска:`<br> |
| 68 | +`3. Философия (Иван Иванов Иванович)`<br> |
| 69 | +Для удаления этой записи (если она была добавлена Вами) нужно отправить: |
| 70 | +> /препод удалить **3** <br> |
64 | 71 |
|
65 | 72 | ## Важное сообщение |
66 | 73 | Сделать объявление на весь чат (@everyone).<br> |
67 | 74 | > /важно **[Сообщение]**<br> |
68 | 75 |
|
| 76 | +## Экзамен |
| 77 | +### Ближайший экзамен |
| 78 | +Выдаст ближайший экзамен в соответствии с учебной группой.<br> |
| 79 | +> /экзамен <br> |
| 80 | +
|
| 81 | +### Ближайшие несколько экзаменов |
| 82 | +Выдаст несколько ближайших экзаменов в соответствии с учебной группой.<br> |
| 83 | +> /экзамен **[количество]**<br> |
| 84 | +
|
| 85 | +### Добавить экзамен |
| 86 | +Добавит экзамен вашей учебной группе.<br> |
| 87 | +> /экзамен добавить **[ДД-ММ-ГГГГ ЧЧ:ММ=Название экзамена]** <br> |
| 88 | +
|
| 89 | +Пример:<br> |
| 90 | +> /экзамен добавить **31-12-2077 23:59=Философия** <br> |
| 91 | +
|
| 92 | +### Удалить экзамен |
| 93 | +Удалит экзамен вашей учебной группе.<br> |
| 94 | +> /экзамен удалить **[id экзамена (см. "/препод удалить")]** <br> |
| 95 | +
|
69 | 96 | # Помощь |
70 | 97 | ### Карусель, карусель... |
71 | 98 | Карусель с самым необходимым.<br> |
72 | 99 | > /помощь <br> |
73 | 100 |
|
| 101 | +### Все команды |
| 102 | +Отправит все команды (длинное сообщение + не все могут быть доступны).<br> |
| 103 | +> /команды <br> |
| 104 | +
|
74 | 105 | # Misc. |
75 | 106 | ## Клавиатура бота |
76 | 107 | ### Показать клавиатуру |
|
87 | 118 |
|
88 | 119 | ## Random reply |
89 | 120 | Бот что-то отправит...<br> |
90 | | -> sadbot <br> |
| 121 | +> /sadbot <br> |
91 | 122 |
|
92 | | -## Остановить работу бот (отключено) |
| 123 | +## Остановить работу бот |
93 | 124 | Требуются права админа. Сохраняет анонимную статистику и убивает бота. |
94 | | -> Стоп <br> |
95 | | -> Stop <br> |
96 | | -> Kill <br> |
| 125 | +> /kill |
| 126 | +
|
| 127 | +## Кастомные скрипты |
| 128 | +Доступ к консоли через чат с ботом. |
| 129 | +> /run **[команда]** |
97 | 130 |
|
98 | 131 | # Console commands |
99 | | -Если вы хотите запустить бота у себя. <br> |
| 132 | +### Если вы хотите запустить бота у себя. <br> |
| 133 | + |
100 | 134 | `--initiate` Создаст пустую базу данных и добавит в неё group0, чтобы вы сразу могли внести изменения. |
101 | 135 | Не забудьте отредактировать расписание звонков в groups. <br> |
| 136 | + |
102 | 137 | `--generate_template` Создаст пустой .xls файл, необходимый для регистрации новой группы. |
103 | 138 | Отредактируйте его, заполнив туда ваше расписание для верхней и нижней недели в соответсвии с заголовком столбца. |
104 | 139 | 1 означает нижняя неделя, 2 — верхняя. <br> |
| 140 | + |
105 | 141 | `--register_new_group` Добавит новую группу в базу данных. Требуется .xls файл (см. выше). <br> |
| 142 | + |
106 | 143 | `--update_group` Обновит расписание и/или название группы <br> |
| 144 | + |
107 | 145 | `--start` Запустит бота. Не забудьте проверить config.py <br> |
| 146 | + |
108 | 147 | # Credits: |
109 | 148 | #### Design |
110 | 149 | defaulterror (Derek Clark): [Commando Font](https://www.dafont.com/commando.font) <br> |
|
0 commit comments