Conceptual overview of chat components
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
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 https://github.com/KyoriPowered/adventure-docs/issues/49
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No target file or test is named. Start with the proposed outline and its linked component-history references; done means a published conceptual overview explaining components, styling, history, and examples with the suggested graphics or comparisons.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100