Preface
This manual is for everyone who uses YiLink: host owners, browser clients, Gamespace players, and Gamespace operators.
About the screenshots: the UI screenshots show the Chinese build. English UI labels are written in bold in the text; the layout and behaviour are identical.
Who this manual is for
| Role | What you use | Read |
|---|---|---|
| Host owner | Windows host service, local_settings.html |
Chapters 1, 2, 7 |
| Client user | Dashboard, remote session, anonymous room | Chapters 1–5 |
| Gamespace player | Game library, detail page, trial page, vendor space | Chapter 8 |
| Gamespace operator / tenant | admin-ops console |
Chapter 9 |
| Everyone | Membership, CDKey, troubleshooting | Chapters 6, 10, 11 |
Document map
| Chapter | Content | Main pages |
|---|---|---|
| 01 Quick start | Three entry paths, five-minute setup | All |
| 02 Account and sign-in | Registration, sign-in, QR, third-party accounts, user center | login.html, user center |
| 03 Dashboard | Host cards, system settings, tools | dashboard.html |
| 04 Remote session | Control bar, video, input, clipboard, file transfer | remote.html |
| 05 Anonymous room | Share links, approval, lifetime | room.html |
| 06 Membership and billing | Plans, CDKey, invoices, billing | User center, billing.html |
| 07 Host service | Overview, config, TURN, rooms, Gamespace | local_settings.html |
| 08 Gamespace player | Library, detail, trial, vendor pages | Public gs pages |
| 09 Gamespace console | Games/Hosts/Campaigns/Sessions/Edges | admin-ops/customer |
| 10 Troubleshooting | Connection, black screen, lag, trial failures | All |
| 11 Appendix | Glossary, page index, quick reference, version history | — |
Conventions
→means a click path, for example Hosts → Settings.- "Host" means the controlled Windows PC. "Client" means the browser you are using.
- "Anonymous room" means a session joined by share link without an account. "Logged-in mode" means connecting from the dashboard after signing in.
- UI labels are shown in bold. Prices, quotas, and defaults are examples from the current build; the page is authoritative.
- Account names, IP addresses, and host UUIDs in screenshots are masked. Example values are not production data.
YiLink at a glance
Host service (Windows, background)
│ main service + signaling (auto reconnect)
▼
YiLink cloud: SSO / signaling / TURN / Gamespace
│
├── Client browser: dashboard → remote session (WebRTC P2P, automatic TURN fallback)
├── Anonymous guest: share link → room page → host approval
└── Gamespace player: game library → trial page (edge node)
Feedback and revisions
- The Help link in the dashboard points to the public manual page; this directory is the maintainable source.
- If the UI and this manual disagree, the live page and the
pAGENTS.mdfiles inweb-client/andgamespace-server/win. - See 11 Appendix for the screenshot list.
- The Chinese edition is the source of truth; this English edition follows the same structure and figure numbers.
01 Quick start
This chapter gets you through the first remote connection in five minutes. Detailed configuration is covered later.
1.1 Choose the right entry path
YiLink has three entry paths. Pick the right one first:
| Path | Best for | Entry | Account required | Shared content | Host approval |
|---|---|---|---|---|---|
| Anonymous room | Temporarily sharing a PC with a friend or client | Host tray menu / settings page → share link | No | Full desktop (monitor switching supported) or a specific app | First time only |
| Logged-in mode | Your own PCs, long-term use | https://z.mycloudgame.com/login.html |
Yes | Full desktop only | No |
| Gamespace trial | Players trying published games | https://gs.mycloudgame.com/public/games |
No | Specific game/app only | No (depends on campaign/host state) |
All three paths end in the same remote session page (
remote.html) with the same control bar and input support. They differ in what is shared and whether an account or approval is needed.
1.2 Path A: anonymous room (fastest)
On the host
- Make sure the host service is running and the tray icon is present.
- Right-click the tray icon. The menu can Open settings or Create anonymous shared desktop (full desktop).
- To share only one app or game, open the settings page → Room management → select the app/game → Create shared room.
- Copy the room link (for example
https://z.mycloudgame.com/room.html?room=xxxxxxxx).
On the client
- Open the link. The page shows the host name, connection count, NAT types, and a countdown.
- Optionally enter a note, then click Request connection.
- The host receives the request; once approved, the desktop appears.
An anonymous room lives for at most 8 days. If the host stays offline for 24 consecutive hours, the room is released early. The countdown on the room page is authoritative.
1.3 Path B: logged-in mode (recommended)
- Open
https://z.mycloudgame.com/login.html. If you do not have an account, click Register first and complete email registration (email + password + confirmation; Solo code optional). - Sign in with the registered email and password. You can also use Google / Steam (first sign-in creates the account automatically).
- Wait for the host cards to appear on the dashboard.
- Click the blue Connect button in the middle of a host card.
- A remote session tab opens; the desktop appears within a few seconds.
Logged-in mode does not require per-connection host approval. It is the right choice for your own PCs.
Figure 1-1 Dashboard: host cards on the left, quick connect at the bottom, account and language switcher at top right.
1.4 Path C: Gamespace trial
- Open
https://gs.mycloudgame.com/public/games. - Click Play now on a card (when a host is online) or Details to read more.
- The trial page shows: connecting to server → establishing video → trial ready.
- When the trial ends, the end page can redirect to the store or let you stay.
1.5 Pre-flight checklist
1.6 What normal looks like
| What you see | Meaning |
|---|---|
| Picture starts blurry, then sharpens | Waiting for a keyframe; bitrate adaptation |
| Mouse briefly out of sync | Data channel is being established |
| "Connection lost, reconnecting" | Network jitter; the client retries automatically |
| Anonymous room waits for host approval | Safety design against unknown visitors |
| Host is locked | Installed build can still sign in; locked is not offline |
| Control bar is hidden | Move the mouse to the left edge and click the green circle |
1.7 Where to go next
- Video, frame rate, multi-monitor → 04 Remote session
- Host service, TURN, auto-start → 07 Host service
- Publishing games and reading trial data → 09 Gamespace console
- Cannot connect → 10 Troubleshooting
02 Account and sign-in
YiLink accounts are provided by the SSO service. The dashboard, membership, CDKey, and Gamespace console all use the same account; the host service signs in with it too.
2.1 Registration
Email sign-in requires an existing account. Google and Steam create an account automatically on first sign-in. The email registration entry is on the login page:
- Open
https://z.mycloudgame.com/login.html. - Click Register (or open
login.html?show=register). - Enter email, password, and password confirmation. A Solo code is optional.
- Accept the Terms of Service and Privacy Policy, then click Register.
- Complete email verification when prompted (a verified email is required for purchases and redemption), then return to sign in.
There are three registration methods:
| Method | Description |
|---|---|
| Email + password. Password recovery, invoices, and notifications use this address | |
| First Google sign-in creates the account and uses the Google email | |
| Steam | First Steam sign-in creates the account. Steam does not return an email, so you must link one later |
Notes:
mycloudgame.com(international) andmycloudgame.cn(China) are separate deployments. Accounts do not carry over; register on each site you use.- Paying users must have an email. A Steam-only account cannot complete billing flows.
- Use a password manager; do not reuse your YiLink password elsewhere.
2.2 Password sign-in
Figure 2-1 Login page: email + password, remember me, QR sign-in, and third-party accounts.
| Control | Description |
|---|---|
| Registered email address | |
| Password | Case-sensitive |
| Remember me | Keeps you signed in on this browser; do not enable on shared PCs |
| Forgot password? | Email-based recovery |
| Sign in | Goes to the dashboard on success |
Common messages:
- Wrong email or password: check for stray
spaces and confirm whether you are on
.comor.cn. - Account locked / repeated failures: wait and retry, or use password recovery.
- Signed in but no hosts: the host is not signed in with the same account, or it is offline (see 7.3).
2.3 QR sign-in
Useful on TVs, tablets, and meeting-room devices where typing a password is awkward.
- On the login page, click Sign in with QR code.
- Scan the QR code with a phone that is already signed in.
- Confirm on the phone; the browser signs in automatically.
QR codes expire; refresh the page to generate a new one.
2.4 Third-party accounts
The login page offers:
- Steam
The first third-party sign-in creates an account automatically (it is not a separate "register then bind" flow):
- Google: uses the Google account email; this is the most complete setup.
- Steam: Steam does not return an email. After the first sign-in, link an email in User center → Sign-in methods. This is required before payment.
You can also bind Google / Steam to an existing email account in User center → Sign-in methods.
Figure 2-2 User center → Sign-in methods: primary email plus Google/Steam binding.
Keep email + password sign-in available even after binding a third party, so you can still get in if that provider is unavailable.
2.5 User center
Click your email address at the right side of the navigation bar to open the User center. It has three tabs:
Overview
Figure 2-3 User center → Overview.
| Field | Description |
|---|---|
| User ID | Internal SSO ID; include it in support requests |
| Sign-in email | |
| Current tier | Free / Starter / Pro / Admin, etc. |
| Submit feedback | Opens the feedback form; screenshots can be attached |
Membership and billing
See 06 Membership and billing.
Sign-in methods
- Shows the primary email.
- Google / Steam show Linked or Not linked; the button on the right binds or unbinds.
2.6 Sign out
Click Sign out at the top right. After signing out:
- The dashboard returns to the signed-out state and host cards are hidden.
- Session tokens stored in this browser are cleared.
- Anonymous room links are unaffected (they do not depend on your account).
On a shared PC, also clear the site data after signing out.
2.7 Multiple accounts
Some builds can keep sessions for more than one account in the same browser. To switch:
- Use the account switcher in the user menu (if available), or sign out and sign in with the other account.
- The dashboard reloads hosts for the new account.
- Remote-session settings (resolution, bitrate, etc.) are stored per account + host and do not leak between accounts.
2.8 Account security
- This build does not provide two-factor authentication. Use a password manager and keep the password safe.
- Do not share screenshots of a signed-in dashboard; sign out or mask the account area first.
- The account signed in on the host is the account that can see that host. Sign out on the host when transferring a device.
- If you notice unusual sign-ins, change the password and review third-party bindings in the user center.
03 Dashboard
The dashboard is the main screen after signing in: see hosts, connect, change default video settings, and open tools or Gamespace.
https://z.mycloudgame.com/dashboard.html
It can be opened while signed out, but only the sign-in/register entry is shown.
3.1 Layout
Figure 3-1 Dashboard. The example account is an admin; normal accounts do not show the Admin menu.
Top to bottom, left to right:
- Top navigation: Hosts / Settings / User / Tools / Gamespace / Help.
- Top right: signed-in email, language switch (EN / 中文), sign out.
- Host area: one card per online host.
- Bottom: quick-connect input and button; build version at bottom right.
3.2 Host cards
Each card represents a host that is signed in with the same account and online.
| Element | Position | Purpose |
|---|---|---|
| Host name | Top left | Name configured on the host (for example
GAMEHOST) |
| Background | Middle | A fixed decorative image, not a live thumbnail |
| Game list | First top-right button | View the game list reported by the host |
| Power | Second top-right button | Sleep / hibernate / restart / shut down / restart app |
| Settings | Gear icon | Open streaming settings for this host |
| Connect | Blue circle in the middle | Start a remote session |
| NAT / IPv4 | Bottom of the card | Network type and public address for diagnostics (TURN is automatic) |
Selecting a card: click the card body to highlight it; click again to clear. Selection does not affect connection.
3.2.1 Game list
Click Game list to open a dialog with games reported by the host. Sync rules:
- Game list sync is off by default and must be enabled on the host.
- Only the fixed Steam / Epic directories are scanned; there is no full-disk scan.
- Games outside those libraries do not appear.
If the list is empty, check the sync switch and whether the game is in a Steam/Epic library.
3.2.2 Power menu
Figure 3-2 Host card → Power.
| Item | Description |
|---|---|
| Sleep | Network drops; wake with WOL or locally |
| Hibernate | Writes memory to disk; slower wake |
| Restart | Normal restart |
| Shut down | Normal shutdown |
| Restart app | Restarts only the host app, not Windows |
After a remote shutdown/restart the host goes offline. Unless Wake-on-LAN is configured, you cannot wake it remotely.
3.2.3 Per-host streaming settings
Figure 3-3 Host card → Settings.
| Field | Values | Recommendation |
|---|---|---|
| Resolution | Host / client / 1024×768 … 3840×2160 | Default to host; use client for windowed work |
| Bitrate (Mbps) | 1–300 slider | 20–30 for 1080p60; lower it on unstable links |
| Frame rate (FPS) | Auto / 30 / 60 / 90 / 120 / 144 / 240 | 60+ for games; 30 is enough for office work |
| Video codec | H.264 | Best compatibility |
| Monitor | Monitor 1–3 | Switch monitors on multi-display hosts |
| Audio | Opus / Raw | Opus saves bandwidth; Raw is more compatible |
| Keyboard filter | Toggle | Blocks browser shortcuts; recommended for games |
| Sync display | Toggle | Lets the host follow the client resolution/refresh rate |
| Cursor lock | Toggle | Locks the pointer and sends relative motion for 3D games |
| Original size mode | Toggle | 1:1 pixels, no scaling |
Click Save to store the settings for this host; Cancel discards them.
3.3 System settings (global defaults)
Click Settings in the navigation bar:
Figure 3-4 System settings.
Differences from per-host settings:
- A Select host dropdown at the top lets you apply settings to any host.
- Reset to defaults restores the defaults.
- Other fields are the same as 3.2.3.
Start with a general profile (for example 1080p / 20 Mbps / auto FPS), then tune individual game hosts.
3.4 Quick connect
The bottom input accepts only two kinds of input:
- Room number: the 8-character room ID.
- Full room link:
https://z.mycloudgame.com/room.html?room=....
Host IDs / host UUIDs are not supported.
Click Quick connect to jump to the room page and follow the anonymous-room flow. Useful when you keep a room link or room number handy and do not want to find the host card.
The placeholder may still read "Paste a share link or enter a host ID", but the actual support is room number / room link only.
To connect to your own host, click Connect on its host card.
3.5 Tools
Figure 3-5 Tools menu.
| Tool | Purpose | When to use |
|---|---|---|
| Network check | NAT type and connectivity diagnostics | Cannot connect; want to inspect the network path |
| Gamepad test | Local gamepad detection and button test on the client | Buttons are wrong or the gamepad is not detected |
| WebHID gamepad test | Connect non-Xbox (XInput) gamepads via WebHID | Steam Deck / PS4 / PS5 gamepads; only Steam Deck is fully supported |
| Latency test | High-precision timer running on the host | Photograph host and client screens to compare display latency |
| Edge latency test | Round-trip latency to Gamespace edge nodes | Choose a trial region |
| Smoothness test | Test page running on the host, viewed from the client | Judge smoothness visually (not an FPS/stutter report) |
| File transfer | Opens the standalone file-transfer site | Sending large files |
These pages open in a new tab and do not affect the current session.
3.6 Gamespace menu
| Item | Description |
|---|---|
| Apply for Solo | Apply for a dedicated Gamespace workspace |
| Apply for Solo by email | Submit the application by email |
| Gamespace console | Open admin-ops/customer (chapter 9) |
| Game library | Open the public gs library (chapter 8) |
| Vendor spaces | Open the list of vendor/developer spaces |
3.7 Help and PWA
- Help opens the public manual page
https://mycloudgame.com/manual. - Install appears when the browser supports PWA. After installation, the dashboard opens from the desktop/start menu like a native app.
- The PWA
start_urlis the dashboard. Remote sessions are still best kept in browser tabs for multi-session work.
3.8 Common dashboard states
| State | Meaning | Action |
|---|---|---|
| No host cards | The host is not signed in with the same account, or it is offline | Check the host tray menu / settings page for main-service status. There is no host-count limit for personal use |
| Card shows only the decorative background | Normal; it is not a live thumbnail | Click Connect to see the desktop |
| NAT shows "Port-restricted cone" etc. | NAT type | Symmetric NAT is fine; YiLink uses automatic TURN by default |
| IPv4 shows a public address | Host egress IP | Diagnostics only; do not share it |
| Build version at the bottom | Frontend build | Include it in bug reports |
04 Remote session
The remote session is where you actually operate the host. The URL looks like:
https://z.mycloudgame.com/remote.html?mode=token&host_id=...&launch_id=...
You do not need to build it by hand. Open it from Connect on the dashboard, from a room page, or from a Gamespace trial entry.
4.1 Layout
| Area | Description |
|---|---|
| Video | Host desktop/app, filling the viewport |
| Custom cursor | Drawn by the browser when the host cursor is hidden |
| Connection overlay | "Connecting / waiting for video" on first entry |
| Control bar | Hidden by default; move to the left edge and click the green circle |
| Reconnect banner | Shown at the top when the network drops |
4.2 Opening the control bar
The control bar is collapsed by default. A green circular button with an arrow sits at the middle-left edge:
- Move the mouse to the left edge.
- Click the green circle to expand the bar.
- The bar hides after 3 seconds without interaction; hovering over it keeps it open.
- Click the circle again to collapse it.
4.3 Control bar buttons
From left to right:
| Icon | Name | Purpose |
|---|---|---|
| ✕ | Disconnect | Ends the current WebRTC session (shown only in some entry modes) |
| ⛶ | Fullscreen | Enter/exit browser fullscreen |
| ⏻ | System | Remote power and lock |
| ⌨ | IO | Input devices and input modes |
| 🖥 | Audio/Video | Monitor, resolution, bitrate, frame rate, audio |
| ⓘ | Tools | File transfer, connection info, input transform, TURN, feedback |
| 🎮 | Game list | Open the host game launcher |
4.3.1 System menu
Figure 4-1 Control bar → System.
| Item | Description |
|---|---|
| Sleep | Host sleeps; the session drops |
| Hibernate | Host hibernates; slower wake |
| Restart | Normal restart |
| Shut down | Normal shutdown |
| Lock | Locks the Windows workstation (session may stay alive) |
| Send Ctrl+Alt+Del | Opens the Windows security screen (Task Manager, switch user, etc.) |
Shutdown and restart disconnect immediately. Make sure work is saved first.
4.3.2 IO menu (input)
| Item | Description |
|---|---|
| Virtual input → Virtual keyboard | On-screen keyboard for touch or keyboardless setups |
| Virtual input → Virtual gamepad | On-screen gamepad mapped to an Xbox controller |
| Virtual input → Virtual mousepad | Trackpad-style mouse area |
| Invert Y axis | Reverses the Y axis for gamepad/mouse |
| Keyboard filter | Blocks browser shortcuts such as Ctrl+W and Alt+Tab |
| WebHID gamepad | Connects non-Xbox gamepads through WebHID (authorization required) |
| Cursor lock | Locks the pointer to the video area and sends relative motion for 3D games |
4.3.3 Audio/Video menu
Figure 4-2 Control bar → Audio/Video.
| Item | Values | Description |
|---|---|---|
| Monitor | Monitor 1–3 | Switch displays on a multi-monitor host |
| Resolution | Host/client, or fixed presets | Presets from 1024×768 to 3840×2160 |
| Bitrate (Mbps) | 5 / 10 / 15 / 20 / 30 / 50 / 100 / 150 / 200 | Higher is sharper and needs more bandwidth |
| Frame rate (FPS) | Auto (host) | Follows the host refresh rate |
| Sync display | Toggle | Host resolution/refresh follows the client |
| Original size mode | Toggle | 1:1 pixels, no scaling |
| Audio: Opus | Current codec | Opus is low-latency and bandwidth-friendly |
Resolution, bitrate, and frame rate are session-level settings and take effect immediately. They are remembered per host.
4.3.4 Tools menu
| Item | Description |
|---|---|
| File transfer | Opens https://ft.<current-domain> in a new
window |
| Connection info | WebRTC stats overlay: bitrate, FPS, RTT, packet loss, candidate pair |
| Input transform | Input mapping editor with JSON import/export |
| TURN configuration | Temporary TURN server for this session |
| Feedback | Feedback form with current session context |
4.3.5 Game list
Click the gamepad icon to open the game list reported by the host. Selecting a game can launch it on the host (if supported). See 3.2.1 if the list is empty.
4.4 Input devices
| Device | Support | Notes |
|---|---|---|
| Mouse | Move, left/right/middle click, wheel | Disable browser gestures where possible |
| Keyboard | Full key set including combinations | Keyboard filter makes it feel local |
| Touch | Single tap = left click; two-finger long press = right click; two-finger move = wheel | Mobile browsers |
| Gamepad | Xbox/XInput is recognized directly; others via WebHID | Host needs ViGEmBus or similar; only Steam Deck is fully supported today |
| Virtual devices | Keyboard / gamepad / mousepad | For setups without physical devices |
Gamepad troubleshooting
- Client-side test: open Tools → Gamepad test on the client and confirm the browser sees the gamepad and buttons/axes report correctly.
- Host virtual gamepad: open the gamepad test page on the host and confirm the virtual gamepad is loaded.
- End-to-end test: on the remote session page, press buttons on the client gamepad and watch the host virtual gamepad. This verifies the whole client → host path.
- Non-Xbox gamepads: PS4/PS5 and Steam Deck are not recognized directly by the browser. Use IO → WebHID gamepad and grant permission. Only Steam Deck is fully supported today; other models may work partially.
- For high Bluetooth latency, prefer a cable or a 2.4 GHz receiver.
4.5 Clipboard
| Direction | How |
|---|---|
| Local → remote | Copy locally, paste inside the remote window with Ctrl+V / Cmd+V |
| Remote → local | Copy remotely, paste locally |
The browser asks for clipboard permission the first time. If denied, allow it in site settings. Some browsers only allow clipboard access after a user gesture (click/keypress).
4.6 Fullscreen and exit
- Click Fullscreen on the control bar to enter fullscreen.
- To exit fullscreen, long-press
ESC. This is the fixed shortcut on the YiLink remote page. - Closing the tab ends the session; the host receives the disconnect event.
- After the session ends you return to the dashboard or room page.
4.7 Video and latency tuning
| Symptom | First adjustment |
|---|---|
| Blurry/blocky image | Raise bitrate; lower resolution; check packet loss |
| High input latency | Lower bitrate/resolution; disable Sync display; use wired network |
| Periodic stutter | Close bandwidth hogs; use 5 GHz Wi-Fi; compare with your own TURN |
| Washed-out colors | Host HDR/color settings; try Original size mode |
| Wrong monitor | Reselect the monitor in Audio/Video; verify numbering on the host |
| Gamepad stick drift | Calibrate on the gamepad test page; adjust dead zone |
Rules of thumb:
- 1080p60 office: 10–20 Mbps.
- 1080p60 gaming: 20–30 Mbps; 15–25 Mbps over the public internet.
- 1440p/4K: start at 50 Mbps and ensure stable uplink.
- Higher FPS is not always better; an overloaded host encoder can make motion worse.
4.8 Disconnects and reconnects
- When "Connection lost, reconnecting" appears, do not close the page.
- The client retries with backoff and restores video when the network returns.
- If it does not recover within ~30 seconds:
- Check your local network.
- Return to the dashboard and confirm the host is still online.
- Click Connect again.
- If it still fails, follow chapter 10 for NAT/TURN checks.
4.9 Security
- The remote-session URL contains a one-time
token; do not share screenshots of it. - On a shared PC, close the tab and sign out after the session.
- The host can delete the room from the tray menu, stop sharing, or close the service to interrupt a session.
05 Anonymous room
An anonymous room is for temporarily lending a PC: the guest does not need a YiLink account, only a link. The host approves once.
5.1 Creating a room on the host
Option 1: tray menu (full desktop)
- Right-click the YiLink tray icon.
- Click Create anonymous shared desktop to share the whole desktop.
Option 2: settings page (specific app)
- Right-click the tray icon → Open settings (or
open
http://127.0.0.1:<port>/index.htmlmanually). - Open the Room management tab.
- Select an app/game under Select app / Select game (leave it on desktop to share the desktop).
- Click Create shared room.
- The page shows the room ID, expiry, link, and current app.
Two sharing modes:
- Full desktop: the whole desktop; monitors can be switched from the control bar after connecting.
- Specific app: only the selected process/game window.
The current
local_settingspage exposes only "create room + room info". Delete the room from the right-click tray menu; this page does not provide a visitor list, connection log, or force-reconnect.
5.2 Room information
After creation the host shows:
| Field | Description |
|---|---|
| Room ID | 8-character short ID; also used in the link |
| Expiry | Remaining lifetime; a room lives for at most 8 days |
| Link | URL to send to guests |
| Current app | Desktop or a specific game/app |
| Copy button | Copies the room link |
The host overview (figure 7-1) also shows room status (created/not created, connection state); click Refresh status to update. Some builds provide a Join button to re-enter the room.
To invalidate the link immediately, right-click the tray icon → Delete room. You can also stop the shared app/service.
5.3 Guest connection
A guest opening the link sees:
| Area | Content |
|---|---|
| Status | Online/offline, connection count (for example
0/4) |
| Host name | Name configured on the host |
| Host NAT / client NAT | Used to judge the network path |
| Countdown | Remaining room lifetime |
| Note field | Up to 200 characters to identify themselves |
| Request connection | Waits for host approval |
Flow:
- The guest optionally enters a note and clicks Request connection.
- The page shows "Waiting for host approval…".
- The host receives the request; the owner approves.
- The guest enters the remote session.
The first connection needs owner approval. The same device reconnecting to the same room reuses the cached access code and usually does not need approval again. A new room requires approval again.
5.4 Lifetime and cleanup
| Rule | Description |
|---|---|
| Room lifetime | At most 8 days, per the countdown |
| Host offline continuously | More than 24 hours releases the room early |
| Delete from tray menu | Immediately invalidates the room; guests cannot enter |
| Connection limit | At most 4 clients (same limit as virtual Xbox
gamepads); the page shows current/4 |
| After expiry/release | Connect button is disabled; the page shows "Expired" |
Create a new room after expiry; old links never come back.
5.5 Logged-in users vs anonymous guests
| Capability | Anonymous guest | Signed-in user |
|---|---|---|
| Shared content | Full desktop or specific app | Full desktop only |
| Per-connection approval | First time | Usually not needed |
| Sees host list | No | Yes |
| Can use dashboard settings | No | Yes |
| After room expiry | Link is dead | Can still connect from the dashboard while the host is online |
| Best for | Temporary sharing | Your own devices |
5.6 Security
- Send the link only to people you trust; the link itself is the credential.
- Do not put passwords, ID numbers, or other sensitive data in the note.
- Invalidate the room when done: right-click the tray icon → Delete room.
- Reject unknown connection requests and verify the source on the host.
- Do not post room links in public groups or forums.
5.7 Common issues
| Symptom | Cause | Action |
|---|---|---|
| "Room not found" | Deleted, expired, or incomplete link | Ask the host to copy the link again |
| Stuck at "Waiting for host approval" | Host did not see the prompt / host offline | Check main/signaling status in the tray menu or settings page |
| Connection limit reached | 4 clients already connected | Ask someone to disconnect |
| NAT detection failed | Client network, host side, or relay side | Retry on another network; check the host, configure your own TURN if needed |
| Countdown does not move | Page suspended | Refresh |
| Disconnects immediately | Shared app was closed/switched | Select the app again and create the room |
06 Membership and billing
Entry: click your email at the top right of the dashboard → User center → Membership and billing.
Figure 6-1 User center → Membership and billing.
6.1 Page sections
| Section | Content |
|---|---|
| Current plan | Current tier, expiry, auto-renew state |
| Change plan | Starter / Pro monthly and yearly cards |
| CDKEY redemption | Enter a code; credit is applied immediately |
| Billing history | Past orders and status |
| Invoices and payment methods | Opens the Waffo portal for invoices, refunds, and payment methods |
6.2 Plans
Prices at the time of writing (the live page is authoritative):
| Plan | Monthly | Yearly | Best for |
|---|---|---|---|
| Starter | $20/month | $200/year | Small Gamespace, trial launch |
| Pro | $100/month | $1,000/year | Teams / higher-concurrency Gamespace |
Steps:
- Click Select on a plan card.
- Complete the payment flow (
buy.html→ Waffo). - After payment, the tier takes effect on the dashboard.
Upgrades are prorated; downgrades usually take effect at the end of the current period. The payment page is authoritative.
Who paid plans are for
Paid tiers mainly serve Gamespace commercial scenarios: game developers, publishers, and teams running browser trials or campaigns. Personal remote control does not require buying a host-count quota.
Free-tier application
Gamespace also offers a free tier (dev_free) for
validation and small trials. The application usually requires:
- a Steam store page; or
- a product website/domain page.
These are used to verify the game/team. Free-tier quotas are lower (see 6.6); upgrade when you outgrow them.
6.3 CDKEY redemption
- Paste the code (for example
PRM-XXXX-XXXX-XXXX) into CDKEY redemption. - Click Redeem.
- On success, the page shows what was credited and the new expiry.
Notes:
- Codes are case-sensitive; do not include spaces.
- A code is usually single-use; used codes are rejected.
- Membership time is added to the current expiry.
- Bulk/enterprise codes are generated by admins in
cdkey-admin.html.
Check a code at
https://z.mycloudgame.com/cdkey-query.html: enter the
code and click Query to see whether it is valid,
used, and which account it is bound to.
6.4 Invoices, payment methods, and refunds
Click Invoices and payment methods (Waffo portal):
- Update the payment method (card, PayPal, etc., depending on Waffo coverage).
- Download past invoices.
- Request a refund (subject to the refund policy).
- Inspect subscription state.
buy.html is only a redirect page ("Preparing a
secure payment environment…"). Do not refresh or close it, or the
order context may be lost.
6.5 Billing history
Each order shows:
- Date/time
- Product/plan
- Amount and currency
- Payment status (paid / processing / failed / refunded)
- Order ID (include it in support requests)
Export once a month for reconciliation, especially for company reimbursement.
6.6 Tiers and quotas
Tiers control Gamespace quotas. Personal remote control has no host-count limit; the table below applies only to Gamespace sharing. Current defaults:
| Tier | Concurrent hosts | Listed games | Total games | Monthly trial sessions | Campaigns per game |
|---|---|---|---|---|---|
Free (dev_free) |
1 | 1 | 3 | 3,000 | 5 |
Starter (premium) |
5 | 2 | 10 | 30,000 | 20 |
Pro (business) |
20 | 5 | 50 | Unlimited | 30 |
| VIP / Admin | 10 | Configurable | Configurable | Configurable | Configurable |
Additional rules:
- Effective host quota = base tier + unexpired add-ons.
- The quota is enforced when a host connects to an edge;
over-quota hosts are rejected with
host_quota_exceeded. - Listed-game quota is consumed only when a game is added to the library/showcase; unlisting releases it.
- Operators adjust quotas through internal APIs; the numbers in the console header are authoritative.
6.7 Renewal and expiry
- Renew before expiry to avoid interrupting trials.
- After expiry, the tier falls back to free; hosts above the quota cannot connect (data is not deleted).
- Auto-renew can be disabled in the Waffo portal.
- Yearly billing is about 17% cheaper than monthly.
6.8 Common issues
| Symptom | Action |
|---|---|
| Payment succeeded but tier unchanged | Wait 1–2 minutes and refresh; if still unchanged, send the order ID to support |
| Code says already used | Check cdkey-query.html; it may be bound to
another account |
| Invoice title is wrong | Reissue in the Waffo portal or ask support to void and reissue |
| Want to downgrade | Do it before the current period ends to avoid losing quota immediately |
| Expiry did not extend after renewal | Confirm it was a renewal, not an upgrade; contact support with the order |
07 Host service and local_settings
The host service runs in the background on the controlled
Windows PC. It captures the screen, encodes video, keeps the cloud
connection alive, and serves a local settings page bound to
127.0.0.1.
Important:
local_settings.htmlcan only be opened on the host itself. Openinghttps://z.mycloudgame.com/local_settings.htmlon another computer stays at "Connecting… → Disconnected", because it talks to the local service, not the cloud.
7.1 What the host does
Windows host
├── YiLink host service (tray, always running)
│ ├── Main service (ProServer) — account, host registration, control plane
│ ├── Signaling service — rooms, WebRTC signaling
│ ├── Capture/encode — desktop, window, game
│ └── Local settings page http://127.0.0.1:<port>/index.html
├── Anonymous rooms (optional)
└── Gamespace (optional, connects to an edge node)
The service connects automatically at startup; manual sign-in is not required on every boot. It reconnects after network recovery.
7.2 Opening the settings page
Two ways:
- Tray menu (recommended): right-click the YiLink tray icon → Open settings. The same menu shows main/signaling status and Create anonymous shared desktop.
- Manual URL: open
http://127.0.0.1:<port>/index.htmlin a browser on the host.
The YiLink shortcut in the desktop/start menu is not the local settings page. Do not rely on it.
The port is chosen when the service starts (example:
39210); check the service log. The page supports a
language parameter:
http://127.0.0.1:39210/index.html?lang=zh-CN
Use 中文 / English at the top right to switch at any time.
7.3 Overview
Figure 7-1 Host → Overview.
| Field | Meaning | If abnormal |
|---|---|---|
| Host name | Identity shown to clients | Use a recognizable name |
| Signed-in user | YiLink account used by the host service | A mismatch hides the host from the dashboard |
| Current server domain | mycloudgame.com / .cn |
Must match the account's deployment |
| Main service status | Control-plane connection | Disconnected: check network, account, firewall |
| Signaling service status | Signaling connection | Disconnected: check WSS 443, proxy |
| Room status | Whether an anonymous room exists/is connected | Not created: create one when needed |
| Version | Host version + build time | Include in bug reports |
| Refresh status | Reload the snapshot | Click when data looks stale |
| Sign in / out | Switch account | Sign in again after switching |
The right-click tray menu also shows main/signaling status directly; you do not need to open the settings page every time.
Reading the status
- Connected / Connected: normal.
- Main connected, signaling disconnected: sign-in works but sessions fail; usually a proxy/firewall blocking WebSocket.
- Main disconnected: the host does not appear on the dashboard; check DNS, system time, proxy.
- Room not created - disconnected: normal when there is no anonymous room.
7.4 Config
Figure 7-2 Host → Config.
| Field | Description |
|---|---|
| Host name | Name shown on the dashboard card; for example
GAMEHOST-4090 |
| Current server domain | Read-only; the deployment the host is connected to |
| Target server | China (mycloudgame.cn) / International
(mycloudgame.com) |
| Auto start on boot | Starts the service when Windows boots |
| Sync game list | Off by default; when enabled, syncs only Steam/Epic fixed directories (no full-disk scan) |
Actions:
- Apply config: submits changes. Switching the
target server signs out the current account and restarts the
service; sign in again.
.cnand.comaccounts are separate. - Restore loaded config: discards unsaved changes.
Recommendations:
- Keep host names free of personal information.
- Enable auto-start on unattended machines.
- Enable game-list sync on gaming hosts if you want quick launch from the client.
7.5 TURN relay
Figure 7-3 Host → TURN configuration.
YiLink automatically uses the mycloudgame.com TURN
relay when P2P fails; you do not need to configure anything for
normal use. This page is for your own TURN
server, which takes priority over the automatic
relay.
| Field | Description |
|---|---|
| TURN address | IP or domain |
| Port | Default 3478 |
| Username | TURN account |
| Password | TURN password (eye icon reveals it) |
| Enable TURN relay | When enabled, this custom TURN is preferred |
Steps:
- Fill in address, port, username, and password.
- Click Test connection.
- Read the result:
- "Test succeeded, N relay candidates": usable.
- "No relay candidates": account/password/port/firewall problem.
- "Test timed out": UDP 3478 is blocked.
- Enable TURN relay and click Save TURN config.
Custom TURN is for latency/stability-sensitive setups. Normal use can stay on the automatic relay.
7.6 Room management (create shared room)
Figure 7-4 Host → Room management: pick an app/game, then create a shared room.
Entry: the Room management tab. This page handles "select app + create room" and is linked to room status in the overview.
| Control | Purpose |
|---|---|
| Select app / Select game | Choose what to share |
| Refresh | Reload the process/game list |
| Create shared room | Create a room with the current selection |
| Copy | Copy the room link |
| Delete room | Not on this page; right-click the tray icon → Delete room |
Room information:
- Room ID: 8 characters.
- Expiry: expiry time.
- Link: send to guests.
- Current app: desktop or a specific process.
- Selected item detail: title, process name, process path.
Notes:
- With no app selected, the desktop is shared.
- This page does not provide delete, force-reconnect, or a visitor list/log. Delete from the tray menu.
- To invalidate a link immediately, stop sharing or close the host service; the room is also released after 24 hours offline.
Choosing an app/game
- Share only a game window to avoid exposing the rest of the desktop.
- Specify the process for fullscreen/multi-monitor games; it is more stable.
- Empty process list: restart the host service as administrator, or confirm the process is running.
7.7 Gamespace
Figure 7-5 Host → Gamespace: ID, region, password, encoder settings, and process list.
The host can join a Gamespace and become a trial host. Entry: the Gamespace tab.
| Field/button | Description |
|---|---|
| Gamespace ID | 8-character ID from the console (for example
00001) |
| Region | Auto / East / West / South / North / Central; measured latency
is shown (for example Shanghai (34 ms)) |
| Join password | Optional; the join password of a game in Gamespace |
| Join / Leave | Join or leave the Gamespace |
| Pause / Resume | Stop accepting trials without leaving |
| Import config | Paste JSON exported from the console |
| Current app | The process currently shared |
| Encoder settings | Width, height, bitrate (Mbps), frame rate; click Apply |
| Select app/game | Choose what to share for trials |
| Refresh | Reload process/game list |
| Status bar | Gamespace ID, region, active/paused state |
After joining:
- The host appears in ② Hosts in the console (online/health/region).
- Players who click Play in the library are allocated to this host by the edge.
- Host count is subject to the Gamespace plan quota (see 6.6).
What the join password is for
The join password is not your YiLink account password. It is the join password set for a game in Gamespace:
- With the correct password, a host can become a candidate host for that game even if it is not signed in to the Gamespace owner's account.
- Without a password, the host can join only games in Gamespaces created by the same account.
- A wrong/empty password with a mismatched account fails the join.
Confirm there are no active trials before leaving or pausing.
7.8 Version, logs, and updates
- Version: bottom of the overview, for example
0.9.29 / 2026-10-31 18:19:24. - Logs:
log/under the install directory (for exampleC:\Users\<user>\AppData\Roaming\YiLink\log). - Update: run the installer/auto-update, restart the service, and confirm the version changes.
- Uninstall: sign out first; leftover config
lives in
AppData\Roaming\YiLink.
7.9 Security and operations
- The local settings page listens on
127.0.0.1; never port-forward it to the internet. - Do not share
host_config.json,public_key.pem, or logs. - Use a dedicated account for the host service rather than a personal primary account.
- Be careful with auto-login on unattended hosts; lock screen does not block remote control, but sleep does.
- Periodically check: main/signaling status, version, disk space, GPU driver.
08 Gamespace player side
Gamespace is YiLink's game promotion/trial capability: developers publish games, and players try them directly in a browser without installing anything.
8.1 Page map
| Page | URL | Description |
|---|---|---|
| Game library | https://gs.mycloudgame.com/public/games |
All listed games |
| Game detail | https://gs.mycloudgame.com/public/g/{game_id} |
Steam details/trailer |
| Trial page | campaign link /go/{token} |
Actual game stream |
| Vendor space list | https://gs.mycloudgame.com/public/spaces |
All vendor pages |
| Vendor page | https://gs.mycloudgame.com/v/{vendor_slug} |
Games from one developer |
| Latency test | https://gs.mycloudgame.com/play/latency |
Latency to each edge |
The domain depends on the deployment (
.com/.cn). The player entry may 302 to the regional edge domain.A Gamespace trial shares only the selected game/app, not the whole desktop. This is the main difference from an anonymous room's full-desktop mode.
8.2 Game library
Figure 8-1 Game library.
| Element | Description |
|---|---|
| Source filter | All / Steam / Epic / Manual |
| Search | Search by game name |
| Cover | Steam header or uploaded cover |
| Description | Store short description, truncated |
| Primary button | Host available: Play now; host unavailable but target exists: Learn more; neither: disabled |
| Details | Opens the detail page (if the developer enabled it) |
Card states:
- Host available: Play now starts a trial.
- No host but redirect target: Learn more opens the store/site.
- Neither: button is disabled with "Temporarily unavailable".
8.3 Game detail
Figure 8-2 Game detail page.
| Area | Description |
|---|---|
| Top bar | Back to library, game name, language switch |
| Hero | Steam header video (HLS), auto-play/muted |
| Thumbnails | Screenshot/video switching |
| Side panel | Description, genres, publisher, release date, Steam store link |
| Floating controls | Play (↗) and mute |
Actions:
- Click the floating play button to start a trial.
- ← Back to library returns to the list.
- Go to Steam store opens the store page.
8.4 Trial flow
- Enter from the library, detail page, or a campaign link.
- The page shows, in order:
- Preparing the trial connection
- Connecting to the server
- Connected to the server
- Establishing video
- Trial ready (video appears)
- Trial length is set by the campaign (usually 300 seconds); a countdown may be shown.
- When it ends, Trial ended appears:
- Go to details: opens the campaign's target page (store/site).
- Stay on this page: dismisses the prompt.
Trial status reference
| Message | Meaning | Action |
|---|---|---|
| Connecting to server | Connecting to the edge signaling | Wait a few seconds |
| Preparing game session | Edge is allocating a host | Wait; a long wait means no host |
| Establishing video | WebRTC negotiation | Wait; failure shows an error |
| Keyframe lost, retrying n/N | Video keyframe lost | Automatic retry; change network if it persists |
| Network unstable, recovering | Connection interrupted; waits up to N seconds | Do not close the page |
| Trial connection failed | Negotiation/host failure | Retry or pick another game |
| Trial ended | Time is up / host disconnected | Follow the CTA |
When no host is available
- If the campaign has a redirect target, the page redirects silently to keep the ad conversion intact.
- If there is no target, the page stays and shows a message.
- An unknown campaign token returns 404.
8.5 Vendor spaces
Figure 8-3 Vendor space list.
- Shows vendor name, game count, and Enter.
- Inside, games use the same card layout as the library.
Access password
Some vendors protect games with a web password:
Figure 8-4 Vendor page (example unlocked).
- Click a locked game; a password dialog appears.
- Enter the password and click Unlock.
- The game is accessible in this browser; closing the browser clears it (server-side 24-hour fallback).
The password is set by the developer in the Gamespace console. Contact the developer if you do not have it.
8.6 Platform restrictions
Developers can restrict games to certain platforms:
| Platform | Description |
|---|---|
| desktop | Windows/macOS/Linux desktop browsers |
| mobile | Phone/tablet browsers |
| tv | TV/large-screen browsers |
If the current device is not allowed, the trial entry is rejected. Switch devices or contact the developer.
8.7 Latency test
Open https://gs.mycloudgame.com/play/latency:
- Runs a STUN binding plus an HTTPS health check against each edge.
- Shows the nearest node, per-node round-trip latency, and a target threshold.
- Everything stays in the browser.
Use it to choose a trial region. VPNs/proxies can skew the numbers.
8.8 Player FAQ
| Symptom | Cause | Action |
|---|---|---|
| Library is empty | No games listed | Normal; wait for developers to list games |
| Card only has Details | No online host | Open details or try later |
| Trial never allocates a host | Host offline/quota | Try another game or later |
| Black screen with audio | Keyframe/decoder issue | Refresh; try Chrome/Edge |
| Gamepad not working | Browser permission/host driver | Use the gamepad test pages first |
| Password required | Vendor page is protected | Ask the developer |
| Trial ends and jumps away | Campaign redirect | Normal ad-conversion behavior |
| Mobile cannot play | Developer restricted to desktop | Use a desktop browser |
09 Gamespace console
The Gamespace console is for game developers/tenants: manage games, hosts, campaigns, trial data, and edge nodes.
Entry:
- Dashboard → Gamespace → Gamespace console
- Or open
https://z.mycloudgame.com/admin-ops/customer
Requires SSO sign-in. Your tier determines the quotas.
9.1 Console header
Figure 9-1 Gamespace console (① Games).
| Metric | Description |
|---|---|
| ID | 8-character Gamespace ID (used for display and host join) |
| Display name | Editable; saves on blur |
| Vendor space ↗ | Opens /v/{vendor_slug} |
| Account tier | dev_free / premium / business / vip / admin |
| Host count | Concurrent host limit for this plan |
| Listed games | Games in the public library / quota |
| Games in space | Total games / quota |
| Back to dashboard | Returns to dashboard.html |
| Language | EN / 中文 |
9.2 ① Games
List
| Column | Description |
|---|---|
| ID | 6-character game ID (detail page/API) |
| Name | Display name |
| Status | ACTIVE / other |
| Actions | Delete (irreversible) |
Click a row to open game details.
Create a game
Click Create at the top right:
| Field | Required | Description |
|---|---|---|
| Display name | Yes | Name shown in the library |
| Host match mode | Yes | Process verification or Store association |
| Target process name | Process mode | For example CHROME.EXE |
| Process hash (SHA256) | No | Stricter executable verification |
| Store (provider) | Store mode | steam / epic / manual |
| Provider app ID | Store mode | For example Steam AppID 2358720 |
| Generate detail page (Steam) | No | Enables the player detail page |
| Trial duration (sec) | Yes | Default 300 |
| Trial mode | Yes | Ad funnel / internal playtest |
| Redirect target | No | URL used after trial or when no host |
| Join password | No | Validated when a host joins the game |
| Latency threshold (ms) | No | Clients above the threshold are not allocated |
| List in library | No | Adds to the public library (uses listed quota) |
| Cover | Required when listed | Steam games can fetch it; others upload |
| Show in vendor space | No | Adds to the vendor page |
| Web access password | No | Vendor-page unlock password |
| Supported platforms | No | desktop / mobile / tv |
After submitting:
- A default campaign ("Default", not deletable) is created automatically.
- Steam games fetch metadata asynchronously (cover, description, screenshots, video).
Game details
Figure 9-2 Game details.
| Area | Content |
|---|---|
| Basic info | ID (copyable), platform, store, target process, routing |
| Actions | Edit game settings, export settings as JSON, refresh Steam metadata, view detail page |
| Hosts | Associated hosts (online/health/region/last active) |
| Campaigns | Campaigns, token, link, open/copy/QR/stats/delete |
| New campaign | Display name, Game (fixed), source, channel, status |
Notes:
- The game binding cannot be changed; create a new campaign to target another game.
- The default campaign cannot be deleted; it can be toggled active/inactive.
- Changing display name/source/channel does not affect attribution of existing links.
9.3 ② Hosts
Figure 9-3 Host list.
| Column | Description |
|---|---|
| Host UUID | Unique host identifier |
| Name | Name reported by the host (empty if unregistered) |
| Online | ONLINE / OFFLINE |
| Health | HEALTHY / UNKNOWN |
| Region | For example cn-sh |
| Target | Game/process currently bound |
| Last active | Last heartbeat |
| Actions | Lifecycle history, remove binding |
Tips:
- Use the region filter (top right) for multi-edge deployments.
- Host OFFLINE for a long time: check the host service, whether Gamespace is paused, and quotas.
- Removing the binding only detaches the Gamespace association; it does not uninstall the host.
9.4 ③ Campaigns
Figure 9-4 Campaign list.
| Column | Description |
|---|---|
| Name | Campaign name (default "Default") |
| Game | Bound game |
| Status | ACTIVE / INACTIVE |
| Traffic | Opens / trials / failures / store visits |
| Actions | Open, copy link, stats, expand, delete |
Actions:
- Open: opens the campaign link
(
/go/{token}) in a new window. - Copy link: copy for ad placement.
- Stats: funnel (resolved → allocated → host_ready → web_connected → completed → cta_clicked), duration distribution, failures, by region.
- Expand: token, full URL, QR.
- Delete: irreversible; the default campaign cannot be deleted.
New campaign
| Field | Description |
|---|---|
| Display name | Campaign name; include channel/date |
| Game | An existing game (cannot be changed later) |
| Source (optional) | For example x.com, twitch.tv |
| Channel (optional) | Finer-grained channel |
| Status | active / inactive |
| Create | Generates the token and /go/{token} link |
9.5 ④ Sessions
Figure 9-5 Trial sessions.
| Column | Description |
|---|---|
| Status | Success / redirect / failure |
| Time | Start time |
| Game | Game name |
| Campaign | Campaign name |
| Region | Edge region |
| Duration | Session length (seconds/minutes) |
Filters (top right):
- Campaign: all / specific
- Result: all / success / failure / redirect
Use it to verify ad performance and see whether failures cluster by region/campaign.
9.6 ⑤ Edges
Figure 9-6 Edge nodes.
Each node card shows:
| Metric | Description |
|---|---|
| Name/region | For example Shanghai / CN-SH |
| Online | Heartbeat within 90 seconds |
| Last heartbeat | Last report time |
| Hosts | Online hosts / total |
| Active sessions | Currently running trials |
| 24h trials | Sessions in the last 24 hours |
| Served games | Games on this node with completed/redirected/failed counts |
An offline node usually means the edge process or its network is down; operations must intervene.
9.7 Quotas and limits
These quotas apply only to Gamespace; personal remote control is not affected.
| Quota | Enforcement |
|---|---|
| Host count | Checked when a host connects to an edge; over-quota rejected |
| Listed games | Checked when "List in library" is enabled |
| Total games | Checked when creating a game |
| Monthly trial sessions | New sessions are rejected after the cap |
| Campaigns per game | Checked when creating a campaign |
See 06 Membership and billing for values.
9.8 Common SOPs
SOP 1: publish a new game
- ① Games → Create; fill display name, match mode, AppID/process.
- Upload a cover and enable List in library (watch the listed quota).
- Enable Generate detail page if needed and wait for Steam metadata.
- Join the host to Gamespace; confirm it appears online in ② Hosts.
- Create a campaign in ③ Campaigns and copy
/go/{token}. - Open the link in a private window and complete a trial.
- Confirm data in ④ Sessions and node health in ⑤ Edges.
SOP 2: temporarily unpublish a game
- Uncheck List in library (releases the listed quota).
- Or set the campaign to inactive (existing links fall back to the redirect target).
- Avoid deleting the game; it cascades to campaigns/data.
SOP 3: "players cannot play"
- ④ Sessions: check failure/redirect rate and regions.
- ② Hosts: is there an online host for the game?
- ③ Campaigns: active? Is the link current?
- ⑤ Edges: is the region online?
- Host: is Gamespace paused? Is the quota exceeded?
9.9 Console tips
- Fields without a save button (such as display name) save on blur.
- Deletions are irreversible; export settings (game details → export JSON) first.
- Dynamic content is common; refresh once after changing configuration.
- Use Chrome/Edge; third-party cookie blocking can affect the sign-in state.
10 Troubleshooting
Order of investigation: state first, then network, then configuration, then logs. Do not reinstall first.
10.1 One-minute triage
| Symptom | Most likely cause | First action |
|---|---|---|
| No hosts on the dashboard | Host not signed in / offline / Gamespace quota | Check main-service status on the host |
| Host visible but cannot connect | NAT/TURN, signaling, host busy | Read the remote-session message and connection info |
| Connected but black screen | Keyframe/encoder/GPU | Change resolution/bitrate; refresh |
| Stuttering video | Bandwidth/loss/encoder overload | Lower bitrate; check RTT/loss |
| Keyboard/mouse not working | Focus/keyboard filter/cursor lock | Click the video area; check IO settings |
| Gamepad not working | Permission/driver | Gamepad test page → WebHID |
| Anonymous room inaccessible | Expired/not approved/full | Room countdown + host state |
| Trial cannot allocate a host | Host offline/quota/campaign | Console ② Hosts, ③ Campaigns |
| Tier looks wrong after payment | Payment/redemption not applied | Order ID + user center |
10.2 Host missing from the dashboard
Check in order:
- Same account: the host's "signed-in user" equals the dashboard account.
- Same deployment: the host target server (China/International) matches the site the account belongs to.
- Main service: the host overview shows main service connected.
- Gamespace quota (only if this is a Gamespace host): the host quota may be full (6.6). Personal remote control has no host-count limit.
- System time: more than a few minutes of drift breaks TLS/JWT.
- Proxy/VPN: disable it or bypass
*.mycloudgame.com. - Firewall: allow outbound 443/WSS from the host service.
Refresh the dashboard after fixing the host.
10.3 Connection fails / spinner
10.3.1 Read the message
| Message | Meaning |
|---|---|
| Connection lost, reconnecting | Network jitter; wait or change network |
| Waiting for host | Host busy or signaling not established |
| ICE failed / no candidates | NAT traversal failed and relay did not succeed |
| Authentication failed | Token expired; reconnect from the dashboard |
10.3.2 Check NAT
- The host card shows the NAT type.
- Symmetric NAT does not require manual TURN: YiLink
automatically uses the
mycloudgame.comTURN relay, but latency depends on relay location and capacity. - If automatic relay latency is high/unstable, configure your own TURN on the host (it takes priority).
10.3.3 Custom TURN
- The automatic
mycloudgame.comrelay is used by default; no manual setup is required. - To use your own TURN: host → TURN configuration → test → enable and save (custom takes priority).
- Or specify it temporarily in the remote session Tools → TURN configuration.
- Still failing: confirm TURN ports (3478/UDP, TLS 5349) are not blocked.
10.3.4 Connection info
Remote session Tools → Connection info:
- Is the
candidate-pairrelay? - RTT, available up/down bitrate, packet loss.
- Is FPS stuck at 0 (capture/encoder stalled)?
10.4 Black screen / artifacts / stutter
| Symptom | Action |
|---|---|
| Black screen with audio | Change resolution/bitrate; refresh; try another browser |
| Artifacts/green screen | Disable HDR; update GPU driver; use H.264 |
| Frozen image | Check FPS in connection info; is the host app minimized/occluded? |
| Periodic stutter | Lower FPS/bitrate; disable Sync display; check Wi-Fi interference |
| Washed-out colors | Host color/HDR settings; try Original size mode |
| Wrong monitor | Audio/Video → Monitor; try each |
Host-side tips:
- Prefer borderless windowed mode over exclusive fullscreen.
- Disabling in-game V-Sync can reduce latency.
- When the encoder is overloaded, lower resolution first, not only bitrate.
10.5 Keyboard / mouse / gamepad
| Problem | Action |
|---|---|
| Browser eats shortcuts | IO → Keyboard filter |
| Cursor missing | IO → Cursor lock; click the video area for focus |
| Cursor offset | Disable Original size mode; check scaling |
| Gamepad not detected | Tools → Gamepad test; IO → WebHID; host ViGEmBus |
| Wrong gamepad buttons | Re-map on the gamepad test page; check Xbox/DS4 mode |
| Touch right-click missing | Two-finger long press; or enable the virtual mousepad |
10.6 Anonymous rooms
| Problem | Action |
|---|---|
| Room not found | Ask the host to copy the link again; confirm it was not deleted |
| Stuck waiting for approval | Check main/signaling status on the host |
| Connection limit reached | Wait, or ask someone to disconnect (max 4) |
| Expired | Create a new room |
| New device needs approval again | Normal; access codes are cached per device |
| Link dead after 24h offline | Normal cleanup policy |
10.7 Gamespace trials
| Problem | Check |
|---|---|
| Library empty | Listed? Listed quota? |
| Play does nothing | Campaign active? Is the link /go/{token}? |
| No host allocated | ② Hosts online; paused? quota? |
| Platform unsupported | Supported platforms (desktop/mobile/tv) |
| Password required | Vendor password; ask the developer |
| Trial jumps to store immediately | Normal fallback when no host is available |
| Video stutters | ⑤ Edges nearest node; use the latency test page |
| Data looks wrong | ④ Sessions filtered by campaign/region |
10.8 Account / membership / CDKey
| Problem | Action |
|---|---|
| Wrong password | Confirm .com/.cn; use password
recovery |
| Blank page after sign-in | Try a private window or another network; if it persists, contact support with the account and time |
| Membership not applied | Wait 1–2 minutes; provide the order ID |
| CDKey invalid | Check cdkey-query.html; confirm case/spaces |
| Third-party sign-in fails | Check Google/Steam reachability; use email instead |
| Mixed account data | Sign out, clear site data, sign in again |
10.9 Host service
| Problem | Action |
|---|---|
| Tray icon missing | Restart the host app; check Task Manager |
| Overview stuck at "Connecting" | Local service not running/port changed; restart it |
| Main service disconnected | Network, DNS, system time, proxy |
| Signaling disconnected | WSS 443 blocked; change network |
| Room creation fails | Confirm signaling is connected first |
| Gamespace join fails | ID/region/password; quota; edge online |
| Config not applied | Click "Apply config"; switching servers restarts the service |
10.10 Collect diagnostics
Include:
- Dashboard version + build time (bottom right).
- Host version (for example
0.9.29 / 2026-10-31 18:19:24). - The failing page URL (remove tokens).
- Remote session Tools → Connection info screenshot (RTT, candidate type, bitrate).
- The last 10 minutes of host
log/. - Network check result (NAT type).
- Reproduction steps: time, host, network, actions.
Logs may contain account/host information; redact before sending.
10.11 Do not
- Repeatedly restart/shut down a production host "just to test".
- Port-forward the local settings page to the internet.
- Use an untrusted TURN server.
- Delete Gamespace games/campaigns without a backup.
- Post URLs containing tokens in public channels.
11 Appendix
11.1 Glossary
| Term | Chinese | Description |
|---|---|---|
| Host / host agent | 主机端 | Background service on the controlled Windows PC |
| Client | 控制端 | The browser side |
| Dashboard | 控制台 | Main screen after signing in |
| Remote session page | 远控页 | remote.html |
| Anonymous room | 匿名房间 | Temporary session joined by link |
| Access code | 访问码 | Credential for a room/device |
| Signaling | 信令 | WebRTC negotiation channel |
| Main service | 主服务 | ProServer control-plane connection |
| TURN relay | 中继 | Fallback forwarding when P2P fails |
| NAT | NAT 类型 | Network address translation type |
| Keyframe | 关键帧 | Video decoding start point |
| Bitrate | 码率 | Video bandwidth |
| Frame rate / FPS | 帧率 | Frames per second |
| Cursor lock | 指针锁定 | Relative-motion mouse mode for games |
| Input transform | 输入转换 | Key/gamepad mapping profile |
| Virtual input | 虚拟外设 | On-screen keyboard/gamepad/mousepad |
| Game library | 游戏库 | Public game list |
| Vendor page | 厂商页 | /v/{slug} developer space |
| Detail page | 详情页 | /public/g/{id} |
| Trial / playtest | 试玩 | Gamespace streamed trial |
| Campaign | 活动 | Ad link and attribution |
| Funnel | 转化漏斗 | resolved → … → cta_clicked |
| Edge node | 边缘节点 | Nearby Gamespace node |
| Gamespace | 工作区 | Tenant workspace |
| Quota | 配额 | Host/game/session limits |
| Add-on | 加购 | Extra hosts with an expiry |
11.2 Page index
| Page | Path | Access |
|---|---|---|
| Login | /login.html |
Public |
| Register | /login.html?show=register |
Public |
| QR login | /qr.html |
Public |
| Dashboard | /dashboard.html |
Signed in |
| Remote session | /remote.html |
Token/signed in |
| Anonymous room | /room.html?room=... |
Link |
| Local settings | http://127.0.0.1:<port>/index.html |
Host only |
| User center | Inside the dashboard | Signed in |
| Membership and billing | /billing.html |
Signed in |
| Payment redirect | /buy.html |
Signed in |
| CDKey query | /cdkey-query.html |
Public/signed in |
| Gamespace console | /admin-ops/customer |
SSO |
| Gamespace ops | /admin-ops/ops |
Platform admin |
| Game library | gs.../public/games |
Public |
| Game detail | gs.../public/g/{id} |
Public |
| Vendor spaces | gs.../public/spaces |
Public |
| Vendor page | gs.../v/{slug} |
Public (may be password-protected) |
| Latency test | gs.../play/latency |
Public |
11.3 Control bar quick reference
| Want to | Path |
|---|---|
| Fullscreen | Control bar → ⛶ |
| Lock / Ctrl+Alt+Del | Control bar → ⏻ → Lock / Send Ctrl+Alt+Del |
| Switch monitor | Control bar → 🖥 → Monitor |
| Change resolution | Control bar → 🖥 → Resolution |
| Lower bitrate | Control bar → 🖥 → Bitrate |
| Keyboard filter | Control bar → ⌨ → Keyboard filter |
| Game mouse | Control bar → ⌨ → Cursor lock |
| On-screen keyboard | Control bar → ⌨ → Virtual input → Virtual keyboard |
| File transfer | Control bar → ⓘ → File transfer |
| Latency/loss | Control bar → ⓘ → Connection info |
| TURN settings | Control bar → ⓘ → TURN configuration |
| Launch a game | Control bar → 🎮 |
11.4 Host fields quick reference
| Panel | Key fields |
|---|---|
| Overview | Host name, signed-in user, domain, main/signaling status, room status, version |
| Config | Host name, target server, auto start, sync game list |
| TURN | Address, port, username, password, enable, test |
| Room management | Create room, room ID, expiry, link; delete from the tray menu |
| Gamespace | ID, region, password, join/leave/pause, encoder settings, import config |
11.5 Screenshot index
| File | Content | Source |
|---|---|---|
01-dashboard.jpg |
Dashboard | z.mycloudgame.com |
02-host-power.jpg |
Host card power menu | Same |
03-host-settings.jpg |
Per-host streaming settings | Same |
04-system-settings.jpg |
System settings | Same |
05-tools-menu.jpg |
Tools menu | Same |
06-login.jpg |
Login page | Same |
07-user-overview.jpg |
User center overview | Same |
08-user-billing.jpg |
Membership and billing | Same |
09-user-login-methods.jpg |
Sign-in methods | Same |
10-gs-console-games.jpg |
Gamespace ① Games | admin-ops |
11-gs-console-game-detail.jpg |
Game details | Same |
12-gs-console-hosts.jpg |
② Hosts | Same |
13-gs-console-campaigns.jpg |
③ Campaigns | Same |
14-gs-console-sessions.jpg |
④ Sessions | Same |
15-gs-console-edges.jpg |
⑤ Edges | Same |
16-gs-gallery.jpg |
Game library | gs public pages |
17-gs-detail.jpg |
Game detail page | Same |
18-gs-vendor.jpg |
Vendor page | Same |
19-gs-spaces.jpg |
Vendor spaces | Same |
20-controlbar-power.jpg |
Control bar system menu | Remote session |
21-controlbar-display.jpg |
Control bar audio/video menu | Same |
22-local-settings-overview.jpg |
Host overview | GAMEHOST |
23-host-config.jpg |
Host config | Same |
24-host-turn.jpg |
TURN configuration | Same |
25-host-room.jpg |
Room management | Same |
26-host-gamespace.jpg |
Gamespace | Same |
Notes:
- Email addresses, user IDs, public IPs, and host UUIDs in screenshots are masked (black/mosaic blocks, not UI elements).
- The remote-session screenshots show only the control bar, not the host desktop.
- All five host panels (Overview/Config/TURN/Room/Gamespace) are real UI captures.
- Screenshots show the Chinese UI; the English UI uses the labels in bold in the text.
11.6 Version history
| Date | Version | Changes |
|---|---|---|
| 2026-11-01 | 1.0 | First edition: dashboard, remote session, anonymous room, membership, host, Gamespace player/console |
| 2026-11-01 | 1.1 | Review fixes: registration flow, anonymous-room sharing modes/lifetime, automatic TURN, quick-connect scope, gamepad/latency/smoothness tools, host entry points, Gamespace join password |
| 2026-11-01 | 1.2 | Room limit clarified as 4 clients (virtual Xbox gamepad limit); room deletion clarified as a tray-menu action |
11.7 Translation notes
- The Chinese edition is the source of truth. Keep file names, heading levels, table column order, and figure numbers aligned.
- UI labels are quoted from the English build, not translated word-for-word.
- Screenshots are currently from the Chinese UI; re-capture in English when available, keeping the same numbering.
- Do not translate URLs, JSON field names, or API error codes.