Skip to content

Commit 39c9309

Browse files
Client brand docs (#7)
1 parent 899db68 commit 39c9309

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

_meta.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
{
22
"index": "Introduction",
33
"maven-repository": "Maven Repository",
4-
"deep-links": "Deep Links"
5-
}
4+
"apollo": "Apollo",
5+
"server-mappings": "Server Mappings",
6+
"deep-links": "Deep Links",
7+
"client-brand": "Client Brand"
8+
}

client-brand.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import { Callout, Tab, Tabs } from 'nextra-theme-docs';
2+
3+
# Client Brand
4+
5+
Lunar Client can be detected by checking the Minecraft client brand sent to the server. This allows you to detect and track Lunar Client players, if you're unable to use the full
6+
[Apollo](/apollo/introduction) integration.
7+
8+
<Callout type="warning" emoji="⚠️">
9+
This is not a cryptographically secure detection method. Malicious clients can spoof the client brand sent to the server.
10+
</Callout>
11+
12+
## Brand Format
13+
14+
The client brand will always be in the format `lunarclient:<VERSION>`. `<VERSION>` is the Lunar Client build that the user is running. See the next section for info about the
15+
version format.
16+
17+
## Version Format
18+
19+
We do not provide any guarantees about the exact format of the version, and it may change without notice. An unexpected version format does not mean that a user is running an
20+
unofficial build of Lunar Client. The version will be visible on the Minecraft F3 menu, and in the window title, in addition to being present in the client brand.
21+
22+
Most, but not all, users will have a version in the format of `v<MAJOR>.<MINOR>.<PATCH>-<RELEASE YEAR><RELEASE WEEK>`. For example, `v2.12.0-2349` is version `v2.12.0`, which
23+
was built in the 49th week of 2023.

0 commit comments

Comments
 (0)