You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/adventure/platform/implementing.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,14 @@ Most users will be here to look at information about existing platform implement
7
7
8
8
While at its core Adventure 'just' provides data structures and serializers, as the game evolves and more functionality is added there are more tunable options and platform hooks
9
9
necessary to produce the correct output for the applicable game version. This has led to the introduction of a variety of services that platforms can provide implementations of using
10
-
Java's `ServiceLoader` mechanism. Some other behaviours are expected by convention. As there are not that many platforms that integrate with Adventure, this page is an attempt to
10
+
Java's `ServiceLoader` mechanism. Some other behaviors are expected by convention. As there are not that many platforms that integrate with Adventure, this page is an attempt to
11
11
cover the common points. Please don't be afraid to ask us questions, and together we can work on fleshing out this page.
12
12
13
13
## Services
14
14
15
15
### `ComponentSerializer` Services
16
16
17
-
Most of the serializers (Gson, legacy, etc.) have `Provider` SPI's that allow customizing the default behaviours of serializers. These are most applicable for the Gson/other JSON
17
+
Most of the serializers (Gson, legacy, etc.) have `Provider` SPI's that allow customizing the default behaviors of serializers. These are most applicable for the Gson/other JSON
18
18
serializers where the data structures have changed over time, but the legacy serializer's options can be worth referencing too. See the Javadoc for each serializer for more information.
19
19
20
20
For any `JSONComponentSerializer` subtype, we have tried to gather relevant tunable options within a single system, keyed by the game's active
@@ -44,14 +44,14 @@ callback command is requested. The platform is responsible for ensuring any exec
44
44
v1 and v2). Platforms are responsible for providing the adapter that looks up the appropriate logger by name and serializes components to text.
45
45
46
46
This should involve performing any translations if necessary. The default behaviour of the logger is to serialize to plain text, but platforms may want to look at the
47
-
`/serializer/ansi` serializer instead for coloured output.
47
+
`/serializer/ansi` serializer instead for colored output.
48
48
49
49
### Boss Bars
50
50
51
51
Boss bars are logistically somewhat complicated. As one of the few holders of mutable state in the library, they have to re-sync any state changes to their viewers.
52
52
In order to track viewers and link up to any internal state, the `BossBarImplementation.Provider` SPI allows platforms to provide their own implementation hooks per-bar.
53
53
54
-
## Conventional Behaviours
54
+
## Conventional behaviors
55
55
56
56
Some behaviours are expected by platforms beyond what is explicitly required by implementing certain interfaces. These are:
0 commit comments