MineDown
1.0.0
MarkDown에서 영감을 받은 마크업을 사용하여 Minecraft 채팅 구성 요소를 작성하는 기능을 추가하는 라이브러리입니다!
이는 레거시 형식 지정 코드와 동일한 단순성으로 구성 요소 메시지의 모든 기능을 사용할 수 있는 기능을 추가하는 MarkDown을 대략적으로 기반으로 하는 사용자 정의 마크업 구문을 제공합니다. (여전히 지원 가능!) 또한 문자열 기반 및 구성 요소 기반 메시지 모두에서 자리 표시자를 직접 교체하는 방법도 포함되어 있습니다!
이를 위해서는 kyori-adventure 채팅 API가 필요하므로 이러한 메시지를 사용하려면 프로젝트에 플랫폼 라이브러리 중 하나를 제공해야 합니다! 간단한 구현을 위해 이 플러그인을 참조하세요.
| 설명 | 통사론 | 추가 정보 | 시사 |
|---|---|---|---|
| 컬러 레거시 | &6Text | 코드 서식 지정 | |
| 색상 | &gold&Text | 색상 이름 | |
| RGB 16진수 색상 | &#ff00ff&Text | 전체 16진수 형식 | |
| RGB 16진수 색상 | &#f0f&Text | 짧은 형식(긴 형식과 동일) | |
| 구배 | &#f0f-#fff&Text | 인라인 그래디언트 | |
| 무지개 | &rainbow&Text | 인라인 레인보우 | |
| 무지개 단계 | &rainbow:20&Text | 단계가 포함된 인라인 Rainbow | |
| 용감한 | **Text** | ||
| 이탤릭체 | ##Text## | ||
| 밑줄 | __Text__ | ||
| 취소선 | ~~Text~~ | ||
| 난독화됨 | ??Text?? |
일반적으로 사용되는 MarkDown 링크 구문을 사용하여 클릭 및 호버 이벤트를 정의할 수 있을 뿐만 아니라 이러한 방식으로 서식, 글꼴 및 색상을 지정할 수 있습니다.
| 설명 | 통사론 |
|---|---|
| 일반 구문 | [Text](text-color text-formatting... link hover text) |
| 단순 링크 | [Text](https://example.com) |
| 간단한 명령 | [Text](/command to run) |
| 링크 + 호버 | [Text](https://example.com Hover Text) |
| 텍스트 서식 | [Text](blue underline !bold) |
| 구배 | [Text](#fff-#000) |
| 무지개 | [Text](rainbow) |
| 단계적 무지개 | [Text](rainbow:20) |
| 텍스트 서식 + 링크 + 마우스오버 | [Text](#0000ff underline https://example.com Hover Text) |
| 설명 | 통사론 | 추가 정보 |
|---|---|---|
| 일반 구문 | [Text](action=value) | ClickEvent.Action, HoverEvent.Action |
| 링크 | [Text](open_url=https://example.com) | |
| 색상 | [Text](color=red) | 색상 이름 |
| RGB 16진수 색상 | [Text](color=#ff00ff) | 전체 16진수 형식 |
| RGB 16진수 색상 | [Text](color=#f0f) | 짧은 형식(긴 형식과 동일) |
| RGB 색상 그라데이션 | [Text](color=#fff-#000) | 두 가지 색상의 그라데이션입니다. (모든 색상 형태 지원) |
| RGB 색상 그라데이션 | [Text](color=#fff-#333-#222) | 세 가지 색상의 그라데이션입니다. |
| RGB 무지개 | [Text](color=rainbow) | RGB 무지개. |
| 단계별 RGB 무지개 | [Text](color=rainbow:50) | 특정 단계의 RGB 무지개. |
| 서식 지정 | [Text](format=underline,bold) | 서식 지정 |
| 서식 비활성화 | [Text](format=!underline) | !를 사용하여 특정 형식을 비활성화합니다. 접두사 |
| 세례반 | [Text](font=custom_font) | 리소스 팩에서 사용자 정의 글꼴 설정 |
| 명령 실행 | [Text](run_command=/command string) | 클릭 시 명령 실행 |
| 명령 제안 | [Text](suggest_command=/command) | 클릭 시 명령 제안 |
| 간단한 호버 | [Text](hover=Hover Text) | 마우스오버 텍스트 표시 |
| 호버 텍스트 | [Text](show_text=Hover Text) | 마우스오버 텍스트 표시 |
| 호버 엔터티 정보 | [Text](show_entity=uuid:pig Name) | 엔터티 정보를 표시합니다. |
| 마우스오버 항목 정보 | [Text](show_item=stone*2 nbt...) | 아이템 정보 표시, 추가 정보는 json에서 nbt 문자열로 제공되어야 합니다. |
| 삽입 | [Text](insert=insert into input) | Shift 클릭 시 입력에 삽입, 다른 이벤트와 결합 가능 |
모든 고급 설정은 이벤트 정의에 연결/포함될 수 있습니다. 그러나 여러 가지 색상을 추가하거나 클릭 및 마우스 오버 동작을 추가할 수는 없습니다!
라이브러리의 기본 API 액세스는 MineDown .class 및 해당 구문 분석 메서드를 통해 이루어집니다.
예를 들어 Bukkit 플러그인에서 다음과 같이 사용할 수 있습니다.
BukkitAudiences . create ( plugin ). player ( player ). sendMessage ( new MineDown ( rawMessage ). replace ( replacements ). toComponent ());또는 정적 접근 방식을 사용합니다.
BukkitAudiences . create ( plugin ). player ( player ). sendMessage ( MineDown . parse ( rawMessage , replacements ));라이브러리 및 포함된 클래스에 대한 자세한 정보는 MineDown JavaDocs를 살펴보세요.
Maven을 사용하면 이 라이브러리를 플러그인에 쉽게 포함할 수 있습니다. 플러그인 패키지로 재배치하세요!
< repositories >
< repository >
< id >minebench-repo</ id >
< url >https://repo.minebench.de/</ url >
</ repository >
</ repositories >< dependencies >
< dependency >
< groupId >de.themoep</ groupId >
< artifactId > MineDown -adventure</ artifactId >
< version >1.7.3-SNAPSHOT</ version >
< scope >compile</ scope >
</ dependency >
</ dependencies > 원래 BungeeCord-chat 라이브러리는 더 이상 유지 관리되지 않으며 이 모험 구현으로 대체되었습니다. 레거시 버전( legacy 브랜치에 있음)을 계속 사용해야 하는 경우 다음과 같이 포함할 수 있습니다.
< dependencies >
< dependency >
< groupId >de.themoep</ groupId >
< artifactId > MineDown </ artifactId >
< version >1.7.1-SNAPSHOT</ version >
< scope >compile</ scope >
</ dependency >
</ dependencies >< build >
< plugins >
< plugin >
< artifactId >maven-shade-plugin</ artifactId >
< version >3.1.0</ version >
< configuration >
< relocations >
< relocation >
< pattern >de.themoep. MineDown </ pattern >
< shadedPattern >your.package.path.libraries. MineDown </ shadedPattern >
</ relocation >
</ relocations >
</ configuration >
< executions >
< execution >
< phase >package</ phase >
< goals >
< goal >shade</ goal >
</ goals >
</ execution >
</ executions >
</ plugin >
</ plugins >
</ build >또는 이 라이브러리의 음영 처리 대신 내 MineDown 플러그인을 직접 사용할 수도 있습니다! MineDown 플러그인에는 이 라이브러리의 재배치되지 않은 버전이 포함되어 있습니다.
MineDown MIT 오픈 소스 라이선스에 따라 라이선스가 부여됩니다.
Copyright (c) 2024 Max Lee (https://github.com/Phoenix616)
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.
