Skip to content

Commit 068d791

Browse files
bagusnlbagusnl
committed
Add features pages
1 parent 6dd4a39 commit 068d791

File tree

6 files changed

+282
-3
lines changed

6 files changed

+282
-3
lines changed

‎home/.vitepress/config.mts‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ export default defineConfig({
1111
// https://vitepress.dev/reference/default-theme-config
1212
nav: [
1313
{ text: 'Home', link: '/' },
14-
{ text: 'Team', link: '/team' }
14+
{ text: 'Team', link: '/team' },
15+
{ text: 'Features', link: '/features' }
1516
],
1617

1718
sidebar: [
@@ -25,7 +26,16 @@ export default defineConfig({
2526
{
2627
text: 'Features',
2728
items: [
28-
{ text: 'Feature matrix', link: '/features' }
29+
{ text: 'Feature matrix', link: '/features' },
30+
{ text: 'Delta patch', link: '/feature/delta-patch' },
31+
{ text: 'Command line arguments', link: '/feature/cli-args' },
32+
{ text: 'Data synchronization', link: '/feature/database' },
33+
]
34+
},
35+
{
36+
text: 'Advanced Features',
37+
items: [
38+
{ text: 'Game Launch Commands', link: '/feature/game-commands' },
2939
]
3040
}
3141
],

‎home/feature/cli-args.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
title: Command Line Arguments | Collapse Launcher
3+
---
4+
5+
# What is a command line argument?
6+
7+
Command line arguments are special instructions that can be passed to Collapse when launching it. They can temporarily change Collapse's behaviour at start-up. Only one argument can be used per launch.
8+
9+
To use a command line argument, you can either:
10+
- Use a **terminal** and add it after the executable.
11+
<br> (e.g., `CollapseLauncher.exe tray`)
12+
13+
- Use Windows' **Run window** or a **web browser** to call Collapse's URL Protocol.
14+
<br> (e.g., `collapse://tray`)
15+
16+
# What command line arguments are available to use?
17+
18+
## tray
19+
Starts Collapse hidden in the system tray.
20+
21+
### Examples
22+
```
23+
CollapseLauncher.exe tray
24+
```
25+
```
26+
collapse://tray
27+
```
28+
29+
## open
30+
Loads a specific game/region when launching Collapse.
31+
32+
### Options
33+
#### REQUIRED
34+
- `-g <game name/ID>` or `--game <game name/id>`
35+
<br> Specifies the game to load.
36+
<br> If invalid, the entire command will be ignored.
37+
38+
#### OPTIONAL
39+
- `-r <region name/id>` or `--region <region name/id>`
40+
<br> Specifies the region to load.
41+
<br> If not specified or invalid, the last opened region for the game will be opened.
42+
43+
- `-p` or `--play`
44+
<br> Launches the game automatically after Collapse opens.
45+
46+
### Notes
47+
- If the game/region name has spaces, the name must be enclosed by quotes.
48+
- The ID of a game/region corresponds to their position in the Launcher Selector (being the first game/region at position 0). Some examples of IDs are:
49+
50+
<div align="center">
51+
52+
<table>
53+
<tr>
54+
<td>
55+
<table>
56+
<thead>
57+
<tr>
58+
<th colspan=2>Game</th>
59+
<th>ID</th>
60+
</tr>
61+
</thead>
62+
<tbody>
63+
<tr>
64+
<td colspan=2>Honkai Impact 3rd</td>
65+
<td>0</td>
66+
</tr>
67+
<tr>
68+
<td colspan=2>Genshin Impact</td>
69+
<td>1</td>
70+
</tr>
71+
<tr>
72+
<td>Honkai: Star Rail</td>
73+
<td colspan=2>2</td>
74+
</tr>
75+
</tbody>
76+
</table>
77+
</td>
78+
<td>
79+
<table>
80+
<thead>
81+
<tr>
82+
<th colspan=2>Regions for Genshin Impact</th>
83+
<th>ID</th>
84+
</tr>
85+
</thead>
86+
<tbody>
87+
<tr>
88+
<td colspan=2>Global</td>
89+
<td>0</td>
90+
</tr>
91+
<tr>
92+
<td colspan=2>Mainland China</td>
93+
<td>1</td>
94+
</tr>
95+
<tr>
96+
<td>Bilibili</td>
97+
<td colspan=2>2</td>
98+
</tr>
99+
</tbody>
100+
</table>
101+
</td>
102+
</tr>
103+
</table>
104+
</div>
105+
106+
### Examples
107+
- Load Genshin Impact (last used region)
108+
```
109+
CollapseLauncher.exe open -g "Genshin Impact"
110+
```
111+
- Load Honkai: Star Rail (Bilibili region)
112+
```
113+
collapse://open -g "Honkai: Star Rail" -r Bilibili
114+
```
115+
- Load and start Honkai Impact 3rd (Southeast Asia region)
116+
```
117+
CollapseLauncher.exe open -g "Honkai Impact 3rd" -r "Southeast Asia" -p
118+
```

‎home/feature/database.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Data Sync | Collapse Launcher
3+
---
4+
# User Data Synchronization
5+
You can set-up completely private data synchronization that only you have access to. Currently only implemented for playtime data but more coming soon(tm).
6+
7+
## Creating Database
8+
9+
1. Create account in Turso https://app.turso.tech/
10+
2. Create database group, name it how you like.
11+
12+
::: tip
13+
Fly.io is the most free one available, so we'd recommend choosing that.
14+
15+
Also select the database location to wherever closest to you for the best connection latency.
16+
:::
17+
18+
![image](https://github.com/user-attachments/assets/b6679b4d-3ef9-4299-a993-bc55d234efef)
19+
20+
3. Create database
21+
::: info
22+
Name it however you like and pick the group you just made in the earlier step
23+
:::
24+
25+
::: danger
26+
Do NOT enable "Schema Only"
27+
:::
28+
29+
![image](https://github.com/user-attachments/assets/31984f3f-1e7e-448e-9203-459e281afc34)
30+
31+
4. Copy the database URL by clicking on it. Paste it on the database URL field in Collapse settings
32+
::: info
33+
Do not worry about the URL protocol automatically changed from `libsql://` to `https://`. It is done automatically by Collapse due to limitation in the library we used to connect to the database
34+
:::
35+
36+
![image](https://github.com/user-attachments/assets/f83fde8c-115e-4f51-a882-ddccf8005726)
37+
38+
5. Press the three dots menu next to the database you created, then press Create Token
39+
::: info
40+
Set the expiration to `No expiration` and the access to be `Read & Write`
41+
:::
42+
43+
::: warning
44+
Sharing Database URL and its token to anyone else will give them FULL access to the database, including modifying and deleting your entire database. Be careful with it.
45+
:::
46+
47+
![image](https://github.com/user-attachments/assets/b2274cd4-ab8b-414b-9f94-81f7035cb64d)
48+
49+
::: info
50+
Paste the created token into Collapse setting field
51+
:::
52+
53+
6. Create User ID
54+
::: info
55+
This user ID field is primarily used for those who wants to share their database with someone else but still have the data separated.
56+
57+
You can use any string combination or press the Generate UID to automatically generate it for you.
58+
:::
59+
60+
::: danger
61+
Do not ever lose this ID as you will not be able to access your data again without complicated database table moving.
62+
:::
63+
7. Validate the Settings
64+
::: info
65+
By pressing `Validate and Save` button, Collapse will try to verify the connection to the database and see if everything is good. If there is an error, it will be shown in a pop-up dialog and the settings won't be saved.
66+
:::

‎home/feature/delta-patch.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Delta Patch | Collapse Launcher
3+
---
4+
5+
6+
# What's Delta Patch Update Feature?
7+
The Delta Patch Update feature is an update function that Collapse uses which doesn't require you to re-download the entire game (with the benefit of having a reduced download size). This feature will only update the differences between files (hence the "Delta" name) from previous to the next version and produces the new patched files which will be used for the updating the upcoming version.
8+
9+
This feature was first introduced to Collapse Launcher in [**1.0.22.3-RC1-Preview**](https://github.com/neon-nyan/CollapseLauncher/releases/tag/CL-v1.0.22.3-rc1-pre) and ***does not exist*** the default launcher.
10+
11+
This feature is only available for **Honkai Impact 3rd** and **Honkai: Star Rail** at the moment (other game releases might be considered to be available in the future).
12+
Therefore, this delta-patch will only be available for certain regions for each games, including:
13+
## Honkai Impact 3rd
14+
* Southeast Asia
15+
* Global
16+
* Mainland China *
17+
* TW/HK/MO *
18+
* Korea *
19+
* Japan *
20+
21+
> *: The delta-patch feature is tentatively available for this region.
22+
## Honkai: Star Rail
23+
* Global
24+
* Mainland China *
25+
* Bilibili ** *
26+
27+
> *: The delta-patch feature is tentatively available for this region.<br/>
28+
> **: The delta-patch for Mainland China can be applied for Bilibili by renaming the "Region Code" from "SRCN" to "HSRCNBilibili" of the .patch file.
29+
30+
# How-To
31+
### 1. Download the ``.patch`` (Delta-patch) file
32+
Collapse no longer downloads the *Delta-patch* file automatically due to their size. You have to download the "**Delta-patch**" file to be used for the update.
33+
For more up-to-date links, please [join our Discord server!](https://discord.gg/vJd2exaS7j). Once you have joined to the Discord Server, make sure to check the specific #delta-patch channel in the "Git Feeds" category. Then find the link to download the delta-patch file.
34+
35+
[<img width="720" src="https://github.com/user-attachments/assets/70baf253-37da-47a8-a627-f8f0da181153"/>](https://github.com/user-attachments/assets/70baf253-37da-47a8-a627-f8f0da181153)
36+
37+
> Link will not be provided here no more due to changes that might need to be checked before a patch can apply. Please join the server for more up-to-date announcements.
38+
39+
Once you opened the link, you will find the folder which contains each of the version to be updated to.
40+
For example, if you wanted to update your game to version 7.8, then go to ``7.7.0 - 7.8.0`` folder, etc.
41+
42+
You will find a few delta-patch files to choose from. Select the region you want to update to, then click on the "``...``" icon at the right side of the file and select ``Download`` to download the file to your machine.
43+
44+
> Note:
45+
> The following region codes are used to identify regions which are compatible with the Delta Patch update format
46+
> - ``Hi3SEA`` -> Southeast Asia
47+
> - ``Hi3Global`` -> Global
48+
> - ``Hi3CN`` -> Mainland China
49+
50+
[<img width="720" src="https://github.com/user-attachments/assets/e4c8f888-22b1-4d0f-a6dd-05e2e7e0d968"/>](https://github.com/user-attachments/assets/e4c8f888-22b1-4d0f-a6dd-05e2e7e0d968)
51+
52+
### 2. Move the ``.patch`` (Recipe) file to Game Folder
53+
Once the download has finished, move the ``.patch`` file to the game folder.
54+
55+
> To find out where your game is installed, open Collapse, select the correct game & region, and click on the ``Game Settings`` button and find the ``Open Game Folder``
56+
> button to open the game folder.
57+
58+
### 3. Start the Update
59+
Once you have successfully moved the file to your game directory, Collapse will automatically detect click on the Delta-patch file. If it does not, please restart the launcher before attempting the update operation.
60+
61+
Once the file has been detected, click on the ``Update Game`` button and click ``Yes`` at the dialog. While the process is running, please **DO NOT CLOSE** the launcher and **Do not Panic** if the progress bar does not move or the program becomes unresponsive.
62+
63+
> There is a high chance of your game files being corrupted if you interrupt this process. You **cannot** downgrade to a previous version once you update your game. However, you can convert back to your previous version by downloading the correct recipe file. Collapse is not responsible for game data corruption. Update time varies depending on system configuration.
64+
65+
[<img width="1280" src="https://user-images.githubusercontent.com/30566970/171479757-fb49adb9-2658-4c54-b69b-8603d14b3845.png"/>](https://user-images.githubusercontent.com/30566970/171479757-fb49adb9-2658-4c54-b69b-8603d14b3845.png)
66+

‎home/feature/game-commands.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Game Launch Commands | Collapse Launcher
3+
---
4+
# Game Pre-Launch / Post-Exit Commands
5+
This feature allows you to run a command before game being launched and/or after the game has been closed.
6+
7+
::: danger
8+
We are not responsible for what you are running and it's consequence to your system and/or game accounts. You are on your own.
9+
:::
10+
11+
::: warning
12+
Collapse team does not endorse running any commands that injects or modify the game in any way. We are in any way not responsible for anything that happened to your game should you choose to do so.
13+
:::
14+
15+
Here is what you need to know about this feature:
16+
1. If the command you are running is a CLI (Command Line Interface) application, do note that it will be non-interactable. Meaning you cannot input anything to the console of the command.
17+
2. Working directory of the launch commands will be set to where the CollapseLauncher.exe is located. If the application you are trying to run needs to be run in its own directory (e.g. having its own dependencies), you have to add some commands to change it beforehand.
18+
> Example `cd /d C:/testapp/ && C:/testapp/run.exe`
19+
3. This feature will not allow you to change the way Collapse will run the game (e.g. change the executable to be run instead of the game exe itself)

‎home/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ hero:
3434
# text: Documentation
3535
# link: /markdown-examples
3636
- theme: alt
37-
text: Feature Matrix
37+
text: Features
3838
link: /features
3939
- theme: alt
4040
text: Meet the Team

0 commit comments

Comments
 (0)