Skip to content

Commit

Permalink
[CI-SKIP] Update readme and details in pom
Browse files Browse the repository at this point in the history
  • Loading branch information
@Phoenix616
Phoenix616 committed Jun 18, 2024
1 parent 7b8163a commit 3d0ac7c
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 20 deletions.
53 changes: 33 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@ It also includes a way to directly replace placeholders in the messages, both st

This requires the [kyori-adventure](https://github.com/KyoriPowered/adventure) chat API so you need to provide one of
the [platform libraries](https://github.com/KyoriPowered/adventure-platform) in your project in order to use these
messages! See [this plugin](https://github.com/Phoenix616/MineDownPlugin/tree/kyori-adventure) for a simple implementation.
messages! See [this plugin](https://github.com/Phoenix616/MineDownPlugin/) for a simple implementation.

## Syntax

### Inline Formatting
Description | Syntax | More Info | Preview
--------------|--------------------|-----------------------------------------------------------------------|-------------------------------------------
Color legacy |` &6Text `| [Formatting codes](https://minecraft.gamepedia.com/Formatting_codes) | ![](https://i.phoenix616.dev/gbJYVeql.png)
Color |` &gold&Text `| [Color names](https://minecraft.gamepedia.com/Formatting_codes) | ![](https://i.phoenix616.dev/gfgApGrn.png)
RGB Hex Color |` &#ff00ff&Text `| Full hexadecimal format | ![](https://i.phoenix616.dev/glFV9zgw.png)
RGB Hex Color |` &#f0f&Text `| Short format (equivalent to long one) | ![](https://i.phoenix616.dev/gojZlSaN.png)
Gradient |` &#f0f-#fff&Text `| Inline gradients | ![](https://i.phoenix616.dev/giOQuXV6.png)
Rainbow |` &rainbow&Text `| Inline Rainbow | ![](https://i.phoenix616.dev/ggYaEWZt.png)
Rainbow Phase |` &rainbow:20&Text `| Inline Rainbow with a phase | ![](https://i.phoenix616.dev/gojDf1ZM.png)
Bold |` **Text** `| | ![](https://i.phoenix616.dev/fYDs0soW.png)
Italic |` ##Text## `| | ![](https://i.phoenix616.dev/gaLmjWZA.png)
Underlined |` __Text__ `| | ![](https://i.phoenix616.dev/gk6lbR0B.png)
Strikethrough |` ~~Text~~ `| | ![](https://i.phoenix616.dev/gpc5zBr4.png)
Obfuscated |` ??Text?? `| | ![](https://i.phoenix616.dev/giRU4C9u.gif)
Description | Syntax | More Info | Preview
--------------|--------------------|---------------------------------------------------------------|-------------------------------------------
Color legacy |` &6Text `| [Formatting codes](https://minecraft.wiki/w/Formatting_codes) | ![](https://i.phoenix616.dev/gbJYVeql.png)
Color |` &gold&Text `| [Color names](https://minecraft.wiki/w/Formatting_codes) | ![](https://i.phoenix616.dev/gfgApGrn.png)
RGB Hex Color |` &#ff00ff&Text `| Full hexadecimal format | ![](https://i.phoenix616.dev/glFV9zgw.png)
RGB Hex Color |` &#f0f&Text `| Short format (equivalent to long one) | ![](https://i.phoenix616.dev/gojZlSaN.png)
Gradient |` &#f0f-#fff&Text `| Inline gradients | ![](https://i.phoenix616.dev/giOQuXV6.png)
Rainbow |` &rainbow&Text `| Inline Rainbow | ![](https://i.phoenix616.dev/ggYaEWZt.png)
Rainbow Phase |` &rainbow:20&Text `| Inline Rainbow with a phase | ![](https://i.phoenix616.dev/gojDf1ZM.png)
Bold |` **Text** `| | ![](https://i.phoenix616.dev/fYDs0soW.png)
Italic |` ##Text## `| | ![](https://i.phoenix616.dev/gaLmjWZA.png)
Underlined |` __Text__ `| | ![](https://i.phoenix616.dev/gk6lbR0B.png)
Strikethrough |` ~~Text~~ `| | ![](https://i.phoenix616.dev/gpc5zBr4.png)
Obfuscated |` ??Text?? `| | ![](https://i.phoenix616.dev/giRU4C9u.gif)

### Events ###
You can define click and hover events with the commonly used MarkDown link syntax
Expand All @@ -46,11 +46,11 @@ as well as specify formatting, font and colors that way.


#### Advanced Syntax
Description | Syntax | More Info
-------------------|--------------------------------------------|----
General syntax |` [Text](action=value) `|[ClickEvent.Action](https://github.com/KyoriPowered/adventure/blob/master/api/src/main/java/net/kyori/adventure/text/event/ClickEvent.java#L196-L222), [HoverEvent.Action](https://github.com/KyoriPowered/adventure/blob/master/api/src/main/java/net/kyori/adventure/text/event/HoverEvent.java#L311-L339)
Description | Syntax | More Info
-------------------|----------------------------------------|----
General syntax |` [Text](action=value) `|[ClickEvent.Action](https://github.com/KyoriPowered/adventure/blob/master/api/src/main/java/net/kyori/adventure/text/event/ClickEvent.java#L196-L222), [HoverEvent.Action](https://github.com/KyoriPowered/adventure/blob/master/api/src/main/java/net/kyori/adventure/text/event/HoverEvent.java#L311-L339)
Link |` [Text](open_url=https://example.com) `|
Color |` [Text](color=red) `|
Color |` [Text](color=red) `| [Color names](https://minecraft.wiki/w/Formatting_codes)
RGB Hex Color |` [Text](color=#ff00ff) `| Full hexadecimal format
RGB Hex Color |` [Text](color=#f0f) `| Short format (equivalent to long one)
RGB Color Gradient |` [Text](color=#fff-#000) `| Gradient of two colors. (Supports all color forms)
Expand Down Expand Up @@ -106,6 +106,19 @@ Make sure to relocate it into your plugin's package!
<dependency>
<groupId>de.themoep</groupId>
<artifactId>minedown-adventure</artifactId>
<version>1.7.3-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
</dependencies>
```

##### Legacy BungeeCord-chat library
The original BungeeCord-chat library is no longer maintained and has been replaced by this adventure implementation. If you need to still use the legacy version (found on the `legacy` branch), you can include it like this:
```xml
<dependencies>
<dependency>
<groupId>de.themoep</groupId>
<artifactId>minedown</artifactId>
<version>1.7.1-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
Expand Down Expand Up @@ -149,7 +162,7 @@ instead of shading in this library! MineDownPlugin includes a non-relocated vers
MineDown is licensed under the MIT open source license:

```
Copyright (c) 2017 Max Lee (https://github.com/Phoenix616)
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
Expand Down
38 changes: 38 additions & 0 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,44 @@

<description>A MarkDown inspired markup library for Minecraft chat components</description>

<licenses>
<license>
<name>MIT License</name>
<url>https://phoenix616.dev/licenses/mit</url>
<distribution>repo</distribution>
<comments>A permissive free software license</comments>
</license>
</licenses>

<issueManagement>
<system>GitHub</system>
<url>https://github.com/Phoenix616/MineDown/issues</url>
</issueManagement>

<developers>
<developer>
<id>phoenix616</id>
<name>Max Lee</name>
<email>max@themoep.de</email>
<url>https://phoenix616.dev</url>
<organization>Minebench</organization>
<organizationUrl>https://minebench.de</organizationUrl>
<roles>
<role>lead</role>
<role>developer</role>
</roles>
<timezone>UTC+01:00</timezone>
<properties>
<avatar>https://phoenix616.dev/favicon.ico</avatar>
<github>Phoenix616</github>
<fediverse>https://crafter.social/@phoenix616</fediverse>
<mastodon>https://mastodon.de/@the_moep</mastodon>
<matrix>@Moep:matrix.org</matrix>
<donate>https://tip.phoenix616.dev</donate>
</properties>
</developer>
</developers>

<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
Expand Down

0 comments on commit 3d0ac7c

Please sign in to comment.