-
-
Notifications
You must be signed in to change notification settings - Fork 208
Open
Labels
dev guideThis issue or PR aims to introduce developer API documentationThis issue or PR aims to introduce developer API documentationmeta guideThis issue or PR aims to introduce in-depth ways to work with codeThis issue or PR aims to introduce in-depth ways to work with codeproject: Adventurestatus: acceptedThis issue has been acceptedThis issue has been accepted
Description
It seems like there is a big gap in understanding with a lot of users new to adventure, who have trouble with the concepts of chat components, having only been familiar with the legacy section-symbol system. It would be helpful to explain what components are and some of their key characteristics, ideally with some graphics. Here's a rough outline of what I'm imagining:
- What is a component?
- structured representation: the text form represents the data structure, rather than being marked-up text
- different types of content
- tree structure: see style
- appending: children in the tree (visual here?)
- Where did components come from?/Why do we want to use components?
- history: 1.7.2 introduction, 1.13 most of the server converted to use them, 1.16 client text renderer converted
- originally: a way to be more explicit about links and other rich styling
- references:
- examples of quirks/limitations of legacy text, and how chat components resolve those issues
- Style in components
- tree style
- [visual] show a component tree with styles, show how they're inherited, and piecewise overridden
- attributes can exist together, no 'magical' reseting like legacy strings had
- more attributes can be added -- see
fontor RGB colour
- Examples
- Some side-by-side tables of json, adventure representation, and in-game visuals?
- History of components (can it be merged with 2?)
- version-by-version breakdown of what has been added/changed
Migrated from KyoriPowered/adventure-docs#49
Metadata
Metadata
Assignees
Labels
dev guideThis issue or PR aims to introduce developer API documentationThis issue or PR aims to introduce developer API documentationmeta guideThis issue or PR aims to introduce in-depth ways to work with codeThis issue or PR aims to introduce in-depth ways to work with codeproject: Adventurestatus: acceptedThis issue has been acceptedThis issue has been accepted