Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kituin/chatimage

A Minecraft Mod Which Could Show Image In Chat Line
https://github.com/kituin/chatimage

fabric-mod farbic forge forge-mod minecraft mod neoforge neoforge-mod

Last synced: 3 months ago
JSON representation

A Minecraft Mod Which Could Show Image In Chat Line

Host: GitHub
URL: https://github.com/kituin/chatimage
Owner: kitUIN
Created: 2023-01-21T09:40:28.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-09-30T09:49:00.000Z (3 months ago)
Last Synced: 2024-10-01T08:21:34.302Z (3 months ago)
Topics: fabric-mod, farbic, forge, forge-mod, minecraft, mod, neoforge, neoforge-mod
Language: Java
Homepage: https://chatimage.kituin.fun
Size: 5.93 MB
Stars: 33
Watchers: 3
Forks: 5
Open Issues: 13
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        


🌍English / 中文





  





# ChatImage

✨ 在Minecraft聊天栏中显示图片 ✨





  

    

  

  

    

  

  

    

  

  

    

  

  

    

  





  📖文档

  ·

  🐛提交建议

  ·

  ⬇️CurseForge

  ·

  ⬇️MC百科

  ·

  ⬇️Modrinth



* [ChatImage](#chatimage)

  * [快速开始](#快速开始)

  * [规范](#规范)

  * [使用命令发送 [[CICode]]](#使用命令发送-cicode)

  * [配置文件设置](#配置文件设置)

  * [支持方法](#支持方法)

  * [支持格式](#支持格式)

  * [参与项目](#参与项目)

## 快速开始

聊天框输入 `[[CICode,url=https://blog.kituin.fun/img/bg.png,name=Image]]` 或者图片链接  即可自动转换为图片  

支持显示GIF,本地图片

![quick](https://github.com/kitUIN/ChatImage/assets/68675068/e2007819-850f-4a0d-b0e1-6ea2541c8704)

(图片来自画师[甘城なつき](https://www.pixiv.net/users/3036679))

## 规范

本项目使用 [ChatImageCode](https://chatimage.kituin.fun/wiki/chatimage/code) (`[[CICode,=]]`)

| 参数                                                             | 必须 | 类型      | 备注                    |

|----------------------------------------------------------------|----|---------|-----------------------|

| [url](https://chatimage.kituin.fun/wiki/chatimage/code/#url)   | 是  | String  | 图片地址(本地文件请使用file:///) |

| [nsfw](https://chatimage.kituin.fun/wiki/chatimage/code/#nsfw) | 否  | boolean | 是否为nsfw图像             |

| [name](https://chatimage.kituin.fun/wiki/chatimage/code/#name) | 否  | String  | 在消息栏显示的名称             |

| pre                                                            | 否  | String  | 前缀(默认`[`)(不能为,)       |

| suf                                                            | 否  | String  | 后缀(默认`]`)(不能为,)       |

- 网络图片 `[[CICode,url=<网络地址>,name=Image]]`

    - 示例: `[[CICode,url=https://blog.kituin.fun/img/bg.png,name=Image]]`

- 本地图片 `[[CICode,url=file:///<绝对路径>,name=Image]]`

    - 示例: `[[CICode,url=file:///C:\blog\kituin\fun\img\bg.png,name=Image]]`

`nsfw`将决定是否直接显示图片,如果设为`true`,则需要点击才能查看(或者配置文件中开启nsfw模式直接查看)

![nsfw](https://github.com/kitUIN/ChatImage/assets/68675068/33a3531a-0b92-48d3-bcc7-a76907a19979)

![nsfw2](https://github.com/kitUIN/ChatImage/assets/68675068/8f5fd75c-75d5-4550-ab13-e51d361276b6)

## 使用命令发送 [[CICode]]

`/chatimage send  `

使用显示名称与Url发送CICode

`/chatimage url `

使用Url发送CICode(使用默认显示名称)

## 配置文件设置

- 手动配置

    - 配置文件位于：`.minecraft/conifg/fabric/chatimageconfig.json`

    - 修改配置文件后，请使用 `/chatimage reload` 重载配置文件

- 使用按键（默认为`End`键）

- 使用[Mod Menu](https://github.com/TerraformersMC/ModMenu)，点击配置按钮进行配置

## 支持方法

- [X]  手动输入`CICode`

- [x]  使用命令发送`CICode`

- [x]  图片拖拽进聊天栏

## 支持格式

- [X] png

- [X] jpg/jpeg

- [X] jfif

- [X] gif

- [X] ico

- [X] bmp

## 参与项目

- 环境要求

  - IntelliJ IDEA Ultimate(建议2023.2.7及以上)

  - [ModMultiVersion-0.14.0](https://plugins.jetbrains.com/plugin/24872-modmultiversion)及以上

  - JDK 21

- 初始化项目

  ```bash

    ./init.ps1

  ```