Show My Item

Содержание

1. О проекте
   • На чём построен
2. Начало работы
   • Требования
   • Установка
3. Использование
4. Настройка
5. Планы
6. Участие в разработке
7. Лицензия
8. Контакты
9. Благодарности

## О проекте Show My Item — это лёгкий мод для Minecraft на Fabric, созданный для серверов. Он позволяет игрокам делиться предметом в руке, всем инвентарём или эндер-сундуком в чате с помощью простых плейсхолдеров вроде [item], [inventory] или [enderchest]. Другие игроки могут навести курсор на название предмета, чтобы увидеть полную подсказку, или кликнуть по ссылке, чтобы открыть доступный только для чтения контейнер с общим инвентарём. Какую проблему он решает? - Больше не нужно вручную вводить сложные названия предметов или заставлять друзей угадывать, что у тебя в руке. - Мгновенно делись инвентарём или эндер-сундуком без сложных команд. - Наведи курсор, чтобы увидеть детали, кликни, чтобы посмотреть весь инвентарь — общение становится интуитивным и наглядным. - Исключительно для того, чтобы делиться и хвастаться, без читов и ломающих игру элементов. Почему стоит выбрать его? - Просто: плейсхолдеры на естественном языке, работают и на английском, и на китайском. - Мощно: поддерживает основную руку, вторую руку, инвентарь (включая броню и вторую руку) и эндер-сундук. - Настраиваемо: меню в чате в стиле Carpet для изменения времени жизни, максимального числа снимков и языка на лету. - Легко: только на стороне сервера; клиентам не нужно устанавливать мод. - Совместимо: построено на Fabric API, совместимо с большинством модов. Конечно, ни один мод не может угодить всем. Если у тебя есть предложения, смело открывай Issue или Pull Request.

(наверх)

### На чём построен - Minecraft 1.21.4 - Fabric Loader (>=0.16.9) - Fabric API (>=0.119.4) - Java 21

(наверх)

## Начало работы Чтобы использовать этот мод на своём сервере (или в одиночной игре), выполни следующие шаги. ### Требования - Сервер или клиент Minecraft 1.21.4 (если играешь в одиночной игре). - Fabric Loader 0.16.9 или выше. - Fabric API (обязателен на сервере; на клиенте не обязателен, но лишним не будет). ### Установка 1. Скачай мод
Скачай последний JAR-файл с Modrinth или GitHub Releases. 2. Помести мод
Положи JAR-файл в папку mods твоего сервера.
Для одиночной игры также положи его в папку mods клиента (он будет работать на встроенном сервере). 3. Запусти игру/сервер
Дополнительная настройка не нужна — мод заработает автоматически, а файл конфигурации будет создан по пути config/showmyitem.json.

(наверх)

## Использование ### Плейсхолдеры Мод поддерживает следующие плейсхолдеры, которые можно использовать прямо в чате (это английские версии плейсхолдеров; китайские плейсхолдеры смотри в китайской документации): | Плейсхолдер | Описание | | -------------- | ------------------------------------------------------------------------------------------------- | | [item] | Предмет в основной руке | | [offhand] | Предмет во второй руке | | [inventory] | Поделиться всем инвентарём (включая броню и вторую руку); создаёт кликабельную ссылку | | [enderchest] | Поделиться эндер-сундуком; создаёт кликабельную ссылку | >[!NOTE] > Плейсхолдеры не зависят от языка сервера. Ты можешь использовать эти английские плейсхолдеры в любой языковой среде. Если предпочитаешь китайский, можешь также использовать китайские аналоги [物品], [副手], [背包], [末影箱]. ### Базовое использование 1. Убедись, что держишь предмет в руке. 2. Напиши сообщение с плейсхолдерами, например: Зацени! [item] Мой инвентарь: [inventory] Мой эндер-сундук: [enderchest] 3. После отправки плейсхолдеры заменятся на названия предметов или кликабельные ссылки. 4. Другие игроки могут навести курсор на названия предметов, чтобы увидеть подсказки, или кликнуть по [Инвентарь игрока] / [Эндер-сундук игрока], чтобы открыть доступный только для чтения просмотр. ### Детали взаимодействия

• Наведение: При наведении на название предмета отображается его полная подсказка (зачарования, прочность, кастомное имя и т. д.).
• Клик по ссылкам инвентаря/эндер-сундука: Открывает безопасный контейнер только для чтения, показывающий основной инвентарь цели, броню, левую руку или эндер-сундук. Предметы нельзя перемещать или забирать, что предотвращает эксплойты с дублированием предметов.
• Разрешение: Только создатель снимка или операторы могут открыть ссылку; остальные получат сообщение об ошибке.

(наверх)

## Конфигурация Мод имеет чат-меню в стиле Carpet, доступное через команду /showmyitem. ### Команды | Команда | Описание | Разрешение | | ------------------------------------ | ---------------------------------- | ------------- | | /showmyitem | Показать все настройки и версию | Все | | `/showmyitem category | Показать настройки категории | Все | |/showmyitem find | Нечёткий поиск по настройкам | Все | |/showmyitem viewinv | Просмотреть снимок инвентаря | Создатель или OP | |/showmyitem viewender | Просмотреть снимок эндер-сундука | Создатель или OP | |/showmyitem set | Изменить параметр конфигурации | OP (уровень 2) | |/showmyitem reloadconfig | Перезагрузить конфигурацию из файла | OP (уровень 2) | ### Параметры конфигурации Файл конфигурации находится по путиconfig/showmyitem.json. Вы можете редактировать его напрямую или изменять значения в игре через меню/команды: - snapshotExpiryMs: Время истечения снимков в миллисекундах (по умолчанию 300000 = 5 минут). - maxSnapshots: Максимальное количество одновременно хранимых снимков (по умолчанию 100). - defaultLanguage: Язык сервера по умолчанию — en_usилиzh_cn. После редактирования используйте /showmyitem reloadconfig`, чтобы применить изменения без перезапуска.

(наверх)

## Планы - [x] Отображение предмета в основной руке ([item]) - [x] Отображение предмета в левой руке ([offhand]) - [x] Поделиться инвентарём с бронёй и левой рукой ([背包] / [inventory]) - [x] Поделиться эндер-сундуком ([末影箱] / [enderchest]) - [x] Архитектура только на стороне сервера - [x] Поддержка нескольких языков (английский / китайский) с автоопределением плейсхолдеров - [x] Меню конфигурации в стиле Carpet с кликабельными настройками - [x] Горячая перезагрузка конфигурации - [x] Безопасные контейнеры только для чтения для предотвращения дублирования предметов - [ ] Делиться большей информацией: здоровье, голод и т. д. - [ ] Поделиться блоком/сущностью под прицелом - [ ] Поддержка большего числа языков Полный список запрошенных функций и известных проблем смотрите в открытых задачах.

(наверх)

## Участие в разработке Вклад — это то, что делает сообщество открытого исходного кода таким удивительным местом для обучения, вдохновения и творчества. Любой ваш вклад высоко ценится. Если у вас есть предложение, как это улучшить, пожалуйста, форкните репозиторий и создайте pull request. Вы также можете просто открыть задачу с тегом "enhancement". Не забудьте поставить проекту звезду! Ещё раз спасибо! 1. Форкните проект 2. Создайте ветку для своей функции (git checkout -b feature/AmazingFeature) 3. Зафиксируйте изменения (git commit -m 'Add some AmazingFeature') 4. Отправьте в ветку (git push origin feature/AmazingFeature) 5. Откройте Pull Request

(наверх)

## Сборка - Запустите ./gradlew build для сборки мода. - Ремаппированный jar находится в build/libs/. - Отладочный jar находится в build/devlibs/ (не для распространения). ## Лицензия Распространяется под лицензией MIT. Подробнее смотрите в LICENSE.

(наверх)

## Контакты Ссылка на проект: https://github.com/PhantomPixel-0418/ShowMyItem

(наверх)

## Благодарности Этот шаблон README был вдохновлён: - Best-README-Template - Fabric Wiki

(наверх)