Skip to content

Notice ​

The official server is not public

The server side of TYW Launcher is not distributed: the source is closed, and there is no binary, deployment package or setup guide. If you want your own distribution service, you have to build it yourself.

What this means ​

  • Clients downloaded from the official site work as-is: they point at the server the project runs, and notices / updates / beta access come from there.
  • If you want to publish your own notices, push your own updates or hand out your own beta keys, you need to write your own server. No ready-made program is provided.
  • If you don't need online features, do nothing: with no server address configured the client simply runs offline. You lose notices and online updates; everything else is local.

The client only needs one address ​

To wire up your own server, the client resolves a single HTTP base URL in this order:

text
setting ServerUrl
  > TYW_SERVER environment variable
  > server.txt next to the binary / in the data directory
  > compile-time constant (written only into official builds, empty in open-source builds)

If none resolves, the client treats itself as offline: no error dialog, no report, just a hint in the bottom-left corner. What your server returns is entirely up to you.

If you build your own ​

There are only three kinds of work, and the shape is up to you (PHP, Go, Node, .NET — even a static file server covers part of it):

CapabilityRough shape
NoticesReturn a piece of text per channel; the client shows it once
Version distributionReturn a version number and a download URL per platform / architecture / channel
Beta keys / bans (optional)Validate a device code and beta key, or refuse specific devices

The official protocol is not published

The list above is only a functional breakdown. Field names, paths and authentication belong to the official implementation and are not documented; when self-hosting, design your own and patch the client accordingly (the client is open source).

Disclaimer ​

  • Accounts, data and security issues caused by a third-party server are not the project's responsibility.
  • The official client is distributed only through tml.tywmc.cn. Treat other sources with care.