Skip to content
This repository was archived by the owner on Nov 9, 2021. It is now read-only.

Commit b1126ce

Browse files
authored
Update README.md
1 parent dcb70df commit b1126ce

File tree

1 file changed

+66
-3
lines changed

1 file changed

+66
-3
lines changed

README.md

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## SpApi - Pyhon библиотека для простого доступа к api серверов #СП
1+
## SpApi - Python библиотека для простого доступа к api серверов #СП
22

33
Это переделка библиотеки https://github.com/ronanru/spapi только для Python
44

@@ -11,9 +11,9 @@
1111
### Использование
1212

1313
```python
14-
from modules import spapi
14+
from modules import spapi # Импортируем
1515

16-
api = spapi.SpApi("spm") # вместо spm пишете нужный сервер если он есть во вкладке 'Поддерживаемые сервера' тут - https://github.com/ronanru/spapi
16+
api = spapi.SpApi("spm") # Вместо spm пишете нужный сервер если он есть во вкладке 'Поддерживаемые сервера' тут - https://github.com/ronanru/spapi
1717

1818
```
1919

@@ -63,3 +63,66 @@ elif a == "weather":
6363
else:
6464
print("Таких данных не обнаружено.")
6565
```
66+
67+
#### Output
68+
```
69+
>>> python3 main.py
70+
Введите что вы хотите получить -> weather
71+
<GetServerWeather weather='CLEAR'>
72+
73+
>>> python3 main.py
74+
Введите что вы хотите получить -> time
75+
<GetServerTime timeOfDay='NIGHT', formated='19:33', ticks=12550>
76+
77+
```
78+
79+
80+
### Список методов и описание
81+
```python
82+
83+
getLastChatMessages(4)
84+
# Получить последние сообщения с сервера
85+
#
86+
# Аргументы:
87+
# limit, первый позициональный аргумент. Влияет на максимальное кол-во возвращаемых сообщений
88+
# Максимум - 50
89+
#
90+
# Пременные:
91+
# messages - Список(list) из сообщений
92+
#
93+
94+
95+
getOnlinePlayers()
96+
# Получить онлайн сервера
97+
#
98+
# Переменные:
99+
# players - Список(list) из словарей с ключами nick & uuid
100+
# count - Число(int) показывает текущий онлайн
101+
# max - Число(int) показывает максимальный онлайн
102+
#
103+
#
104+
105+
106+
getServerTime()
107+
# Получить текущее время на сервере
108+
#
109+
# Переменные:
110+
# timeOfDay - Строка(str) 'DAY' или 'NIGHT'
111+
# ticks - Число(int) Время в тиках
112+
# formated - Строка(str) Время в 24 часовом форма
113+
#
114+
#
115+
#
116+
#
117+
#
118+
119+
120+
getServerWeather()
121+
# Получить текущую погоду на сервере
122+
#
123+
# Переменные:
124+
# weather - Строка(str) 'CLEAR', 'RAIN' или 'THUNDER'
125+
#
126+
127+
128+
```

0 commit comments

Comments
 (0)