README_EN.md

🌍English / 中文

ChatImage

✨ Show Image In Minecraft Chat Line ✨

📖Docs · 🐛Submit Suggestion/Bug . ⬇️CurseForge · ⬇️Modrinth

Warning

Forge versions after 1.20.4 are no longer supported.

• ChatImage
  • Quick Start
  • Specification
  • Use Command to send [[CICode]]
  • Config Settings
  • Support input method
  • Support Image Type
  • Participating projects

Quick Start

Enter [[CICode,url=https://blog.kituin.fun/img/bg.png,name=Image]] Or ImageURL in the chat field

than it will transfer to image

support display GIF and local image

(image from 甘城なつき)

Specification

It use ChatImageCode ([[CICode,<arg>=<value>]])

ps: CICode used in version 1.0.2 and below has only 1 pair of [], 1.1.0 and above use 2 pairs of []

ps2: 1.1.9and above could use CQCode

Arg	Require	Type	Remark
url	true	String	Image address (please use file:/// for local files)
nsfw	false	boolean	Is it an nsfw image
name	false	String	The name displayed in the chat
pre	false	String	prefix(default:[)(can't be,)
suf	false	String	suffix(default:])(can't be,)

nsfw will determine whether to display the image directly

if it is set to true, you need to click to view it (or open the nsfw mode in the configuration file to view it directly)

Example

• Web Image [[CICode,url=<Web Url>,name=Image]]

  • example: [CICode,url=https://blog.kituin.fun/img/bg.png,name=Image]]

• Local Image [[CICode,url=file:///<absolute file path>,name=Image]]

  • example: [[CICode,url=file:///C:\blog\kituin\fun\img\bg.png,name=Image]]

Use Command to send [[CICode]]

/chatimage send <display name> <url>

Send CICode with display name and url

/chatimage url <url>

Send CICode with url (use default display name)

Config Settings

• manual configure
  • The configuration file is located at: .minecraft/conifg/fabric/chatimageconfig.json
  • After modifying the configuration file, please use /chatimage reload to reload the configuration file
• Use key binding (default End key)
• Use Mod Menu, click the configuration button to configure

Support input method

• Manual Input CICode
• Send CICode With Command
• Drag Image Into Chat Screen

Support Image Type

• png
• jpg/jpeg
• jfif
• gif
• ico
• bmp

Participating projects

• Environment Requirements
  • IntelliJ IDEA Ultimate (recommended 2023.2.7 and above)
  • ModMultiVersion-0.14.0 and above
  • JDK 21
• Init

    ./init.ps1