/YS-Compass

(UNFINISHED) A desktop application for managing and interacting with Yuan Shen (Genshin Impact).

Primary LanguageTypeScript

YS-Compass

A desktop application for managing and interacting with Yuan Shen (Genshin Impact).

Features

  • Data Export
  • Game Management
    • Inventory filtering
  • Sandbox Mode
    • Add/remove items
    • Change item quantity
    • Modify artifact stats
  • Developer Features
    • High-level game/server inspector
    • Packet sniffer
    • Runtime definition dumper & deobfuscator

For Developers

Building

Run the following commands to build the application:

bun install
tauri build

This requires:

YSP Format

YSP stands for Yuan Shen Protocol, and is a GRPC-based protocol for interacting with servers.
It is currently implemented in Open Shen.

Note

See the YSP Protobuf Definition for information.

Technologies

This is an HTML5-based application using the following technologies:

TypeScript Path Aliases

  • @app -> ./src
  • @components -> ./src/ui/components (for general components)
  • @pages -> ./src/ui/pages (for general components)
  • @hooks -> ./src/hooks
  • @stores -> ./src/stores (for Zustand stores)
  • @backend -> ./src/backend (for any backend code)
  • @css -> ./src/ui/css (for global css)

License

  • This project is distributed under the MIT license.
  • This project uses third-party libraries and other resources that may be distributed under other licenses.

All rights reserved by © Cognosphere Pte. Ltd. This project is not affiliated with nor endorsed by HoYoverse. Genshin Impact™ and other properties belong to their respective owners.