Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

byteline

License Python

Консольный чат в текстовом формате (TCP/UDP) с поддержкой шифрования и автоматического проброса портов (UPnP).

✨ Возможности

  • 🗨️ TCP/UDP поддержка — выбор протокола при подключении
  • 🔒 XOR-шифрование — базовое шифрование сообщений с помощью ключа
  • 🌐 UPnP проброс портов — автоматическая настройка port forwarding
  • 💬 Консольный интерфейс — простой и удобный CLI
  • 🔄 Многопользовательский режим — поддержка нескольких клиентов
  • Быстрый старт — минимальная конфигурация

🚀 Установка

Требования

  • Python >= 3.6
  • pip

Установка из PyPI

pip install byteline

Установка из исходников

git clone https://github.com/yourusername/byteline.git
cd byteline
pip install -r requirements.txt
pip install .

📖 Использование

Базовые команды

byteline [флаги]

Параметры командной строки

Флаг Описание По умолчанию
-s, --server Запустить в режиме сервера -
-c, --client Запустить в режиме клиента -
-H, --host Хост для подключения localhost
-p, --port Порт подключения 8000
-k, --key Ключ шифрования (XOR) -
-m, --mode Режим: 1-TCP, 2-UDP 1 (TCP)
--upnp Включить автоматический проброс портов -

💡 Примеры использования

1. Запуск сервера с UPnP

byteline -s --upnp

Сервер автоматически пробросит порт и покажет публичный IP для подключения.

2. Запуск сервера на определённом порту

byteline -s -p 8080 --upnp

3. Подключение к серверу по публичному IP

byteline -c -H 123.45.67.89 -p 8080

4. Локальный чат (сам себе собеседник)

byteline -s -c -k secret123

5. Чат с шифрованием

# Сервер
byteline -s -k mypassword --upnp

# Клиент
byteline -c -H public-ip -p 8000 -k mypassword

6. Использование UDP

# Сервер
byteline -s -m 2

# Клиент
byteline -c -H localhost -p 8000 -m 2

7. Выход из чата

Во время чата введите одну из команд:

  • /quit
  • /exit
  • exit
  • quit

⚙️ Зависимости

  • miniupnpc>=2.2.0 — для UPnP-проброса портов

Установка зависимостей:

pip install -r requirements.txt

📋 Структура проекта

byteline/
├── byteline.py      # Основной код приложения
├── setup.py         # Конфигурация setuptools
├── requirements.txt # Зависимости проекта
├── README.md        # Документация
└── LICENSE          # Лицензия MIT

🤝 Вклад в проект

Приветствуются pull requests и issues! Пожалуйста, создавайте issue перед началом работы над крупными изменениями.

📄 Лицензия

Этот проект распространяется под лицензией MIT.

MIT License

Copyright (c) 2026 Veltnik

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

📧 Контакты

🙏 Благодарности

  • miniupnpc — за библиотеку UPnP

⭐ Если проект вам понравился, поставьте звезду на GitHub!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages