Metadata-Version: 2.4
Name: telegram-slot-map
Version: 1.0.1
Summary: Complete and customizable mapping of Telegram slot machine (🎰) dice values (1-64) to symbol combinations
Author-email: Matychka <mmatychka@gmail.com>
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file


# telegram-slot-map

**Полная и настраиваемая расшифровка всех 64 исходов слота 🎰 в Telegram.**

Когда бот отправляет `dice` с эмодзи 🎰, сервер возвращает `dice.value` — число от 1 до 64.
Эта библиотека даёт точное соответствие каждой комбинации символов и позволяет **заменить их на свои эмодзи, стикеры или текст**.

---

## 📦 Установка

```bash
pip install telegram-slot-map
````

-----

## 🚀 Как использовать

### 1\. Базовый пример (Готовая строка)

Функция `get_slot_combination` принимает число (значение дайса) и возвращает строку с названиями символов.

```python
from slotmap import get_slot_combination

# Допустим, бот получил dice.value = 43
dice_value = 43

# Получаем результат
result = get_slot_combination(dice_value)

print(result)
# Вывод: lemon lemon lemon
```

-----

### 2\. Замена эмодзи на свои (Кастомизация) 🔥

Самая полезная функция. Вы можете передать свой словарь `symbols`, чтобы библиотека вернула строку уже с вашими красивыми смайликами.

**Ключи для замены:** `'bar'`, `'cherry'`, `'lemon'`, `'seven'`.

```python
from slotmap import get_slot_combination

# 1. Создаем свой маппинг символов
MY_EMOJIS = {
    'bar': 'Bar',       # Можно текст
    'cherry': '🍒',     # Можно эмодзи
    'lemon': '🍋',
    'seven': '7️⃣'
}

# 2. Передаем его в функцию вторым аргументом
print(get_slot_combination(1, symbols=MY_EMOJIS))
# Вывод: Bar Bar Bar

print(get_slot_combination(64, symbols=MY_EMOJIS))
# Вывод: 7️⃣ 7️⃣ 7️⃣

print(get_slot_combination(22, symbols=MY_EMOJIS))
# Вывод: 🍒 🍒 🍒
```

-----

### 3\. Получение списка (Для логики игр)

Если вы пишете бота казино, вам, скорее всего, нужна не строка, а **список** (list), чтобы программно проверять условия победы (например, "совпали ли первые два символа?").

Для этого импортируйте `RAW_SLOT_COMBINATIONS`.

```python
from slotmap import RAW_SLOT_COMBINATIONS

dice_value = 11  # Значение от телеграма

# Получаем сырой список ['lemon', 'lemon', 'bar']
# Обратите внимание: ключи в словаре — строки, поэтому используем str(dice_value)
combo_list = RAW_SLOT_COMBINATIONS[str(dice_value)]

print(combo_list)
# Вывод: ['lemon', 'lemon', 'bar']

# Пример проверки логики выигрыша
if combo_list[0] == combo_list[1]:
    print("Первые два символа совпали! Малый выигрыш.")

if combo_list[0] == combo_list[1] == combo_list[2]:
    print("ДЖЕКПОТ! Все три символа совпали.")
```

-----

## 📚 Справочник значений

Всего в телеграм-слоте используется 4 типа символов. Используйте эти ключи для кастомизации словаря `symbols`:

| Ключ библиотеки | Стандартный вид в Telegram | Описание |
| :--- | :--- | :--- |
| `bar` | bar | Надпись BAR |
| `cherry` | 🍇 / 🍒 | Виноград (часто называют вишней) |
| `lemon` | 🍋 | Лимон |
| `seven` | 7️⃣ | Цифра 7 |

