mirror of
https://github.com/SteamDeckHomebrew/decky-frontend-lib.git
synced 2026-05-20 18:10:08 +02:00
Compare commits
542 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b151bdce8b | ||
|
|
e44664c970 | ||
|
|
ac8da8e9b6 | ||
|
|
b688bc3544 | ||
|
|
3126dd3e04 | ||
|
|
8596294667 | ||
|
|
772a85523b | ||
|
|
aabc522740 | ||
|
|
66e0afccae | ||
|
|
77e6acd828 | ||
|
|
261162c8bc | ||
|
|
f8fda380f1 | ||
|
|
7242c69758 | ||
|
|
fd651eb989 | ||
|
|
6e443c06d3 | ||
|
|
25b4b60e34 | ||
|
|
cf6572cd7b | ||
|
|
779b1ae0de | ||
|
|
366357d9a3 | ||
|
|
37dd88513e | ||
|
|
ed87f73602 | ||
|
|
3d5de65077 | ||
|
|
33d224bc3f | ||
|
|
aa0678c857 | ||
|
|
39fdde9481 | ||
|
|
a4627a70c5 | ||
|
|
1f6611a10f | ||
|
|
c149711265 | ||
|
|
7a4c2af6ec | ||
|
|
fc5cde95d6 | ||
|
|
c4579c8307 | ||
|
|
131ab4cc11 | ||
|
|
7e7a325cd9 | ||
|
|
41d0555d31 | ||
|
|
716f947710 | ||
|
|
ed7ba9bbb6 | ||
|
|
c03db3e0d5 | ||
|
|
aef063d2e2 | ||
|
|
33e5d8541d | ||
|
|
9c34100215 | ||
|
|
a1507ac55b | ||
|
|
484a882015 | ||
|
|
200125cb98 | ||
|
|
5ab8472ffe | ||
|
|
a43cd7f3c5 | ||
|
|
41401b1d01 | ||
|
|
8117693427 | ||
|
|
d80c047580 | ||
|
|
d6ecba605d | ||
|
|
bf58e08e4b | ||
|
|
e965816144 | ||
|
|
59ce9e450c | ||
|
|
980df687e7 | ||
|
|
bea9ac7774 | ||
|
|
063dedbbc1 | ||
|
|
723e2ff76e | ||
|
|
241b22cad7 | ||
|
|
93c59d8026 | ||
|
|
0f9fb5a3b8 | ||
|
|
8c6043b5a7 | ||
|
|
3aa07dc9ce | ||
|
|
3f335b3583 | ||
|
|
4c97097757 | ||
|
|
1ee43e86d6 | ||
|
|
db6ab9c448 | ||
|
|
4646f22b0c | ||
|
|
7eb484d55c | ||
|
|
5164f980b3 | ||
|
|
0457feec95 | ||
|
|
73b8d52c7f | ||
|
|
2b8d2ae4db | ||
|
|
48de8928e4 | ||
|
|
d60715b755 | ||
|
|
a370c1f7d3 | ||
|
|
d83bada4af | ||
|
|
1f7178f175 | ||
|
|
44fdf9ed3b | ||
|
|
1b5fd78bc2 | ||
|
|
d64c42ac31 | ||
|
|
0ec60edf4d | ||
|
|
2c3a9f81de | ||
|
|
00079a71cc | ||
|
|
c04f024b34 | ||
|
|
5dae77b003 | ||
|
|
6b8c28e69c | ||
|
|
3ef9648355 | ||
|
|
0da85355c2 | ||
|
|
dcdbb2d6c7 | ||
|
|
58e3d35e1e | ||
|
|
bd1dc85b92 | ||
|
|
aa78f4c0a2 | ||
|
|
b04044451a | ||
|
|
5d8f141114 | ||
|
|
2bfe62409f | ||
|
|
f5cefa9eea | ||
|
|
abfd2c0105 | ||
|
|
8cb7c273eb | ||
|
|
c440fa76b1 | ||
|
|
4e4859deb6 | ||
|
|
9579c41c6d | ||
|
|
4dd6afd91b | ||
|
|
b092d49bf8 | ||
|
|
7e0cb153b1 | ||
|
|
b1e503853f | ||
|
|
832ad697c7 | ||
|
|
62b454f712 | ||
|
|
ea19d62dab | ||
|
|
9f262097b9 | ||
|
|
e6e8c91ec7 | ||
|
|
688c7471cd | ||
|
|
6c1b12b95f | ||
|
|
0dfb2cedb6 | ||
|
|
2a78cc0116 | ||
|
|
1716782183 | ||
|
|
0cd498beac | ||
|
|
b728d90263 | ||
|
|
3384d2910d | ||
|
|
78c4cdb9e9 | ||
|
|
d20659e073 | ||
|
|
d91f49e728 | ||
|
|
735080fee3 | ||
|
|
86e6e4c0f5 | ||
|
|
46b1d6e8ea | ||
|
|
a7635b6305 | ||
|
|
bffd530bda | ||
|
|
9c79187d37 | ||
|
|
29e6439115 | ||
|
|
a8eeb917e2 | ||
|
|
17b99dfed8 | ||
|
|
9ef419cee1 | ||
|
|
5aad952936 | ||
|
|
c2b0fad298 | ||
|
|
4d4cfedfe0 | ||
|
|
bb12921863 | ||
|
|
223739af25 | ||
|
|
95d977df45 | ||
|
|
0f2692a3f2 | ||
|
|
ebf496bf61 | ||
|
|
0a5170e412 | ||
|
|
11dd82bbb1 | ||
|
|
153bb209d1 | ||
|
|
e27b638d26 | ||
|
|
7d287f10d6 | ||
|
|
9925bc8cfb | ||
|
|
179a93d5e1 | ||
|
|
5203ce348a | ||
|
|
3f47b5ccce | ||
|
|
d22d32677b | ||
|
|
30e319425b | ||
|
|
aebdfaa089 | ||
|
|
de914b1a35 | ||
|
|
4c4fda47e3 | ||
|
|
678084e4fd | ||
|
|
4f8f65d429 | ||
|
|
8a352d288d | ||
|
|
fd0d011cbf | ||
|
|
70219d90bc | ||
|
|
1ff9351f96 | ||
|
|
c256d341c8 | ||
|
|
c9b583945c | ||
|
|
c213204ff4 | ||
|
|
9128c1e7da | ||
|
|
a06650cf09 | ||
|
|
3170779c6b | ||
|
|
5ffa14bec8 | ||
|
|
ee51dc5fc0 | ||
|
|
b38ec17d8f | ||
|
|
8b54ee990e | ||
|
|
7e01781d40 | ||
|
|
2b31473614 | ||
|
|
8bfeae4b35 | ||
|
|
a7761321bc | ||
|
|
979a630f2b | ||
|
|
a4d1fcf086 | ||
|
|
e9e7f5c026 | ||
|
|
9a691cea09 | ||
|
|
44d9b90cdc | ||
|
|
585c3b8348 | ||
|
|
1287493b63 | ||
|
|
bf01a0184b | ||
|
|
fb5f043ba9 | ||
|
|
26f2c92dce | ||
|
|
01e53d4c13 | ||
|
|
18d341f82a | ||
|
|
3ca8c43a54 | ||
|
|
99353467ad | ||
|
|
b093ce93ba | ||
|
|
74a7cbaf94 | ||
|
|
8fb35e3c09 | ||
|
|
5d5cb31638 | ||
|
|
21f1e5f0af | ||
|
|
0fa43701a9 | ||
|
|
4d52eaea12 | ||
|
|
7e1182a83f | ||
|
|
167ded103a | ||
|
|
b8ddf3d927 | ||
|
|
62f4b354a8 | ||
|
|
79d229be50 | ||
|
|
f43157fde5 | ||
|
|
19819b7a5b | ||
|
|
8752f576a7 | ||
|
|
102a441124 | ||
|
|
62f40bd48f | ||
|
|
a7acc9ae45 | ||
|
|
be7f17a3c3 | ||
|
|
5d097b6108 | ||
|
|
ae98930eeb | ||
|
|
6ce0da996d | ||
|
|
b1591f86bb | ||
|
|
f7318f0210 | ||
|
|
1a34501868 | ||
|
|
7dacb23e8b | ||
|
|
7e5c7b5ac3 | ||
|
|
f71e4dedc8 | ||
|
|
419835204e | ||
|
|
86f33de2c0 | ||
|
|
0b6dc24c0d | ||
|
|
18ce1ad790 | ||
|
|
5a074b5bb6 | ||
|
|
26fae13c8e | ||
|
|
53faf55df1 | ||
|
|
b480d397c4 | ||
|
|
dfcb3bec19 | ||
|
|
cf7dc26a0c | ||
|
|
d3b87b26c5 | ||
|
|
b64dd9f723 | ||
|
|
82214fef4c | ||
|
|
e559a43af9 | ||
|
|
c53d7f8448 | ||
|
|
68a46263a4 | ||
|
|
56e7b2c492 | ||
|
|
1282636b0b | ||
|
|
2343274a5b | ||
|
|
f965c05c27 | ||
|
|
f8c8ae7c29 | ||
|
|
3085efd439 | ||
|
|
db8d91a7ff | ||
|
|
2091daaeac | ||
|
|
b1b2f4fa2d | ||
|
|
b146eab8d7 | ||
|
|
667933bd7c | ||
|
|
dbd01b11ca | ||
|
|
47a6fddc89 | ||
|
|
c57e0eed34 | ||
|
|
5adc5e14ed | ||
|
|
cea315a52c | ||
|
|
5b166d6db8 | ||
|
|
edcc43a6ee | ||
|
|
9723854ddc | ||
|
|
7501817b76 | ||
|
|
4affd4aaec | ||
|
|
6b3db72a14 | ||
|
|
58b69f0d6c | ||
|
|
c62102e993 | ||
|
|
2e66e5a555 | ||
|
|
ce525318d8 | ||
|
|
aac2d520a6 | ||
|
|
e761ee02ba | ||
|
|
c53f87b4a9 | ||
|
|
a656f4e57f | ||
|
|
0b50f2cf0b | ||
|
|
e48c7bbadd | ||
|
|
727fcc8186 | ||
|
|
dc196d53f5 | ||
|
|
f0379e5d19 | ||
|
|
fd94842647 | ||
|
|
ef6be8c6ec | ||
|
|
767dc2fcee | ||
|
|
52305987c5 | ||
|
|
6f14da152a | ||
|
|
bb291b211c | ||
|
|
88f245d476 | ||
|
|
5bc78df918 | ||
|
|
c586afb97d | ||
|
|
d9150c2556 | ||
|
|
cd0635e94f | ||
|
|
443c7850d7 | ||
|
|
d24136ecb6 | ||
|
|
55507446cc | ||
|
|
925ea8c3ce | ||
|
|
14c5210931 | ||
|
|
cc29ddaf57 | ||
|
|
1e8979b641 | ||
|
|
7ba1229a4e | ||
|
|
4c2a715324 | ||
|
|
678ba216f1 | ||
|
|
07d15f5dca | ||
|
|
c84a091469 | ||
|
|
3c171cfb8f | ||
|
|
47fd13692f | ||
|
|
2ec9519b7d | ||
|
|
24606190e0 | ||
|
|
ed98d14b37 | ||
|
|
b882612dfa | ||
|
|
32291620b4 | ||
|
|
9b368c5f11 | ||
|
|
e167ef5a13 | ||
|
|
2f3df00967 | ||
|
|
215156d316 | ||
|
|
47d75db690 | ||
|
|
82768e0415 | ||
|
|
e44187fe4b | ||
|
|
72af32436e | ||
|
|
e1f64a38de | ||
|
|
82ed48761d | ||
|
|
a81c342d2a | ||
|
|
68d630262d | ||
|
|
0bb8c67cfa | ||
|
|
edd29e6c5a | ||
|
|
0ed054fae9 | ||
|
|
0d912eac88 | ||
|
|
789e16380f | ||
|
|
88b50bbc1e | ||
|
|
75f35882f2 | ||
|
|
23af4c0bb4 | ||
|
|
a074277bb5 | ||
|
|
9c72a55aff | ||
|
|
92ffc76075 | ||
|
|
fb49d64fd3 | ||
|
|
cfef1dc320 | ||
|
|
f6b4d6b254 | ||
|
|
0010a1fcee | ||
|
|
28cbc1cfe1 | ||
|
|
fe75dfb5f4 | ||
|
|
91c386a6cc | ||
|
|
bedb6b8bb9 | ||
|
|
4cdcca0b5a | ||
|
|
f16e0b29f8 | ||
|
|
37a6658b95 | ||
|
|
ed0b92de2e | ||
|
|
dcba5c22f8 | ||
|
|
fa50ca6a37 | ||
|
|
19e986ed8b | ||
|
|
3c553a227d | ||
|
|
1f2694aec8 | ||
|
|
2e52cca8a2 | ||
|
|
3dbca1a056 | ||
|
|
c6692138c6 | ||
|
|
25c33b2a05 | ||
|
|
00d27d1373 | ||
|
|
5f0470c351 | ||
|
|
c77d6edaae | ||
|
|
c44c66facd | ||
|
|
ce3860f73b | ||
|
|
d8b10a2133 | ||
|
|
1581304dcb | ||
|
|
60ddf474e0 | ||
|
|
52ae328e2e | ||
|
|
276e4eccd2 | ||
|
|
2fc2060a6c | ||
|
|
1143a9f3e0 | ||
|
|
5a5218a7c4 | ||
|
|
8a887ca858 | ||
|
|
0ce1b5499d | ||
|
|
554163cc5d | ||
|
|
d6b00b0733 | ||
|
|
f8ddf210f0 | ||
|
|
4024b76918 | ||
|
|
245dd0f3cf | ||
|
|
7161e757e9 | ||
|
|
c60d1e9787 | ||
|
|
0e0e0d204a | ||
|
|
e5120928d3 | ||
|
|
abbd3cddae | ||
|
|
621e47c6a0 | ||
|
|
e2920dd91e | ||
|
|
67a76e2691 | ||
|
|
0f205e8916 | ||
|
|
472307e4a4 | ||
|
|
fbd936dc1f | ||
|
|
33dd4e5548 | ||
|
|
4b76ccd91a | ||
|
|
99ad7543a9 | ||
|
|
b5dc08a977 | ||
|
|
40871af853 | ||
|
|
c910dbde79 | ||
|
|
4cbb30c21c | ||
|
|
54a1ef6201 | ||
|
|
ed0be5e87e | ||
|
|
a064163b49 | ||
|
|
0b4fcb8d49 | ||
|
|
4233128c7e | ||
|
|
43cb2726d8 | ||
|
|
5d9c506fe7 | ||
|
|
aa0fad2ecf | ||
|
|
dab9071d1e | ||
|
|
35a061759a | ||
|
|
1fbe55aa54 | ||
|
|
189a90ba31 | ||
|
|
66eb0cbbf3 | ||
|
|
6996e5424f | ||
|
|
8509ae8f9a | ||
|
|
a6ebfdcd7d | ||
|
|
5f7655baaf | ||
|
|
bca2dcc9bd | ||
|
|
546a4da043 | ||
|
|
ad643836f0 | ||
|
|
b39ba26b28 | ||
|
|
130dfa24c5 | ||
|
|
71babc82c8 | ||
|
|
bb440deed6 | ||
|
|
064c161b67 | ||
|
|
6abf0efc10 | ||
|
|
537b8301ec | ||
|
|
2ae87da37a | ||
|
|
0d248f3987 | ||
|
|
74aefc7b3c | ||
|
|
16ec1e3d2e | ||
|
|
db41e74cf9 | ||
|
|
6441bde835 | ||
|
|
29201fadaf | ||
|
|
31b81f5edd | ||
|
|
b05f84658a | ||
|
|
218e007234 | ||
|
|
aa35e8b64a | ||
|
|
cd61f57a6f | ||
|
|
8eb921e8b7 | ||
|
|
26017e7de4 | ||
|
|
71c7afa1a6 | ||
|
|
d6a08feca0 | ||
|
|
160fbb493f | ||
|
|
076d9eb5e8 | ||
|
|
f66f5dd794 | ||
|
|
d01c7b3904 | ||
|
|
34f6cf403b | ||
|
|
1dd48cd4c4 | ||
|
|
6842f31190 | ||
|
|
27e1a9c8b0 | ||
|
|
55bd06a5ee | ||
|
|
58550b1f6e | ||
|
|
c25fe58f08 | ||
|
|
ef147c6715 | ||
|
|
43e9417303 | ||
|
|
cf137c43b4 | ||
|
|
8167be7642 | ||
|
|
a09af357c7 | ||
|
|
e48180d7bb | ||
|
|
490a1f77fa | ||
|
|
d1b47d21ed | ||
|
|
af98a76b86 | ||
|
|
d18b1ba1ed | ||
|
|
6be06446f2 | ||
|
|
bb8a6df115 | ||
|
|
a672230b00 | ||
|
|
4644df8202 | ||
|
|
7d3b5e8123 | ||
|
|
0a4ef14239 | ||
|
|
a592883a2e | ||
|
|
3f126fe471 | ||
|
|
e644de35d7 | ||
|
|
9b79f70ac7 | ||
|
|
d237bd48e4 | ||
|
|
f7d73b4dc3 | ||
|
|
9edb1e6b97 | ||
|
|
605e4f5eae | ||
|
|
e2f675835e | ||
|
|
b7dc1d6275 | ||
|
|
a1fdae9cd2 | ||
|
|
7cf45cf371 | ||
|
|
df1c8dbb8b | ||
|
|
1de979f713 | ||
|
|
f23070a82a | ||
|
|
b87e7c2f40 | ||
|
|
6db29a9a6e | ||
|
|
e2126afd06 | ||
|
|
cea587958e | ||
|
|
b21dfcdb66 | ||
|
|
d46251bb91 | ||
|
|
5b29447cfa | ||
|
|
e993d06963 | ||
|
|
a3c136a07e | ||
|
|
994b9e2cc6 | ||
|
|
801d70f300 | ||
|
|
2fdfcdd478 | ||
|
|
9a728611f4 | ||
|
|
97997adfaf | ||
|
|
279069ee34 | ||
|
|
944a9024ff | ||
|
|
0a2220b4b4 | ||
|
|
aa567e9dd0 | ||
|
|
d9e4ff3ebd | ||
|
|
79d73dea2e | ||
|
|
602f93ae6a | ||
|
|
d86c86cd80 | ||
|
|
51c418d560 | ||
|
|
95de7346df | ||
|
|
58933f827c | ||
|
|
0ff3476987 | ||
|
|
2c7d266c81 | ||
|
|
9bd96227a0 | ||
|
|
ddafa5666d | ||
|
|
46977496fd | ||
|
|
71a6c79384 | ||
|
|
da4c79b5ae | ||
|
|
7b04bf5827 | ||
|
|
a87e1bb46f | ||
|
|
b6e2e7e4dc | ||
|
|
7d82a82e9c | ||
|
|
0cee60d122 | ||
|
|
7efc0347f7 | ||
|
|
d227858e62 | ||
|
|
db64f34725 | ||
|
|
b08aadb810 | ||
|
|
2afb7f16bb | ||
|
|
32d1303191 | ||
|
|
1ce15d261f | ||
|
|
bf52e0761c | ||
|
|
823a2745f9 | ||
|
|
21f7874cab | ||
|
|
077334e376 | ||
|
|
02f4c5c518 | ||
|
|
f1e20cd0b5 | ||
|
|
b5d9265705 | ||
|
|
734ce33e1b | ||
|
|
9beab5f7e9 | ||
|
|
33aaf56f96 | ||
|
|
dddb703a2e | ||
|
|
ea2e072085 | ||
|
|
6324282b48 | ||
|
|
ace3f95a33 | ||
|
|
4d30efc33b | ||
|
|
af2d3a29e2 | ||
|
|
e5e561edd6 | ||
|
|
7111d18667 | ||
|
|
24244f6e91 | ||
|
|
dd5c42c57d | ||
|
|
09ab2fed4b | ||
|
|
4328385391 | ||
|
|
3fe986aaba | ||
|
|
bc2bec4b83 | ||
|
|
a99fb4a22d | ||
|
|
d8794ef4d3 | ||
|
|
23ed5dd157 | ||
|
|
210b0389f7 | ||
|
|
198f96abb5 | ||
|
|
244ae128da | ||
|
|
377d7adde8 | ||
|
|
f34b9de97f | ||
|
|
b5192cf590 | ||
|
|
2e7b4b664a | ||
|
|
b92e6a5b9d | ||
|
|
32c355f2a7 |
55
.github/workflows/docs.yaml
vendored
Normal file
55
.github/workflows/docs.yaml
vendored
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
name: Generate docs
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
# push:
|
||||||
|
# branches:
|
||||||
|
# - main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
name: Generate Docs
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
steps:
|
||||||
|
- name: Setup | Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
path: lib
|
||||||
|
- name: Setup | Checkout wiki
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
repository: SteamDeckHomebrew/wiki
|
||||||
|
path: wiki
|
||||||
|
ssh-key: ${{ secrets.SSH_DEPLOY_KEY }}
|
||||||
|
persist-credentials: true
|
||||||
|
- name: Setup | Node.js
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 18
|
||||||
|
- name: Setup | Dependencies
|
||||||
|
run: |
|
||||||
|
cd lib
|
||||||
|
npm i -g pnpm
|
||||||
|
pnpm i --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Build Docs
|
||||||
|
run: |
|
||||||
|
cd lib
|
||||||
|
pnpm run docs --out ../wiki/api-docs/decky-frontend-lib
|
||||||
|
|
||||||
|
- name: Commit files
|
||||||
|
run: |
|
||||||
|
cd wiki
|
||||||
|
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||||
|
git config --local user.name "github-actions[bot]"
|
||||||
|
git add -A ./api-docs/decky-frontend-lib
|
||||||
|
git commit -m "Update decky-frontend-lib API docs"
|
||||||
|
|
||||||
|
- name: Push changes
|
||||||
|
uses: ad-m/github-push-action@master
|
||||||
|
with:
|
||||||
|
ssh: true
|
||||||
|
directory: ./wiki
|
||||||
|
repository: SteamDeckHomebrew/wiki
|
||||||
|
branch: main
|
||||||
21
.github/workflows/release.yaml
vendored
21
.github/workflows/release.yaml
vendored
@@ -1,29 +1,36 @@
|
|||||||
name: Release
|
name: Release
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
pull_request:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
id-token: write
|
||||||
|
contents: write
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
name: Release
|
name: Release
|
||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: Setup | Node.js
|
- name: Setup | Node.js
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v4
|
||||||
with:
|
with:
|
||||||
node-version: 16
|
node-version: 24
|
||||||
- name: Setup | Dependencies
|
- name: Setup | Dependencies
|
||||||
run: npm ci
|
run: npm i -g pnpm && pnpm i --frozen-lockfile
|
||||||
|
- name: Build
|
||||||
|
run: pnpm run build
|
||||||
- name: Test
|
- name: Test
|
||||||
run: npm test
|
run: pnpm run test
|
||||||
- name: Release
|
- name: Release
|
||||||
|
if: github.event_name != 'pull_request'
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
run: pnpm exec semantic-release
|
||||||
run: npm exec semantic-release
|
|
||||||
|
|||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -36,5 +36,4 @@ dist/
|
|||||||
|
|
||||||
research/
|
research/
|
||||||
|
|
||||||
# PNPM lockfile
|
docs/
|
||||||
pnpm-lock.yaml
|
|
||||||
@@ -1,4 +1 @@
|
|||||||
#!/usr/bin/env sh
|
|
||||||
. "$(dirname -- "$0")/_/husky.sh"
|
|
||||||
|
|
||||||
npx --no -- commitlint --edit "${1}"
|
npx --no -- commitlint --edit "${1}"
|
||||||
|
|||||||
@@ -1,7 +1,17 @@
|
|||||||
{
|
{
|
||||||
"branches": ["main", "dev"],
|
"branches": ["main", "v4-dev"],
|
||||||
"plugins": [
|
"plugins": [
|
||||||
"@semantic-release/commit-analyzer",
|
[
|
||||||
|
"@semantic-release/commit-analyzer",
|
||||||
|
{
|
||||||
|
"preset": "angular",
|
||||||
|
"releaseRules": [
|
||||||
|
{ "type": "chore", "scope": "classes", "release": "patch" },
|
||||||
|
{ "type": "docs", "scope": "steamclient", "release": "patch" },
|
||||||
|
{ "type": "*", "scope": "docs", "release": false }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
"@semantic-release/release-notes-generator",
|
"@semantic-release/release-notes-generator",
|
||||||
"@semantic-release/changelog",
|
"@semantic-release/changelog",
|
||||||
"@semantic-release/npm",
|
"@semantic-release/npm",
|
||||||
@@ -9,7 +19,7 @@
|
|||||||
[
|
[
|
||||||
"@semantic-release/git",
|
"@semantic-release/git",
|
||||||
{
|
{
|
||||||
"assets": ["CHANGELOG.md", "package.json"],
|
"assets": ["CHANGELOG.md", "package.json", "package-lock.json"],
|
||||||
"message": "chore(release): ${nextRelease.version} [CI SKIP]"
|
"message": "chore(release): ${nextRelease.version} [CI SKIP]"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
13
.vscode/tasks.json
vendored
Normal file
13
.vscode/tasks.json
vendored
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"version": "2.0.0",
|
||||||
|
"tasks": [
|
||||||
|
{
|
||||||
|
"type": "npm",
|
||||||
|
"script": "dev",
|
||||||
|
"problemMatcher": ["$tsc-watch"],
|
||||||
|
"label": "npm: dev",
|
||||||
|
"detail": "tsc -b -w",
|
||||||
|
"isBackground": true
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
1411
CHANGELOG.md
1411
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
686
LICENSE
686
LICENSE
@@ -1,223 +1,398 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
Version 2, June 1991
|
Version 2.1, February 1999
|
||||||
|
|
||||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
of this license document, but changing it is not allowed.
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
Preamble
|
[This is the first released version of the Lesser GPL. It also counts
|
||||||
|
as the successor of the GNU Library Public License, version 2, hence
|
||||||
|
the version number 2.1.]
|
||||||
|
|
||||||
The licenses for most software are designed to take away your
|
Preamble
|
||||||
freedom to share and change it. By contrast, the GNU General Public
|
|
||||||
License is intended to guarantee your freedom to share and change free
|
|
||||||
software--to make sure the software is free for all its users. This
|
|
||||||
General Public License applies to most of the Free Software
|
|
||||||
Foundation's software and to any other program whose authors commit to
|
|
||||||
using it. (Some other Free Software Foundation software is covered by
|
|
||||||
the GNU Lesser General Public License instead.) You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
The licenses for most software are designed to take away your
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
freedom to share and change it. By contrast, the GNU General Public
|
||||||
have the freedom to distribute copies of free software (and charge for
|
Licenses are intended to guarantee your freedom to share and change
|
||||||
this service if you wish), that you receive source code or can get it
|
free software--to make sure the software is free for all its users.
|
||||||
if you want it, that you can change the software or use pieces of it
|
|
||||||
in new free programs; and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to make restrictions that forbid
|
This license, the Lesser General Public License, applies to some
|
||||||
anyone to deny you these rights or to ask you to surrender the rights.
|
specially designated software packages--typically libraries--of the
|
||||||
These restrictions translate to certain responsibilities for you if you
|
Free Software Foundation and other authors who decide to use it. You
|
||||||
distribute copies of the software, or if you modify it.
|
can use it too, but we suggest you first think carefully about whether
|
||||||
|
this license or the ordinary General Public License is the better
|
||||||
|
strategy to use in any particular case, based on the explanations below.
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
When we speak of free software, we are referring to freedom of use,
|
||||||
gratis or for a fee, you must give the recipients all the rights that
|
not price. Our General Public Licenses are designed to make sure that
|
||||||
you have. You must make sure that they, too, receive or can get the
|
you have the freedom to distribute copies of free software (and charge
|
||||||
source code. And you must show them these terms so they know their
|
for this service if you wish); that you receive source code or can get
|
||||||
rights.
|
it if you want it; that you can change the software and use pieces of
|
||||||
|
it in new free programs; and that you are informed that you can do
|
||||||
|
these things.
|
||||||
|
|
||||||
We protect your rights with two steps: (1) copyright the software, and
|
To protect your rights, we need to make restrictions that forbid
|
||||||
(2) offer you this license which gives you legal permission to copy,
|
distributors to deny you these rights or to ask you to surrender these
|
||||||
distribute and/or modify the software.
|
rights. These restrictions translate to certain responsibilities for
|
||||||
|
you if you distribute copies of the library or if you modify it.
|
||||||
|
|
||||||
Also, for each author's protection and ours, we want to make certain
|
For example, if you distribute copies of the library, whether gratis
|
||||||
that everyone understands that there is no warranty for this free
|
or for a fee, you must give the recipients all the rights that we gave
|
||||||
software. If the software is modified by someone else and passed on, we
|
you. You must make sure that they, too, receive or can get the source
|
||||||
want its recipients to know that what they have is not the original, so
|
code. If you link other code with the library, you must provide
|
||||||
that any problems introduced by others will not reflect on the original
|
complete object files to the recipients, so that they can relink them
|
||||||
authors' reputations.
|
with the library after making changes to the library and recompiling
|
||||||
|
it. And you must show them these terms so they know their rights.
|
||||||
|
|
||||||
Finally, any free program is threatened constantly by software
|
We protect your rights with a two-step method: (1) we copyright the
|
||||||
patents. We wish to avoid the danger that redistributors of a free
|
library, and (2) we offer you this license, which gives you legal
|
||||||
program will individually obtain patent licenses, in effect making the
|
permission to copy, distribute and/or modify the library.
|
||||||
program proprietary. To prevent this, we have made it clear that any
|
|
||||||
patent must be licensed for everyone's free use or not licensed at all.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
To protect each distributor, we want to make it very clear that
|
||||||
modification follow.
|
there is no warranty for the free library. Also, if the library is
|
||||||
|
modified by someone else and passed on, the recipients should know
|
||||||
|
that what they have is not the original version, so that the original
|
||||||
|
author's reputation will not be affected by problems that might be
|
||||||
|
introduced by others.
|
||||||
|
|
||||||
GNU GENERAL PUBLIC LICENSE
|
Finally, software patents pose a constant threat to the existence of
|
||||||
|
any free program. We wish to make sure that a company cannot
|
||||||
|
effectively restrict the users of a free program by obtaining a
|
||||||
|
restrictive license from a patent holder. Therefore, we insist that
|
||||||
|
any patent license obtained for a version of the library must be
|
||||||
|
consistent with the full freedom of use specified in this license.
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
Most GNU software, including some libraries, is covered by the
|
||||||
|
ordinary GNU General Public License. This license, the GNU Lesser
|
||||||
|
General Public License, applies to certain designated libraries, and
|
||||||
|
is quite different from the ordinary General Public License. We use
|
||||||
|
this license for certain libraries in order to permit linking those
|
||||||
|
libraries into non-free programs.
|
||||||
|
|
||||||
0. This License applies to any program or other work which contains
|
When a program is linked with a library, whether statically or using
|
||||||
a notice placed by the copyright holder saying it may be distributed
|
a shared library, the combination of the two is legally speaking a
|
||||||
under the terms of this General Public License. The "Program", below,
|
combined work, a derivative of the original library. The ordinary
|
||||||
refers to any such program or work, and a "work based on the Program"
|
General Public License therefore permits such linking only if the
|
||||||
means either the Program or any derivative work under copyright law:
|
entire combination fits its criteria of freedom. The Lesser General
|
||||||
that is to say, a work containing the Program or a portion of it,
|
Public License permits more lax criteria for linking other code with
|
||||||
either verbatim or with modifications and/or translated into another
|
the library.
|
||||||
language. (Hereinafter, translation is included without limitation in
|
|
||||||
the term "modification".) Each licensee is addressed as "you".
|
|
||||||
|
|
||||||
Activities other than copying, distribution and modification are not
|
We call this license the "Lesser" General Public License because it
|
||||||
covered by this License; they are outside its scope. The act of
|
does Less to protect the user's freedom than the ordinary General
|
||||||
running the Program is not restricted, and the output from the Program
|
Public License. It also provides other free software developers Less
|
||||||
is covered only if its contents constitute a work based on the
|
of an advantage over competing non-free programs. These disadvantages
|
||||||
Program (independent of having been made by running the Program).
|
are the reason we use the ordinary General Public License for many
|
||||||
Whether that is true depends on what the Program does.
|
libraries. However, the Lesser license provides advantages in certain
|
||||||
|
special circumstances.
|
||||||
|
|
||||||
1. You may copy and distribute verbatim copies of the Program's
|
For example, on rare occasions, there may be a special need to
|
||||||
source code as you receive it, in any medium, provided that you
|
encourage the widest possible use of a certain library, so that it becomes
|
||||||
conspicuously and appropriately publish on each copy an appropriate
|
a de-facto standard. To achieve this, non-free programs must be
|
||||||
copyright notice and disclaimer of warranty; keep intact all the
|
allowed to use the library. A more frequent case is that a free
|
||||||
notices that refer to this License and to the absence of any warranty;
|
library does the same job as widely used non-free libraries. In this
|
||||||
and give any other recipients of the Program a copy of this License
|
case, there is little to gain by limiting the free library to free
|
||||||
along with the Program.
|
software only, so we use the Lesser General Public License.
|
||||||
|
|
||||||
You may charge a fee for the physical act of transferring a copy, and
|
In other cases, permission to use a particular library in non-free
|
||||||
you may at your option offer warranty protection in exchange for a fee.
|
programs enables a greater number of people to use a large body of
|
||||||
|
free software. For example, permission to use the GNU C Library in
|
||||||
|
non-free programs enables many more people to use the whole GNU
|
||||||
|
operating system, as well as its variant, the GNU/Linux operating
|
||||||
|
system.
|
||||||
|
|
||||||
2. You may modify your copy or copies of the Program or any portion
|
Although the Lesser General Public License is Less protective of the
|
||||||
of it, thus forming a work based on the Program, and copy and
|
users' freedom, it does ensure that the user of a program that is
|
||||||
distribute such modifications or work under the terms of Section 1
|
linked with the Library has the freedom and the wherewithal to run
|
||||||
above, provided that you also meet all of these conditions:
|
that program using a modified version of the Library.
|
||||||
|
|
||||||
a) You must cause the modified files to carry prominent notices
|
The precise terms and conditions for copying, distribution and
|
||||||
stating that you changed the files and the date of any change.
|
modification follow. Pay close attention to the difference between a
|
||||||
|
"work based on the library" and a "work that uses the library". The
|
||||||
|
former contains code derived from the library, whereas the latter must
|
||||||
|
be combined with the library in order to run.
|
||||||
|
|
||||||
b) You must cause any work that you distribute or publish, that in
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
whole or in part contains or is derived from the Program or any
|
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||||
part thereof, to be licensed as a whole at no charge to all third
|
|
||||||
parties under the terms of this License.
|
|
||||||
|
|
||||||
c) If the modified program normally reads commands interactively
|
0. This License Agreement applies to any software library or other
|
||||||
when run, you must cause it, when started running for such
|
program which contains a notice placed by the copyright holder or
|
||||||
interactive use in the most ordinary way, to print or display an
|
other authorized party saying it may be distributed under the terms of
|
||||||
announcement including an appropriate copyright notice and a
|
this Lesser General Public License (also called "this License").
|
||||||
notice that there is no warranty (or else, saying that you provide
|
Each licensee is addressed as "you".
|
||||||
a warranty) and that users may redistribute the program under
|
|
||||||
these conditions, and telling the user how to view a copy of this
|
|
||||||
License. (Exception: if the Program itself is interactive but
|
|
||||||
does not normally print such an announcement, your work based on
|
|
||||||
the Program is not required to print an announcement.)
|
|
||||||
|
|
||||||
These requirements apply to the modified work as a whole. If
|
A "library" means a collection of software functions and/or data
|
||||||
identifiable sections of that work are not derived from the Program,
|
prepared so as to be conveniently linked with application programs
|
||||||
|
(which use some of those functions and data) to form executables.
|
||||||
|
|
||||||
|
The "Library", below, refers to any such software library or work
|
||||||
|
which has been distributed under these terms. A "work based on the
|
||||||
|
Library" means either the Library or any derivative work under
|
||||||
|
copyright law: that is to say, a work containing the Library or a
|
||||||
|
portion of it, either verbatim or with modifications and/or translated
|
||||||
|
straightforwardly into another language. (Hereinafter, translation is
|
||||||
|
included without limitation in the term "modification".)
|
||||||
|
|
||||||
|
"Source code" for a work means the preferred form of the work for
|
||||||
|
making modifications to it. For a library, complete source code means
|
||||||
|
all the source code for all modules it contains, plus any associated
|
||||||
|
interface definition files, plus the scripts used to control compilation
|
||||||
|
and installation of the library.
|
||||||
|
|
||||||
|
Activities other than copying, distribution and modification are not
|
||||||
|
covered by this License; they are outside its scope. The act of
|
||||||
|
running a program using the Library is not restricted, and output from
|
||||||
|
such a program is covered only if its contents constitute a work based
|
||||||
|
on the Library (independent of the use of the Library in a tool for
|
||||||
|
writing it). Whether that is true depends on what the Library does
|
||||||
|
and what the program that uses the Library does.
|
||||||
|
|
||||||
|
1. You may copy and distribute verbatim copies of the Library's
|
||||||
|
complete source code as you receive it, in any medium, provided that
|
||||||
|
you conspicuously and appropriately publish on each copy an
|
||||||
|
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||||
|
all the notices that refer to this License and to the absence of any
|
||||||
|
warranty; and distribute a copy of this License along with the
|
||||||
|
Library.
|
||||||
|
|
||||||
|
You may charge a fee for the physical act of transferring a copy,
|
||||||
|
and you may at your option offer warranty protection in exchange for a
|
||||||
|
fee.
|
||||||
|
|
||||||
|
2. You may modify your copy or copies of the Library or any portion
|
||||||
|
of it, thus forming a work based on the Library, and copy and
|
||||||
|
distribute such modifications or work under the terms of Section 1
|
||||||
|
above, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The modified work must itself be a software library.
|
||||||
|
|
||||||
|
b) You must cause the files modified to carry prominent notices
|
||||||
|
stating that you changed the files and the date of any change.
|
||||||
|
|
||||||
|
c) You must cause the whole of the work to be licensed at no
|
||||||
|
charge to all third parties under the terms of this License.
|
||||||
|
|
||||||
|
d) If a facility in the modified Library refers to a function or a
|
||||||
|
table of data to be supplied by an application program that uses
|
||||||
|
the facility, other than as an argument passed when the facility
|
||||||
|
is invoked, then you must make a good faith effort to ensure that,
|
||||||
|
in the event an application does not supply such function or
|
||||||
|
table, the facility still operates, and performs whatever part of
|
||||||
|
its purpose remains meaningful.
|
||||||
|
|
||||||
|
(For example, a function in a library to compute square roots has
|
||||||
|
a purpose that is entirely well-defined independent of the
|
||||||
|
application. Therefore, Subsection 2d requires that any
|
||||||
|
application-supplied function or table used by this function must
|
||||||
|
be optional: if the application does not supply it, the square
|
||||||
|
root function must still compute square roots.)
|
||||||
|
|
||||||
|
These requirements apply to the modified work as a whole. If
|
||||||
|
identifiable sections of that work are not derived from the Library,
|
||||||
and can be reasonably considered independent and separate works in
|
and can be reasonably considered independent and separate works in
|
||||||
themselves, then this License, and its terms, do not apply to those
|
themselves, then this License, and its terms, do not apply to those
|
||||||
sections when you distribute them as separate works. But when you
|
sections when you distribute them as separate works. But when you
|
||||||
distribute the same sections as part of a whole which is a work based
|
distribute the same sections as part of a whole which is a work based
|
||||||
on the Program, the distribution of the whole must be on the terms of
|
on the Library, the distribution of the whole must be on the terms of
|
||||||
this License, whose permissions for other licensees extend to the
|
this License, whose permissions for other licensees extend to the
|
||||||
entire whole, and thus to each and every part regardless of who wrote it.
|
entire whole, and thus to each and every part regardless of who wrote
|
||||||
|
it.
|
||||||
|
|
||||||
Thus, it is not the intent of this section to claim rights or contest
|
Thus, it is not the intent of this section to claim rights or contest
|
||||||
your rights to work written entirely by you; rather, the intent is to
|
your rights to work written entirely by you; rather, the intent is to
|
||||||
exercise the right to control the distribution of derivative or
|
exercise the right to control the distribution of derivative or
|
||||||
collective works based on the Program.
|
collective works based on the Library.
|
||||||
|
|
||||||
In addition, mere aggregation of another work not based on the Program
|
In addition, mere aggregation of another work not based on the Library
|
||||||
with the Program (or with a work based on the Program) on a volume of
|
with the Library (or with a work based on the Library) on a volume of
|
||||||
a storage or distribution medium does not bring the other work under
|
a storage or distribution medium does not bring the other work under
|
||||||
the scope of this License.
|
the scope of this License.
|
||||||
|
|
||||||
3. You may copy and distribute the Program (or a work based on it,
|
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||||
under Section 2) in object code or executable form under the terms of
|
License instead of this License to a given copy of the Library. To do
|
||||||
Sections 1 and 2 above provided that you also do one of the following:
|
this, you must alter all the notices that refer to this License, so
|
||||||
|
that they refer to the ordinary GNU General Public License, version 2,
|
||||||
|
instead of to this License. (If a newer version than version 2 of the
|
||||||
|
ordinary GNU General Public License has appeared, then you can specify
|
||||||
|
that version instead if you wish.) Do not make any other change in
|
||||||
|
these notices.
|
||||||
|
|
||||||
a) Accompany it with the complete corresponding machine-readable
|
Once this change is made in a given copy, it is irreversible for
|
||||||
source code, which must be distributed under the terms of Sections
|
that copy, so the ordinary GNU General Public License applies to all
|
||||||
1 and 2 above on a medium customarily used for software interchange; or,
|
subsequent copies and derivative works made from that copy.
|
||||||
|
|
||||||
b) Accompany it with a written offer, valid for at least three
|
This option is useful when you wish to copy part of the code of
|
||||||
years, to give any third party, for a charge no more than your
|
the Library into a program that is not a library.
|
||||||
cost of physically performing source distribution, a complete
|
|
||||||
machine-readable copy of the corresponding source code, to be
|
|
||||||
distributed under the terms of Sections 1 and 2 above on a medium
|
|
||||||
customarily used for software interchange; or,
|
|
||||||
|
|
||||||
c) Accompany it with the information you received as to the offer
|
4. You may copy and distribute the Library (or a portion or
|
||||||
to distribute corresponding source code. (This alternative is
|
derivative of it, under Section 2) in object code or executable form
|
||||||
allowed only for noncommercial distribution and only if you
|
under the terms of Sections 1 and 2 above provided that you accompany
|
||||||
received the program in object code or executable form with such
|
it with the complete corresponding machine-readable source code, which
|
||||||
an offer, in accord with Subsection b above.)
|
must be distributed under the terms of Sections 1 and 2 above on a
|
||||||
|
medium customarily used for software interchange.
|
||||||
|
|
||||||
The source code for a work means the preferred form of the work for
|
If distribution of object code is made by offering access to copy
|
||||||
making modifications to it. For an executable work, complete source
|
from a designated place, then offering equivalent access to copy the
|
||||||
code means all the source code for all modules it contains, plus any
|
source code from the same place satisfies the requirement to
|
||||||
associated interface definition files, plus the scripts used to
|
distribute the source code, even though third parties are not
|
||||||
control compilation and installation of the executable. However, as a
|
|
||||||
special exception, the source code distributed need not include
|
|
||||||
anything that is normally distributed (in either source or binary
|
|
||||||
form) with the major components (compiler, kernel, and so on) of the
|
|
||||||
operating system on which the executable runs, unless that component
|
|
||||||
itself accompanies the executable.
|
|
||||||
|
|
||||||
If distribution of executable or object code is made by offering
|
|
||||||
access to copy from a designated place, then offering equivalent
|
|
||||||
access to copy the source code from the same place counts as
|
|
||||||
distribution of the source code, even though third parties are not
|
|
||||||
compelled to copy the source along with the object code.
|
compelled to copy the source along with the object code.
|
||||||
|
|
||||||
4. You may not copy, modify, sublicense, or distribute the Program
|
5. A program that contains no derivative of any portion of the
|
||||||
except as expressly provided under this License. Any attempt
|
Library, but is designed to work with the Library by being compiled or
|
||||||
otherwise to copy, modify, sublicense or distribute the Program is
|
linked with it, is called a "work that uses the Library". Such a
|
||||||
void, and will automatically terminate your rights under this License.
|
work, in isolation, is not a derivative work of the Library, and
|
||||||
However, parties who have received copies, or rights, from you under
|
therefore falls outside the scope of this License.
|
||||||
this License will not have their licenses terminated so long as such
|
|
||||||
parties remain in full compliance.
|
|
||||||
|
|
||||||
5. You are not required to accept this License, since you have not
|
However, linking a "work that uses the Library" with the Library
|
||||||
signed it. However, nothing else grants you permission to modify or
|
creates an executable that is a derivative of the Library (because it
|
||||||
distribute the Program or its derivative works. These actions are
|
contains portions of the Library), rather than a "work that uses the
|
||||||
prohibited by law if you do not accept this License. Therefore, by
|
library". The executable is therefore covered by this License.
|
||||||
modifying or distributing the Program (or any work based on the
|
Section 6 states terms for distribution of such executables.
|
||||||
Program), you indicate your acceptance of this License to do so, and
|
|
||||||
all its terms and conditions for copying, distributing or modifying
|
|
||||||
the Program or works based on it.
|
|
||||||
|
|
||||||
6. Each time you redistribute the Program (or any work based on the
|
When a "work that uses the Library" uses material from a header file
|
||||||
Program), the recipient automatically receives a license from the
|
that is part of the Library, the object code for the work may be a
|
||||||
original licensor to copy, distribute or modify the Program subject to
|
derivative work of the Library even though the source code is not.
|
||||||
these terms and conditions. You may not impose any further
|
Whether this is true is especially significant if the work can be
|
||||||
restrictions on the recipients' exercise of the rights granted herein.
|
linked without the Library, or if the work is itself a library. The
|
||||||
You are not responsible for enforcing compliance by third parties to
|
threshold for this to be true is not precisely defined by law.
|
||||||
this License.
|
|
||||||
|
|
||||||
7. If, as a consequence of a court judgment or allegation of patent
|
If such an object file uses only numerical parameters, data
|
||||||
infringement or for any other reason (not limited to patent issues),
|
structure layouts and accessors, and small macros and small inline
|
||||||
conditions are imposed on you (whether by court order, agreement or
|
functions (ten lines or less in length), then the use of the object
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
file is unrestricted, regardless of whether it is legally a derivative
|
||||||
excuse you from the conditions of this License. If you cannot
|
work. (Executables containing this object code plus portions of the
|
||||||
distribute so as to satisfy simultaneously your obligations under this
|
Library will still fall under Section 6.)
|
||||||
License and any other pertinent obligations, then as a consequence you
|
|
||||||
may not distribute the Program at all. For example, if a patent
|
|
||||||
license would not permit royalty-free redistribution of the Program by
|
|
||||||
all those who receive copies directly or indirectly through you, then
|
|
||||||
the only way you could satisfy both it and this License would be to
|
|
||||||
refrain entirely from distribution of the Program.
|
|
||||||
|
|
||||||
If any portion of this section is held invalid or unenforceable under
|
Otherwise, if the work is a derivative of the Library, you may
|
||||||
any particular circumstance, the balance of the section is intended to
|
distribute the object code for the work under the terms of Section 6.
|
||||||
apply and the section as a whole is intended to apply in other
|
Any executables containing that work also fall under Section 6,
|
||||||
circumstances.
|
whether or not they are linked directly with the Library itself.
|
||||||
|
|
||||||
|
6. As an exception to the Sections above, you may also combine or
|
||||||
|
link a "work that uses the Library" with the Library to produce a
|
||||||
|
work containing portions of the Library, and distribute that work
|
||||||
|
under terms of your choice, provided that the terms permit
|
||||||
|
modification of the work for the customer's own use and reverse
|
||||||
|
engineering for debugging such modifications.
|
||||||
|
|
||||||
|
You must give prominent notice with each copy of the work that the
|
||||||
|
Library is used in it and that the Library and its use are covered by
|
||||||
|
this License. You must supply a copy of this License. If the work
|
||||||
|
during execution displays copyright notices, you must include the
|
||||||
|
copyright notice for the Library among them, as well as a reference
|
||||||
|
directing the user to the copy of this License. Also, you must do one
|
||||||
|
of these things:
|
||||||
|
|
||||||
|
a) Accompany the work with the complete corresponding
|
||||||
|
machine-readable source code for the Library including whatever
|
||||||
|
changes were used in the work (which must be distributed under
|
||||||
|
Sections 1 and 2 above); and, if the work is an executable linked
|
||||||
|
with the Library, with the complete machine-readable "work that
|
||||||
|
uses the Library", as object code and/or source code, so that the
|
||||||
|
user can modify the Library and then relink to produce a modified
|
||||||
|
executable containing the modified Library. (It is understood
|
||||||
|
that the user who changes the contents of definitions files in the
|
||||||
|
Library will not necessarily be able to recompile the application
|
||||||
|
to use the modified definitions.)
|
||||||
|
|
||||||
|
b) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (1) uses at run time a
|
||||||
|
copy of the library already present on the user's computer system,
|
||||||
|
rather than copying library functions into the executable, and (2)
|
||||||
|
will operate properly with a modified version of the library, if
|
||||||
|
the user installs one, as long as the modified version is
|
||||||
|
interface-compatible with the version that the work was made with.
|
||||||
|
|
||||||
|
c) Accompany the work with a written offer, valid for at
|
||||||
|
least three years, to give the same user the materials
|
||||||
|
specified in Subsection 6a, above, for a charge no more
|
||||||
|
than the cost of performing this distribution.
|
||||||
|
|
||||||
|
d) If distribution of the work is made by offering access to copy
|
||||||
|
from a designated place, offer equivalent access to copy the above
|
||||||
|
specified materials from the same place.
|
||||||
|
|
||||||
|
e) Verify that the user has already received a copy of these
|
||||||
|
materials or that you have already sent this user a copy.
|
||||||
|
|
||||||
|
For an executable, the required form of the "work that uses the
|
||||||
|
Library" must include any data and utility programs needed for
|
||||||
|
reproducing the executable from it. However, as a special exception,
|
||||||
|
the materials to be distributed need not include anything that is
|
||||||
|
normally distributed (in either source or binary form) with the major
|
||||||
|
components (compiler, kernel, and so on) of the operating system on
|
||||||
|
which the executable runs, unless that component itself accompanies
|
||||||
|
the executable.
|
||||||
|
|
||||||
|
It may happen that this requirement contradicts the license
|
||||||
|
restrictions of other proprietary libraries that do not normally
|
||||||
|
accompany the operating system. Such a contradiction means you cannot
|
||||||
|
use both them and the Library together in an executable that you
|
||||||
|
distribute.
|
||||||
|
|
||||||
|
7. You may place library facilities that are a work based on the
|
||||||
|
Library side-by-side in a single library together with other library
|
||||||
|
facilities not covered by this License, and distribute such a combined
|
||||||
|
library, provided that the separate distribution of the work based on
|
||||||
|
the Library and of the other library facilities is otherwise
|
||||||
|
permitted, and provided that you do these two things:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work
|
||||||
|
based on the Library, uncombined with any other library
|
||||||
|
facilities. This must be distributed under the terms of the
|
||||||
|
Sections above.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library of the fact
|
||||||
|
that part of it is a work based on the Library, and explaining
|
||||||
|
where to find the accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
8. You may not copy, modify, sublicense, link with, or distribute
|
||||||
|
the Library except as expressly provided under this License. Any
|
||||||
|
attempt otherwise to copy, modify, sublicense, link with, or
|
||||||
|
distribute the Library is void, and will automatically terminate your
|
||||||
|
rights under this License. However, parties who have received copies,
|
||||||
|
or rights, from you under this License will not have their licenses
|
||||||
|
terminated so long as such parties remain in full compliance.
|
||||||
|
|
||||||
|
9. You are not required to accept this License, since you have not
|
||||||
|
signed it. However, nothing else grants you permission to modify or
|
||||||
|
distribute the Library or its derivative works. These actions are
|
||||||
|
prohibited by law if you do not accept this License. Therefore, by
|
||||||
|
modifying or distributing the Library (or any work based on the
|
||||||
|
Library), you indicate your acceptance of this License to do so, and
|
||||||
|
all its terms and conditions for copying, distributing or modifying
|
||||||
|
the Library or works based on it.
|
||||||
|
|
||||||
|
10. Each time you redistribute the Library (or any work based on the
|
||||||
|
Library), the recipient automatically receives a license from the
|
||||||
|
original licensor to copy, distribute, link with or modify the Library
|
||||||
|
subject to these terms and conditions. You may not impose any further
|
||||||
|
restrictions on the recipients' exercise of the rights granted herein.
|
||||||
|
You are not responsible for enforcing compliance by third parties with
|
||||||
|
this License.
|
||||||
|
|
||||||
|
11. If, as a consequence of a court judgment or allegation of patent
|
||||||
|
infringement or for any other reason (not limited to patent issues),
|
||||||
|
conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot
|
||||||
|
distribute so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you
|
||||||
|
may not distribute the Library at all. For example, if a patent
|
||||||
|
license would not permit royalty-free redistribution of the Library by
|
||||||
|
all those who receive copies directly or indirectly through you, then
|
||||||
|
the only way you could satisfy both it and this License would be to
|
||||||
|
refrain entirely from distribution of the Library.
|
||||||
|
|
||||||
|
If any portion of this section is held invalid or unenforceable under any
|
||||||
|
particular circumstance, the balance of the section is intended to apply,
|
||||||
|
and the section as a whole is intended to apply in other circumstances.
|
||||||
|
|
||||||
It is not the purpose of this section to induce you to infringe any
|
It is not the purpose of this section to induce you to infringe any
|
||||||
patents or other property right claims or to contest validity of any
|
patents or other property right claims or to contest validity of any
|
||||||
such claims; this section has the sole purpose of protecting the
|
such claims; this section has the sole purpose of protecting the
|
||||||
integrity of the free software distribution system, which is
|
integrity of the free software distribution system which is
|
||||||
implemented by public license practices. Many people have made
|
implemented by public license practices. Many people have made
|
||||||
generous contributions to the wide range of software distributed
|
generous contributions to the wide range of software distributed
|
||||||
through that system in reliance on consistent application of that
|
through that system in reliance on consistent application of that
|
||||||
system; it is up to the author/donor to decide if he or she is willing
|
system; it is up to the author/donor to decide if he or she is willing
|
||||||
@@ -227,114 +402,103 @@ impose that choice.
|
|||||||
This section is intended to make thoroughly clear what is believed to
|
This section is intended to make thoroughly clear what is believed to
|
||||||
be a consequence of the rest of this License.
|
be a consequence of the rest of this License.
|
||||||
|
|
||||||
8. If the distribution and/or use of the Program is restricted in
|
12. If the distribution and/or use of the Library is restricted in
|
||||||
certain countries either by patents or by copyrighted interfaces, the
|
certain countries either by patents or by copyrighted interfaces, the
|
||||||
original copyright holder who places the Program under this License
|
original copyright holder who places the Library under this License may add
|
||||||
may add an explicit geographical distribution limitation excluding
|
an explicit geographical distribution limitation excluding those countries,
|
||||||
those countries, so that distribution is permitted only in or among
|
so that distribution is permitted only in or among countries not thus
|
||||||
countries not thus excluded. In such case, this License incorporates
|
excluded. In such case, this License incorporates the limitation as if
|
||||||
the limitation as if written in the body of this License.
|
written in the body of this License.
|
||||||
|
|
||||||
9. The Free Software Foundation may publish revised and/or new versions
|
13. The Free Software Foundation may publish revised and/or new
|
||||||
of the General Public License from time to time. Such new versions will
|
versions of the Lesser General Public License from time to time.
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
Such new versions will be similar in spirit to the present version,
|
||||||
address new problems or concerns.
|
but may differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Program
|
Each version is given a distinguishing version number. If the Library
|
||||||
specifies a version number of this License which applies to it and "any
|
specifies a version number of this License which applies to it and
|
||||||
later version", you have the option of following the terms and conditions
|
"any later version", you have the option of following the terms and
|
||||||
either of that version or of any later version published by the Free
|
conditions either of that version or of any later version published by
|
||||||
Software Foundation. If the Program does not specify a version number of
|
the Free Software Foundation. If the Library does not specify a
|
||||||
this License, you may choose any version ever published by the Free Software
|
license version number, you may choose any version ever published by
|
||||||
Foundation.
|
the Free Software Foundation.
|
||||||
|
|
||||||
10. If you wish to incorporate parts of the Program into other free
|
14. If you wish to incorporate parts of the Library into other free
|
||||||
programs whose distribution conditions are different, write to the author
|
programs whose distribution conditions are incompatible with these,
|
||||||
to ask for permission. For software which is copyrighted by the Free
|
write to the author to ask for permission. For software which is
|
||||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
copyrighted by the Free Software Foundation, write to the Free
|
||||||
make exceptions for this. Our decision will be guided by the two goals
|
Software Foundation; we sometimes make exceptions for this. Our
|
||||||
of preserving the free status of all derivatives of our free software and
|
decision will be guided by the two goals of preserving the free status
|
||||||
of promoting the sharing and reuse of software generally.
|
of all derivatives of our free software and of promoting the sharing
|
||||||
|
and reuse of software generally.
|
||||||
|
|
||||||
NO WARRANTY
|
NO WARRANTY
|
||||||
|
|
||||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||||
REPAIR OR CORRECTION.
|
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||||
POSSIBILITY OF SUCH DAMAGES.
|
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||||
|
DAMAGES.
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
How to Apply These Terms to Your New Libraries
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
If you develop a new library, and you want it to be of the greatest
|
||||||
possible use to the public, the best way to achieve this is to make it
|
possible use to the public, we recommend making it free software that
|
||||||
free software which everyone can redistribute and change under these terms.
|
everyone can redistribute and change. You can do so by permitting
|
||||||
|
redistribution under these terms (or, alternatively, under the terms of the
|
||||||
|
ordinary General Public License).
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
To apply these terms, attach the following notices to the library. It is
|
||||||
to attach them to the start of each source file to most effectively
|
safest to attach them to the start of each source file to most effectively
|
||||||
convey the exclusion of warranty; and each file should have at least
|
convey the exclusion of warranty; and each file should have at least the
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
"copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
<one line to give the library's name and a brief idea of what it does.>
|
||||||
Copyright (C) <year> <name of author>
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
This program is free software; you can redistribute it and/or modify
|
This library is free software; you can redistribute it and/or
|
||||||
it under the terms of the GNU General Public License as published by
|
modify it under the terms of the GNU Lesser General Public
|
||||||
the Free Software Foundation; either version 2 of the License, or
|
License as published by the Free Software Foundation; either
|
||||||
(at your option) any later version.
|
version 2.1 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
This library is distributed in the hope that it will be useful,
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
GNU General Public License for more details.
|
Lesser General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License along
|
You should have received a copy of the GNU Lesser General Public
|
||||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
License along with this library; if not, write to the Free Software
|
||||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
|
||||||
|
USA
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
If the program is interactive, make it output a short notice like this
|
|
||||||
when it starts in an interactive mode:
|
|
||||||
|
|
||||||
Gnomovision version 69, Copyright (C) year name of author
|
|
||||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, the commands you use may
|
|
||||||
be called something other than `show w' and `show c'; they could even be
|
|
||||||
mouse-clicks or menu items--whatever suits your program.
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or your
|
You should also get your employer (if you work as a programmer) or your
|
||||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
school, if any, to sign a "copyright disclaimer" for the library, if
|
||||||
necessary. Here is a sample; alter the names:
|
necessary. Here is a sample; alter the names:
|
||||||
|
|
||||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
library `Frob' (a library for tweaking knobs) written by James Random
|
||||||
|
Hacker.
|
||||||
|
|
||||||
<signature of Ty Coon>, 1 April 1989
|
<signature of Ty Coon>, 1 April 1990
|
||||||
Ty Coon, President of Vice
|
Ty Coon, President of Vice
|
||||||
|
|
||||||
This General Public License does not permit incorporating your program into
|
That's all there is to it!
|
||||||
proprietary programs. If your program is a subroutine library, you may
|
|
||||||
consider it more useful to permit linking proprietary applications with the
|
|
||||||
library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License.
|
|
||||||
|
|||||||
29
README.md
29
README.md
@@ -1 +1,30 @@
|
|||||||
# Decky Frontend Library
|
# Decky Frontend Library
|
||||||
|
|
||||||
|
Library used to develop plugins used for use with [decky-loader](https://github.com/SteamDeckHomebrew/decky-loader).
|
||||||
|
|
||||||
|
## Decky Loader Discord [](https://deckbrew.xyz/discord)
|
||||||
|
|
||||||
|
Please [contact the developers here](https://deckbrew.xyz/discord) for questions and support that cannot be addressed via a Github issue.
|
||||||
|
|
||||||
|
## Developers and Contributors
|
||||||
|
|
||||||
|
This library is focused on usage by developers to provide custom React components based on those found in the Steam Deck's React UI.
|
||||||
|
This method allows developers to add UI elements and code without clobbering the existing UI of the deck in order to do so.
|
||||||
|
This library can also theoretically be used to extend existing UI elements of the Steam Deck UI but this has not been tested extensively.
|
||||||
|
|
||||||
|
### Getting Started (Contributors)
|
||||||
|
|
||||||
|
1. Clone the repository to your preferred location
|
||||||
|
2. If you wish to add features such as new UI components, please create a feature branch to PR to the original repo.
|
||||||
|
3. Bug/hotfixes are acceptable on the main branch,
|
||||||
|
|
||||||
|
### Getting Started (Developers)
|
||||||
|
|
||||||
|
If you would like a feature added to decky-frontend-lib, please request it via a Github issue.
|
||||||
|
|
||||||
|
If you want to start making a plugin with decky-frontend-lib, please direct your attention to the [decky-plugin-template](https://github.com/SteamDeckHomebrew/decky-plugin-template) repository.
|
||||||
|
|
||||||
|
This library can be found on [npm](https://www.npmjs.com/package/decky-frontend-lib) and as such you can pull it without a local copy for your project as needed.
|
||||||
|
|
||||||
|
Tips for fixing failing module finds after Steam updates:
|
||||||
|
- `Object.entries(DFL)` can point out any undefined exports
|
||||||
@@ -1,3 +1,3 @@
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript',],
|
presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
|
||||||
};
|
};
|
||||||
|
|||||||
10
global.d.ts
vendored
Normal file
10
global.d.ts
vendored
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
import type * as React from 'react';
|
||||||
|
import type * as ReactDOM from 'react-dom';
|
||||||
|
import type * as JSXRuntime from 'react/jsx-runtime';
|
||||||
|
declare global {
|
||||||
|
interface Window {
|
||||||
|
SP_REACT: typeof React;
|
||||||
|
SP_REACTDOM: typeof ReactDOM;
|
||||||
|
SP_JSX: typeof JSXRuntime;
|
||||||
|
}
|
||||||
|
}
|
||||||
5
globals.d.ts
vendored
5
globals.d.ts
vendored
@@ -1,5 +0,0 @@
|
|||||||
declare global {
|
|
||||||
interface Window {
|
|
||||||
SP_REACT: typeof React;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
22846
package-lock.json
generated
22846
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
66
package.json
66
package.json
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"name": "decky-frontend-lib",
|
"name": "@decky/ui",
|
||||||
"version": "0.4.0",
|
"version": "4.11.4",
|
||||||
"description": "A library for building decky plugins",
|
"description": "A library for interacting with the Steam frontend in Decky plugins and elsewhere.",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
"module": "dist/index.js",
|
"module": "dist/index.js",
|
||||||
|
"sideEffects": false,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "shx rm -rf dist && tsc -b",
|
"build": "shx rm -rf dist && tsc -b",
|
||||||
"dev": "tsc -b -w",
|
"dev": "tsc -b -w",
|
||||||
"prepack": "npm run build",
|
"docs": "typedoc --theme wiki-js --tsconfig ./tsconfig.json src/**/*",
|
||||||
"test": "echo 'No tests for now!'",
|
"test": "echo 'No tests for now!'",
|
||||||
"postinstall": "husky install",
|
"prepare": "husky install",
|
||||||
"commit": "git-cz"
|
"commit": "git-cz"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
@@ -28,8 +29,8 @@
|
|||||||
"steam",
|
"steam",
|
||||||
"components"
|
"components"
|
||||||
],
|
],
|
||||||
"author": "Jonas Dellinger <jonas@dellinger.dev>",
|
"author": "SteamDeckHomebrew Team",
|
||||||
"license": "GPL-2.0-or-later",
|
"license": "LGPL-2.1",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues"
|
"url": "https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues"
|
||||||
},
|
},
|
||||||
@@ -40,28 +41,53 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "^17.0.2",
|
"@commitlint/cli": "^19.8.1",
|
||||||
"@commitlint/config-conventional": "^17.0.2",
|
"@commitlint/config-conventional": "^19.8.1",
|
||||||
"@commitlint/cz-commitlint": "^17.0.0",
|
"@commitlint/cz-commitlint": "^19.8.1",
|
||||||
"@semantic-release/changelog": "^6.0.1",
|
"@semantic-release/changelog": "^6.0.3",
|
||||||
"@semantic-release/git": "^10.0.1",
|
"@semantic-release/git": "^10.0.1",
|
||||||
"@types/jest": "^27.4.1",
|
"@types/jest": "^29.5.14",
|
||||||
"@types/react": "16.14.0",
|
"@types/react": "19.1.1",
|
||||||
"@types/react-router": "5.1.18",
|
"@types/react-dom": "19.1.1",
|
||||||
"commitizen": "^4.2.4",
|
"@types/react-router": "5.1.20",
|
||||||
"husky": "^8.0.1",
|
"commitizen": "^4.3.1",
|
||||||
|
"husky": "^9.1.7",
|
||||||
"import-sort-style-module": "^6.0.0",
|
"import-sort-style-module": "^6.0.0",
|
||||||
"jest": "^27.5.1",
|
"jest": "^29.7.0",
|
||||||
|
"minimist": "^1.2.8",
|
||||||
|
"prettier": "^3.6.2",
|
||||||
"prettier-plugin-import-sort": "^0.0.7",
|
"prettier-plugin-import-sort": "^0.0.7",
|
||||||
"semantic-release": "^19.0.2",
|
"semantic-release": "^25.0.3",
|
||||||
"shx": "^0.3.4",
|
"shx": "^0.3.4",
|
||||||
"ts-jest": "^27.1.4",
|
"ts-jest": "^29.4.1",
|
||||||
"typescript": "^4.6.3"
|
"typedoc": "^0.25.13",
|
||||||
|
"typedoc-plugin-mdn-links": "^3.3.8",
|
||||||
|
"typedoc-plugin-missing-exports": "^2.3.0",
|
||||||
|
"typedoc-wikijs-theme": "^1.0.5",
|
||||||
|
"typescript": "^5.9.2"
|
||||||
|
},
|
||||||
|
"pnpm": {
|
||||||
|
"peerDependencyRules": {
|
||||||
|
"ignoreMissing": [
|
||||||
|
"react",
|
||||||
|
"react-dom"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"updateConfig": {
|
||||||
|
"ignoreDependencies": [
|
||||||
|
"react",
|
||||||
|
"react-dom"
|
||||||
|
]
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"importSort": {
|
"importSort": {
|
||||||
".js, .jsx, .ts, .tsx": {
|
".js, .jsx, .ts, .tsx": {
|
||||||
"style": "module",
|
"style": "module",
|
||||||
"parser": "typescript"
|
"parser": "typescript"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"publishConfig": {
|
||||||
|
"registry": "https://registry.npmjs.org/",
|
||||||
|
"tag": "latest"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
6150
pnpm-lock.yaml
generated
Normal file
6150
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
40
src/class-mapper.ts
Normal file
40
src/class-mapper.ts
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
import { Module, ModuleID, createModuleMapping } from './webpack';
|
||||||
|
|
||||||
|
export interface ClassModule {
|
||||||
|
[name: string]: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const classModuleMap: Map<ModuleID, ClassModule> = createModuleMapping((m: Module) => {
|
||||||
|
if (typeof m == 'object' && !m.__esModule) {
|
||||||
|
const keys = Object.keys(m);
|
||||||
|
// special case some libraries
|
||||||
|
if (keys.length == 1 && m.version) return false;
|
||||||
|
// special case localization
|
||||||
|
if (keys.length > 1000 && m.AboutSettings) return false;
|
||||||
|
|
||||||
|
return keys.length > 0 && keys.every((k) => !Object.getOwnPropertyDescriptor(m, k)?.get && typeof m[k] == 'string');
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
});
|
||||||
|
|
||||||
|
export const classMap = [...classModuleMap.values()];
|
||||||
|
|
||||||
|
export function findClass(id: string, name: string): string | void {
|
||||||
|
return classModuleMap.get(id)?.[name];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findClassByName(name: string): string | void {
|
||||||
|
return classMap.find((m) => m[name])?.[name];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findClassModule(filter: (module: any) => boolean): ClassModule | void {
|
||||||
|
return classMap.find((m) => filter(m));
|
||||||
|
}
|
||||||
|
|
||||||
|
export function unminifyClass(minifiedClass: string): string | void {
|
||||||
|
for (let m of classModuleMap.values()) {
|
||||||
|
for (let className of Object.keys(m)) {
|
||||||
|
if (m[className] == minifiedClass) return className;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
8
src/components/Button.ts
Normal file
8
src/components/Button.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
import { FC } from 'react';
|
||||||
|
|
||||||
|
import { DialogButton, DialogButtonProps } from './Dialog';
|
||||||
|
|
||||||
|
export interface ButtonProps extends DialogButtonProps {}
|
||||||
|
|
||||||
|
// Button isn't exported, so call DialogButton to grab it
|
||||||
|
export const Button = (DialogButton as any)?.render({}).type as FC<ButtonProps>;
|
||||||
16
src/components/ButtonItem.ts
Normal file
16
src/components/ButtonItem.ts
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import { FC } from 'react';
|
||||||
|
|
||||||
|
import { CommonUIModule } from '../webpack';
|
||||||
|
import { ItemProps } from './Item';
|
||||||
|
import { createPropListRegex } from '../utils';
|
||||||
|
|
||||||
|
export interface ButtonItemProps extends ItemProps {
|
||||||
|
onClick?(e: MouseEvent): void;
|
||||||
|
disabled?: boolean;
|
||||||
|
}
|
||||||
|
const buttonItemRegex = createPropListRegex(["highlightOnFocus", "childrenContainerWidth"], false);
|
||||||
|
export const ButtonItem = Object.values(CommonUIModule).find(
|
||||||
|
(mod: any) =>
|
||||||
|
(mod?.render?.toString && buttonItemRegex.test(mod.render.toString())) ||
|
||||||
|
mod?.render?.toString?.().includes('childrenContainerWidth:"min"'),
|
||||||
|
) as FC<ButtonItemProps>;
|
||||||
25
src/components/Carousel.ts
Normal file
25
src/components/Carousel.ts
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
import { HTMLAttributes, ReactNode, RefAttributes, FC } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
|
||||||
|
export interface CarouselProps extends HTMLAttributes<HTMLDivElement> {
|
||||||
|
autoFocus?: boolean;
|
||||||
|
enableBumperPaging?: boolean;
|
||||||
|
fnDoesItemTakeFocus?: (...unknown: any[]) => boolean;
|
||||||
|
fnGetColumnWidth?: (...unknown: any[]) => number;
|
||||||
|
fnGetId?: (id: number) => number;
|
||||||
|
fnItemRenderer?: (id: number, ...unknown: any[]) => ReactNode;
|
||||||
|
fnUpdateArrows?: (...unknown: any[]) => any;
|
||||||
|
initialColumn?: number;
|
||||||
|
nHeight?: number;
|
||||||
|
nIndexLeftmost?: number;
|
||||||
|
nItemHeight?: number;
|
||||||
|
nItemMarginX?: number;
|
||||||
|
nNumItems?: number;
|
||||||
|
name?: string;
|
||||||
|
scrollToAlignment?: 'center';
|
||||||
|
}
|
||||||
|
|
||||||
|
export const Carousel = findModuleExport((e: Export) => e.render?.toString().includes('setFocusedColumn:')) as FC<
|
||||||
|
CarouselProps & RefAttributes<HTMLDivElement>
|
||||||
|
>;
|
||||||
14
src/components/ControlsList.ts
Normal file
14
src/components/ControlsList.ts
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
import { FC, ReactNode } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
|
||||||
|
export interface ControlsListProps {
|
||||||
|
alignItems?: 'left' | 'right' | 'center';
|
||||||
|
spacing?: 'standard' | 'extra';
|
||||||
|
children?: ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const ControlsList: FC<ControlsListProps> = findModuleExport(
|
||||||
|
(e: Export) =>
|
||||||
|
e?.toString && e.toString().includes('().ControlsListChild') && e.toString().includes('().ControlsListOuterPanel'),
|
||||||
|
);
|
||||||
104
src/components/Dialog.ts
Normal file
104
src/components/Dialog.ts
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
import { CSSProperties, FC, ReactNode, RefAttributes } from 'react';
|
||||||
|
|
||||||
|
import { CommonUIModule, Module } from '../webpack';
|
||||||
|
import { FooterLegendProps } from './FooterLegend';
|
||||||
|
|
||||||
|
export interface DialogCommonProps extends RefAttributes<HTMLDivElement> {
|
||||||
|
style?: CSSProperties;
|
||||||
|
className?: string;
|
||||||
|
children?: ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DialogButtonProps extends DialogCommonProps, FooterLegendProps {
|
||||||
|
/**
|
||||||
|
* Enables/disables the focus around the button.
|
||||||
|
*
|
||||||
|
* @note
|
||||||
|
* Default value depends on context, so setting it to `false` will enable it.
|
||||||
|
*/
|
||||||
|
noFocusRing?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disables the button - assigned `on*` methods will not be invoked if clicked.
|
||||||
|
*
|
||||||
|
* @note
|
||||||
|
* Depending on where it is, it might still get focus. In such case it can be
|
||||||
|
* partially disabled separately.
|
||||||
|
*
|
||||||
|
* @see focusable.
|
||||||
|
*/
|
||||||
|
disabled?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enables/disables the navigation based focus on button - you won't be able to navigate to
|
||||||
|
* it via the gamepad or keyboard.
|
||||||
|
*
|
||||||
|
* @note
|
||||||
|
* If set to `false`, it still can be clicked and **WILL** become focused until navigated away.
|
||||||
|
* Depending on the context of where the button is, even a disabled button can focused.
|
||||||
|
*/
|
||||||
|
focusable?: boolean;
|
||||||
|
|
||||||
|
onClick?(e: MouseEvent): void;
|
||||||
|
onPointerDown?(e: PointerEvent): void;
|
||||||
|
onPointerUp?(e: PointerEvent): void;
|
||||||
|
onPointerCancel?(e: PointerEvent): void;
|
||||||
|
onMouseDown?(e: MouseEvent): void;
|
||||||
|
onMouseUp?(e: MouseEvent): void;
|
||||||
|
onTouchStart?(e: TouchEvent): void;
|
||||||
|
onTouchEnd?(e: TouchEvent): void;
|
||||||
|
onTouchCancel?(e: TouchEvent): void;
|
||||||
|
onSubmit?(e: SubmitEvent): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
const CommonDialogDivs = Object.values(CommonUIModule).filter(
|
||||||
|
(m: any) => typeof m === 'object' &&
|
||||||
|
// New
|
||||||
|
(
|
||||||
|
m?.render?.toString().includes('jsx)("div",{...') ||
|
||||||
|
m?.render?.toString().includes('jsx)("div",Object.assign({},')
|
||||||
|
) ||
|
||||||
|
// Old
|
||||||
|
(
|
||||||
|
m?.render?.toString().includes('createElement("div",{...') ||
|
||||||
|
m?.render?.toString().includes('createElement("div",Object.assign({},')
|
||||||
|
)
|
||||||
|
);
|
||||||
|
const MappedDialogDivs = new Map(
|
||||||
|
Object.values(CommonDialogDivs).map((m: any) => {
|
||||||
|
try {
|
||||||
|
const renderedDiv = m.render({});
|
||||||
|
// Take only the first class name segment as it identifies the element we want
|
||||||
|
return [renderedDiv.props.className.split(' ')[0], m];
|
||||||
|
} catch (e) {
|
||||||
|
console.error("[DFL:Dialog]: failed to render common dialog component", e);
|
||||||
|
return [null, null];
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Old | New
|
||||||
|
export const DialogHeader = (MappedDialogDivs.get('DialogHeader') || Object.values(CommonUIModule).find((component: Module) => {
|
||||||
|
const str = component?.render?.toString?.();
|
||||||
|
return str?.includes("role:\"heading\"") && str.includes(")(\"DialogHeader\",");
|
||||||
|
})) as FC<DialogCommonProps>;
|
||||||
|
|
||||||
|
export const DialogSubHeader = MappedDialogDivs.get('DialogSubHeader') as FC<DialogCommonProps>;
|
||||||
|
export const DialogFooter = MappedDialogDivs.get('DialogFooter') as FC<DialogCommonProps>;
|
||||||
|
export const DialogLabel = MappedDialogDivs.get('DialogLabel') as FC<DialogCommonProps>;
|
||||||
|
export const DialogBodyText = MappedDialogDivs.get('DialogBodyText') as FC<DialogCommonProps>;
|
||||||
|
export const DialogBody = MappedDialogDivs.get('DialogBody') as FC<DialogCommonProps>;
|
||||||
|
export const DialogControlsSection = MappedDialogDivs.get('DialogControlsSection') as FC<DialogCommonProps>;
|
||||||
|
export const DialogControlsSectionHeader = MappedDialogDivs.get('DialogControlsSectionHeader') as FC<DialogCommonProps>;
|
||||||
|
|
||||||
|
export const DialogButtonPrimary = Object.values(CommonUIModule).find(
|
||||||
|
(mod: any) => mod?.render?.toString?.()?.includes('"DialogButton","_DialogLayout","Primary"'),
|
||||||
|
) as FC<DialogButtonProps>;
|
||||||
|
|
||||||
|
export const DialogButtonSecondary = Object.values(CommonUIModule).find(
|
||||||
|
(mod: any) => mod?.render?.toString?.()?.includes('"DialogButton","_DialogLayout","Secondary"')
|
||||||
|
) as FC<DialogButtonProps>;
|
||||||
|
|
||||||
|
// This is the "main" button. The Primary can act as a submit button,
|
||||||
|
// therefore secondary is chosen (also for backwards comp. reasons)
|
||||||
|
export const DialogButton = DialogButtonSecondary;
|
||||||
33
src/components/DialogCheckbox.ts
Normal file
33
src/components/DialogCheckbox.ts
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
import { FC, ReactNode } from 'react';
|
||||||
|
|
||||||
|
import { findModuleExport } from '../webpack';
|
||||||
|
import { DialogCommonProps } from './Dialog';
|
||||||
|
import { FooterLegendProps } from './FooterLegend';
|
||||||
|
|
||||||
|
export interface DialogCheckboxProps extends DialogCommonProps, FooterLegendProps {
|
||||||
|
onChange?(checked: boolean): void;
|
||||||
|
label?: ReactNode;
|
||||||
|
description?: ReactNode;
|
||||||
|
disabled?: boolean;
|
||||||
|
tooltip?: string;
|
||||||
|
color?: string;
|
||||||
|
highlightColor?: string;
|
||||||
|
bottomSeparator?: 'standard' | 'thick' | 'none';
|
||||||
|
controlled?: boolean;
|
||||||
|
checked?: boolean;
|
||||||
|
onClick?(evt: Event): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Do not access KeyDown, SetChecked, Toggle here as they are getters and accessing them outside of a render breaks them globally
|
||||||
|
export const DialogCheckbox = findModuleExport(e =>
|
||||||
|
e?.prototype &&
|
||||||
|
typeof e?.prototype == "object" &&
|
||||||
|
"GetPanelElementProps" in e?.prototype &&
|
||||||
|
"SetChecked" in e?.prototype &&
|
||||||
|
"Toggle" in e?.prototype &&
|
||||||
|
// beta || stable as of oct 2 2024
|
||||||
|
(e?.prototype?.render?.toString?.().includes('="DialogCheckbox"') || (
|
||||||
|
e.contextType &&
|
||||||
|
e.prototype?.render?.toString?.().includes('fallback:')
|
||||||
|
))
|
||||||
|
) as FC<DialogCheckboxProps>;
|
||||||
49
src/components/Dropdown.tsx
Normal file
49
src/components/Dropdown.tsx
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
import { ReactNode, FC } from 'react';
|
||||||
|
|
||||||
|
import { CommonUIModule } from '../webpack';
|
||||||
|
import { ItemProps } from './Item';
|
||||||
|
import { createPropListRegex } from '../utils';
|
||||||
|
import type { ContextMenuPositionOptions } from './Menu';
|
||||||
|
|
||||||
|
export interface SingleDropdownOption {
|
||||||
|
data: any;
|
||||||
|
label: ReactNode;
|
||||||
|
|
||||||
|
options?: never;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MultiDropdownOption {
|
||||||
|
label: ReactNode;
|
||||||
|
options: DropdownOption[];
|
||||||
|
|
||||||
|
data?: never;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type DropdownOption = SingleDropdownOption | MultiDropdownOption;
|
||||||
|
|
||||||
|
export interface DropdownProps {
|
||||||
|
rgOptions: DropdownOption[];
|
||||||
|
selectedOption: any;
|
||||||
|
disabled?: boolean;
|
||||||
|
onMenuWillOpen?(showMenu: () => void): void;
|
||||||
|
onMenuOpened?(): void;
|
||||||
|
onChange?(data: SingleDropdownOption): void;
|
||||||
|
contextMenuPositionOptions?: ContextMenuPositionOptions;
|
||||||
|
menuLabel?: string;
|
||||||
|
strDefaultLabel?: string;
|
||||||
|
renderButtonValue?(element: ReactNode): ReactNode;
|
||||||
|
focusable?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const Dropdown = Object.values(CommonUIModule).find(
|
||||||
|
(mod: any) => mod?.prototype?.SetSelectedOption && mod?.prototype?.BuildMenu,
|
||||||
|
) as FC<DropdownProps>;
|
||||||
|
|
||||||
|
export interface DropdownItemProps extends DropdownProps, ItemProps {}
|
||||||
|
|
||||||
|
const dropdownItemRegex = createPropListRegex(["dropDownControlRef", "description"], false);
|
||||||
|
export const DropdownItemInternal = Object.values(CommonUIModule).find((mod: any) =>
|
||||||
|
mod?.toString && dropdownItemRegex.test(mod.toString()),
|
||||||
|
) as FC<DropdownItemProps>;
|
||||||
|
|
||||||
|
export const DropdownItem = ((args: DropdownItemProps) => <DropdownItemInternal childrenContainerWidth="min" {...args}/>) as FC<DropdownItemProps>;
|
||||||
6
src/components/ErrorBoundary.ts
Normal file
6
src/components/ErrorBoundary.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import { FC, PropsWithChildren } from "react";
|
||||||
|
import { findModuleExport } from "../webpack";
|
||||||
|
|
||||||
|
export const ErrorBoundary = findModuleExport(
|
||||||
|
(e) => e.InstallErrorReportingStore && e?.prototype?.Reset && e?.prototype?.componentDidCatch,
|
||||||
|
) as FC<PropsWithChildren>; // Actually a class but @types/react is broken lol
|
||||||
30
src/components/Field.ts
Normal file
30
src/components/Field.ts
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
import { FC, ReactNode, RefAttributes } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
import { FooterLegendProps } from './FooterLegend';
|
||||||
|
|
||||||
|
export interface FieldProps extends FooterLegendProps {
|
||||||
|
children?: ReactNode;
|
||||||
|
label?: ReactNode;
|
||||||
|
bottomSeparator?: 'standard' | 'thick' | 'none';
|
||||||
|
description?: ReactNode;
|
||||||
|
disabled?: boolean;
|
||||||
|
icon?: ReactNode;
|
||||||
|
inlineWrap?: 'keep-inline' | 'shift-children-below'; // If label is too long it will move shildren below before starting to wrap label
|
||||||
|
childrenLayout?: 'below' | 'inline';
|
||||||
|
childrenContainerWidth?: 'min' | 'max' | 'fixed'; // Does not work with childrenLayout==='below'
|
||||||
|
spacingBetweenLabelAndChild?: 'none'; // This applies only when childrenLayout==='below'
|
||||||
|
padding?: 'none' | 'standard' | 'compact';
|
||||||
|
className?: string;
|
||||||
|
highlightOnFocus?: boolean;
|
||||||
|
indentLevel?: number;
|
||||||
|
verticalAlignment?: 'center' | 'none'; // Alligns inline label with children
|
||||||
|
focusable?: boolean; // Allows to get focus without any focusable children or on* callbacks
|
||||||
|
onActivate?: (e: CustomEvent | MouseEvent) => void;
|
||||||
|
onClick?: (e: CustomEvent | MouseEvent) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
// new || old
|
||||||
|
export const Field = findModuleExport((e: Export) => (e?.toString()?.includes('().Field') && e?.toString()?.includes('"shift-children-below"')) || e?.render?.toString()?.includes('"shift-children-below"')) as FC<
|
||||||
|
FieldProps & RefAttributes<HTMLDivElement>
|
||||||
|
>;
|
||||||
15
src/components/FocusRing.ts
Normal file
15
src/components/FocusRing.ts
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { ElementType, FC, ReactNode } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
|
||||||
|
export interface FocusRingProps {
|
||||||
|
className?: string;
|
||||||
|
rootClassName?: string;
|
||||||
|
render?: ElementType;
|
||||||
|
children?: ReactNode;
|
||||||
|
NavigationManager?: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const FocusRing = findModuleExport((e: Export) =>
|
||||||
|
e?.toString?.()?.includes('.GetShowDebugFocusRing())'),
|
||||||
|
) as FC<FocusRingProps>;
|
||||||
21
src/components/Focusable.ts
Normal file
21
src/components/Focusable.ts
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
import { HTMLAttributes, ReactNode, RefAttributes, FC } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
import { FooterLegendProps } from './FooterLegend';
|
||||||
|
import { createPropListRegex } from '../utils';
|
||||||
|
|
||||||
|
export interface FocusableProps extends HTMLAttributes<HTMLDivElement>, FooterLegendProps {
|
||||||
|
children: ReactNode;
|
||||||
|
'flow-children'?: string;
|
||||||
|
focusClassName?: string;
|
||||||
|
focusWithinClassName?: string;
|
||||||
|
noFocusRing?: boolean;
|
||||||
|
onActivate?: (e: CustomEvent) => void;
|
||||||
|
onCancel?: (e: CustomEvent) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
const focusableRegex = createPropListRegex(["flow-children", "onActivate", "onCancel", "focusClassName", "focusWithinClassName"]);
|
||||||
|
|
||||||
|
export const Focusable = findModuleExport((e: Export) =>
|
||||||
|
(typeof e == 'function' && e?.toString && focusableRegex.test(e.toString())) || (e?.render?.toString && focusableRegex.test(e.render.toString()))
|
||||||
|
) as FC<FocusableProps & RefAttributes<HTMLDivElement>>;
|
||||||
117
src/components/FooterLegend.ts
Normal file
117
src/components/FooterLegend.ts
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
import { ReactNode } from 'react';
|
||||||
|
|
||||||
|
export enum GamepadButton {
|
||||||
|
INVALID,
|
||||||
|
OK,
|
||||||
|
CANCEL,
|
||||||
|
SECONDARY,
|
||||||
|
OPTIONS,
|
||||||
|
BUMPER_LEFT,
|
||||||
|
BUMPER_RIGHT,
|
||||||
|
TRIGGER_LEFT,
|
||||||
|
TRIGGER_RIGHT,
|
||||||
|
DIR_UP,
|
||||||
|
DIR_DOWN,
|
||||||
|
DIR_LEFT,
|
||||||
|
DIR_RIGHT,
|
||||||
|
SELECT,
|
||||||
|
START,
|
||||||
|
LSTICK_CLICK,
|
||||||
|
RSTICK_CLICK,
|
||||||
|
LSTICK_TOUCH,
|
||||||
|
RSTICK_TOUCH,
|
||||||
|
LPAD_TOUCH,
|
||||||
|
LPAD_CLICK,
|
||||||
|
RPAD_TOUCH,
|
||||||
|
RPAD_CLICK,
|
||||||
|
REAR_LEFT_UPPER,
|
||||||
|
REAR_LEFT_LOWER,
|
||||||
|
REAR_RIGHT_UPPER,
|
||||||
|
REAR_RIGHT_LOWER,
|
||||||
|
STEAM_GUIDE,
|
||||||
|
STEAM_QUICK_MENU,
|
||||||
|
}
|
||||||
|
export enum NavEntryPositionPreferences {
|
||||||
|
/**
|
||||||
|
* Always give focus to the first child element.
|
||||||
|
*/
|
||||||
|
FIRST,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Always give focus to the last child element.
|
||||||
|
*/
|
||||||
|
LAST,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Give focus to the child element that would maintain the flow in the X axis.
|
||||||
|
*
|
||||||
|
* Imagine you have a calculator window with 9 standard buttons.
|
||||||
|
* You have 3 rows of buttons, with 3 buttons per row.
|
||||||
|
* If you select button with number 8 and navigate down, the buttons
|
||||||
|
* will be navigated in the following order 8->5->3.
|
||||||
|
* The flow is maintained for the X axis while you're navigating the Y axis.
|
||||||
|
*/
|
||||||
|
MAINTAIN_X,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Give focus to the child element that would maintain the flow in the Y axis.
|
||||||
|
*
|
||||||
|
* Imagine you have a calculator window with 9 standard buttons.
|
||||||
|
* You have 3 columns of buttons, with 3 buttons per column.
|
||||||
|
* If you select button with number 4 and navigate right, the buttons
|
||||||
|
* will be navigated in the following order 4->5->6.
|
||||||
|
* The flow is maintained for the Y axis while you're navigating the X axis.
|
||||||
|
*/
|
||||||
|
MAINTAIN_Y,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Give focus to the first child element with `preferredFocus == true` prop.
|
||||||
|
*/
|
||||||
|
PREFERRED_CHILD,
|
||||||
|
}
|
||||||
|
export interface GamepadEventDetail {
|
||||||
|
button: number;
|
||||||
|
is_repeat?: boolean;
|
||||||
|
source: number;
|
||||||
|
}
|
||||||
|
export declare type ActionDescriptionMap = {
|
||||||
|
[key in GamepadButton]?: ReactNode;
|
||||||
|
};
|
||||||
|
export declare type GamepadEvent = CustomEvent<GamepadEventDetail>;
|
||||||
|
export interface FooterLegendProps {
|
||||||
|
/**
|
||||||
|
* Navigation entry strategy to be used when gaining focus during navigation.
|
||||||
|
*
|
||||||
|
* This is meant to be used on a parent container that has children. Once the
|
||||||
|
* container (e.g. Focusable) is navigated to and has children in it, the children
|
||||||
|
* is then navigated to (focused) using the provided strategy.
|
||||||
|
*
|
||||||
|
* If no strategy is provided, it seems that the `NavEntryPositionPreferences.FIRST`
|
||||||
|
* is used initialy, but for the next time the parent remembers previously focused
|
||||||
|
* child and focused back on it instead.
|
||||||
|
*/
|
||||||
|
navEntryPreferPosition?: NavEntryPositionPreferences;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mark the element as the preferred child (to be focused) whenever the parent uses the
|
||||||
|
* `NavEntryPositionPreferences.PREFERRED_CHILD` navigation strategy.
|
||||||
|
*/
|
||||||
|
preferredFocus?: boolean;
|
||||||
|
|
||||||
|
actionDescriptionMap?: ActionDescriptionMap;
|
||||||
|
onOKActionDescription?: ReactNode;
|
||||||
|
onCancelActionDescription?: ReactNode;
|
||||||
|
onSecondaryActionDescription?: ReactNode;
|
||||||
|
onOptionsActionDescription?: ReactNode;
|
||||||
|
onMenuActionDescription?: ReactNode;
|
||||||
|
onButtonDown?: (evt: GamepadEvent) => void;
|
||||||
|
onButtonUp?: (evt: GamepadEvent) => void;
|
||||||
|
onOKButton?: (evt: GamepadEvent) => void;
|
||||||
|
onCancelButton?: (evt: GamepadEvent) => void;
|
||||||
|
onSecondaryButton?: (evt: GamepadEvent) => void;
|
||||||
|
onOptionsButton?: (evt: GamepadEvent) => void;
|
||||||
|
onGamepadDirection?: (evt: GamepadEvent) => void;
|
||||||
|
onGamepadFocus?: (evt: GamepadEvent) => void;
|
||||||
|
onGamepadBlur?: (evt: GamepadEvent) => void;
|
||||||
|
onMenuButton?: (evt: GamepadEvent) => void;
|
||||||
|
}
|
||||||
14
src/components/Item.ts
Normal file
14
src/components/Item.ts
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
import { ReactNode } from 'react';
|
||||||
|
|
||||||
|
export interface ItemProps {
|
||||||
|
label?: ReactNode;
|
||||||
|
description?: ReactNode;
|
||||||
|
children?: ReactNode;
|
||||||
|
layout?: 'below' | 'inline';
|
||||||
|
icon?: ReactNode;
|
||||||
|
bottomSeparator?: 'standard' | 'thick' | 'none';
|
||||||
|
childrenContainerWidth?: 'min' | 'max' | 'fixed'; // Does not work with layout==='below'
|
||||||
|
indentLevel?: number;
|
||||||
|
tooltip?: string;
|
||||||
|
highlightOnFocus?: boolean;
|
||||||
|
}
|
||||||
20
src/components/Marquee.ts
Normal file
20
src/components/Marquee.ts
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
import { CSSProperties, FC } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
|
||||||
|
export interface MarqueeProps {
|
||||||
|
play?: boolean;
|
||||||
|
direction?: 'left' | 'right';
|
||||||
|
speed?: number;
|
||||||
|
delay?: number;
|
||||||
|
fadeLength?: number;
|
||||||
|
center?: boolean;
|
||||||
|
resetOnPause?: boolean;
|
||||||
|
style?: CSSProperties;
|
||||||
|
className?: string;
|
||||||
|
children: React.ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const Marquee: FC<MarqueeProps> = findModuleExport(
|
||||||
|
(e: Export) => e?.toString && e.toString().includes('.Marquee') && e.toString().includes('--fade-length'),
|
||||||
|
);
|
||||||
175
src/components/Menu.ts
Executable file
175
src/components/Menu.ts
Executable file
@@ -0,0 +1,175 @@
|
|||||||
|
import { FC, ReactNode } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleByExport, findModuleDetailsByExport, findModuleExport } from '../webpack';
|
||||||
|
import { FooterLegendProps } from './FooterLegend';
|
||||||
|
|
||||||
|
interface PopupCreationOptions {
|
||||||
|
/**
|
||||||
|
* Initially hidden, make it appear with {@link ContextMenuInstance.Show}.
|
||||||
|
*/
|
||||||
|
bCreateHidden?: boolean;
|
||||||
|
|
||||||
|
bModal?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Document title.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Separate interface, since one of webpack module exports uses this exact object,
|
||||||
|
// so maybe it could be reused elsewhere.
|
||||||
|
interface MonitorOptions {
|
||||||
|
targetMonitor: {
|
||||||
|
flMonitorScale: number;
|
||||||
|
nScreenLeft: number;
|
||||||
|
nScreenTop: number;
|
||||||
|
nScreenWidth: number;
|
||||||
|
nScreenHeight: number;
|
||||||
|
};
|
||||||
|
flGamepadScale: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ContextMenuPositionOptions extends PopupCreationOptions, Partial<MonitorOptions> {
|
||||||
|
/**
|
||||||
|
* When {@link bForcePopup} is true, makes the window appear above everything else.
|
||||||
|
*/
|
||||||
|
bAlwaysOnTop?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disables the mouse overlay, granting the ability to click anywhere while
|
||||||
|
* the menu's active.
|
||||||
|
*/
|
||||||
|
bDisableMouseOverlay?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disables the {@link bPreferPopTop} behavior.
|
||||||
|
*/
|
||||||
|
bDisablePopTop?: boolean;
|
||||||
|
|
||||||
|
bFitToWindow?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Forces the menu to open in a separate window instead of inside the parent.
|
||||||
|
*/
|
||||||
|
bForcePopup?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Like {@link bMatchWidth}, but don't shrink below the menu's minimum width.
|
||||||
|
*/
|
||||||
|
bGrowToElementWidth?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Match the parent's exact height.
|
||||||
|
*/
|
||||||
|
bMatchHeight?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Match the parent's exact width.
|
||||||
|
*/
|
||||||
|
bMatchWidth?: boolean;
|
||||||
|
|
||||||
|
bNoFocusWhenShown?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Makes the menu **invisible**, instead of getting removed from the DOM.
|
||||||
|
*/
|
||||||
|
bRetainOnHide?: boolean;
|
||||||
|
|
||||||
|
bScreenCoordinates?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set to `true` to not account for the parent's width.
|
||||||
|
*/
|
||||||
|
bOverlapHorizontal?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set to `true` to not account for the parent's height.
|
||||||
|
*/
|
||||||
|
bOverlapVertical?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set to `true` to make the entire menu try to appear on the left side from
|
||||||
|
* the parent.
|
||||||
|
*/
|
||||||
|
bPreferPopLeft?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set to `true` to make the entire menu try to appear above the parent.
|
||||||
|
*/
|
||||||
|
bPreferPopTop?: boolean;
|
||||||
|
|
||||||
|
bShiftToFitWindow?: boolean;
|
||||||
|
|
||||||
|
// different window creation flags (StandaloneContextMenu vs PopupContextMenu)
|
||||||
|
bStandalone?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class name **replacement** for the container element, i.e. it replaces the
|
||||||
|
* default class.
|
||||||
|
*/
|
||||||
|
strClassName?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ContextMenuInstance {
|
||||||
|
Hide(): void;
|
||||||
|
Show(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const showContextMenu: (
|
||||||
|
children: ReactNode,
|
||||||
|
parent?: EventTarget,
|
||||||
|
options?: ContextMenuPositionOptions,
|
||||||
|
) => ContextMenuInstance = findModuleExport(
|
||||||
|
(e: Export) =>
|
||||||
|
typeof e === 'function' &&
|
||||||
|
e.toString().includes('GetContextMenuManagerFromWindow(') &&
|
||||||
|
e.toString().includes('.CreateContextMenuInstance('),
|
||||||
|
);
|
||||||
|
|
||||||
|
export interface MenuProps extends FooterLegendProps {
|
||||||
|
label: string;
|
||||||
|
onCancel?(): void;
|
||||||
|
cancelText?: string;
|
||||||
|
children?: ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
const MenuModule = findModuleDetailsByExport((e: Export) => e?.render?.toString()?.includes('bPlayAudio:') || (e?.prototype?.OnOKButton && e?.prototype?.OnMouseEnter));
|
||||||
|
|
||||||
|
export const Menu: FC<MenuProps> =
|
||||||
|
findModuleExport((e: Export) => e?.prototype?.HideIfSubmenu && e?.prototype?.HideMenu) || // Legacy Menu
|
||||||
|
(Object.values(MenuModule?.[0] ?? {}).find((e) => e?.toString()?.includes?.(`useId`) && e?.toString()?.includes?.(`labelId`)) as FC<MenuProps>); // New Menu 6/15/2025
|
||||||
|
|
||||||
|
export interface MenuGroupProps {
|
||||||
|
label: string;
|
||||||
|
disabled?: boolean;
|
||||||
|
children?: ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
const MenuGoupModule = findModuleByExport(e => e?.prototype?.Focus && e?.prototype?.OnOKButton && e?.prototype?.render?.toString().includes?.(`"emphasis"==this.props.tone`));
|
||||||
|
export const MenuGroup: FC<MenuGroupProps> = MenuGoupModule && Object.values(MenuGoupModule).find((e: Export) => typeof e == "function" && e?.toString?.()?.includes("bInGamepadUI:"));
|
||||||
|
export interface MenuItemProps extends FooterLegendProps {
|
||||||
|
bInteractableItem?: boolean;
|
||||||
|
onClick?(evt: Event): void;
|
||||||
|
onSelected?(evt: Event): void;
|
||||||
|
onMouseEnter?(evt: MouseEvent): void;
|
||||||
|
onMoveRight?(): void;
|
||||||
|
selected?: boolean;
|
||||||
|
disabled?: boolean;
|
||||||
|
bPlayAudio?: boolean;
|
||||||
|
tone?: 'positive' | 'emphasis' | 'destructive';
|
||||||
|
children?: ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const MenuItem: FC<MenuItemProps> = MenuModule?.[1];
|
||||||
|
|
||||||
|
export const MenuSeparator: FC = findModuleExport(
|
||||||
|
(e: Export) => typeof e === 'function' && /className:.+?\.ContextMenuSeparator/.test(e.toString()),
|
||||||
|
);
|
||||||
|
|
||||||
|
/*
|
||||||
|
all().map(m => {
|
||||||
|
if (typeof m !== "object") return undefined;
|
||||||
|
for (let prop in m) { if (m[prop]?.prototype?.OK && m[prop]?.prototype?.Cancel && m[prop]?.prototype?.render) return m[prop]}
|
||||||
|
}).find(x => x)
|
||||||
|
*/
|
||||||
121
src/components/Modal.ts
Executable file
121
src/components/Modal.ts
Executable file
@@ -0,0 +1,121 @@
|
|||||||
|
import { FC, ReactNode } from 'react';
|
||||||
|
|
||||||
|
import { findSP } from '../utils';
|
||||||
|
import { Export, findModule, findModuleDetailsByExport, findModuleExport } from '../webpack';
|
||||||
|
|
||||||
|
// All of the popout options + strTitle are related. Proper usage is not yet known...
|
||||||
|
export interface ShowModalProps {
|
||||||
|
browserContext?: unknown;
|
||||||
|
bForcePopOut?: boolean;
|
||||||
|
bHideActionIcons?: boolean;
|
||||||
|
bHideMainWindowForPopouts?: boolean;
|
||||||
|
bNeverPopOut?: boolean;
|
||||||
|
fnOnClose?: () => void; // Seems to be the same as "closeModal" callback, but only when the modal is a popout. Will no longer work after "Update" invocation!
|
||||||
|
popupHeight?: number;
|
||||||
|
popupWidth?: number;
|
||||||
|
promiseRenderComplete?: Promise<void>; // Invoked once the render is complete. Currently, it seems to be used as image loading success/error callback...
|
||||||
|
strTitle?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ShowModalResult {
|
||||||
|
// This method will not invoke any of the variations of "closeModal" callbacks!
|
||||||
|
Close: () => void;
|
||||||
|
|
||||||
|
// This method will replace the modal element completely and will not update the callback chains,
|
||||||
|
// meaning that "closeModal" and etc. will not automatically close the modal anymore (also "fnOnClose"
|
||||||
|
// will not be even called upon close anymore)! You have to manually call the "Close" method when, for example,
|
||||||
|
// the "closeModal" is invoked in the newly updated modal:
|
||||||
|
// <ModalRoot closeModal={() => { console.log("ABOUT TO CLOSE"); showModalRes.Close(); }} />
|
||||||
|
Update: (modal: ReactNode) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
const showModalRaw: (
|
||||||
|
modal: ReactNode,
|
||||||
|
parent?: EventTarget,
|
||||||
|
title?: string,
|
||||||
|
props?: ShowModalProps,
|
||||||
|
unknown1?: unknown,
|
||||||
|
hideActions?: { bHideActions?: boolean },
|
||||||
|
modalManager?: unknown,
|
||||||
|
) => ShowModalResult = findModuleExport(
|
||||||
|
(e: Export) =>
|
||||||
|
typeof e === 'function' && e.toString().includes('props.bDisableBackgroundDismiss') && !e?.prototype?.Cancel,
|
||||||
|
);
|
||||||
|
|
||||||
|
export const showModal = (
|
||||||
|
modal: ReactNode,
|
||||||
|
parent?: EventTarget,
|
||||||
|
props: ShowModalProps = {
|
||||||
|
strTitle: 'Decky Dialog',
|
||||||
|
bHideMainWindowForPopouts: false,
|
||||||
|
},
|
||||||
|
): ShowModalResult => {
|
||||||
|
return showModalRaw(modal, parent || findSP() || window, props.strTitle, props, undefined, {
|
||||||
|
bHideActions: props.bHideActionIcons,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface ModalRootProps {
|
||||||
|
children?: ReactNode;
|
||||||
|
onCancel?(): void;
|
||||||
|
closeModal?(): void;
|
||||||
|
onOK?(): void;
|
||||||
|
onEscKeypress?(): void;
|
||||||
|
className?: string;
|
||||||
|
modalClassName?: string;
|
||||||
|
bAllowFullSize?: boolean;
|
||||||
|
bDestructiveWarning?: boolean;
|
||||||
|
bDisableBackgroundDismiss?: boolean;
|
||||||
|
bHideCloseIcon?: boolean;
|
||||||
|
bOKDisabled?: boolean;
|
||||||
|
bCancelDisabled?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ConfirmModalProps extends ModalRootProps {
|
||||||
|
onMiddleButton?(): void; // setting this prop will enable the middle button
|
||||||
|
strTitle?: ReactNode;
|
||||||
|
strDescription?: ReactNode;
|
||||||
|
strOKButtonText?: ReactNode;
|
||||||
|
strCancelButtonText?: ReactNode;
|
||||||
|
strMiddleButtonText?: ReactNode;
|
||||||
|
bAlertDialog?: boolean; // This will open a modal with only OK button enabled
|
||||||
|
bMiddleDisabled?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const ConfirmModal = findModuleExport(
|
||||||
|
(e: Export) => e?.toString()?.includes('bUpdateDisabled') && e?.toString()?.includes('closeModal') && e?.toString()?.includes('onGamepadCancel'),
|
||||||
|
) as FC<ConfirmModalProps>;
|
||||||
|
|
||||||
|
export const ModalRoot =
|
||||||
|
// new
|
||||||
|
findModuleExport((e: Export) => typeof e === 'function' && e.toString().includes('Either closeModal or onCancel should be passed to GenericDialog. Classes: ')) ||
|
||||||
|
// old
|
||||||
|
Object.values(
|
||||||
|
findModule((m: any) => {
|
||||||
|
if (typeof m !== 'object') return false;
|
||||||
|
|
||||||
|
for (let prop in m) {
|
||||||
|
if (m[prop]?.m_mapModalManager && Object.values(m)?.find((x: any) => x?.type)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}) || {},
|
||||||
|
)?.find((x: any) => x?.type?.toString?.()?.includes('((function(){')) as FC<ModalRootProps>;
|
||||||
|
|
||||||
|
interface SimpleModalProps {
|
||||||
|
active?: boolean;
|
||||||
|
children: ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
const [ModalModule, _ModalPosition] = findModuleDetailsByExport((e: Export) => e?.toString().includes('.ModalPosition'), 5)
|
||||||
|
|
||||||
|
const ModalModuleProps = ModalModule ? Object.values(ModalModule) : [];
|
||||||
|
|
||||||
|
export const SimpleModal = ModalModuleProps.find((prop) => {
|
||||||
|
const string = prop?.toString();
|
||||||
|
return string?.includes('.ShowPortalModal()') && string?.includes('.OnElementReadyCallbacks.Register(');
|
||||||
|
}) as FC<SimpleModalProps>;
|
||||||
|
|
||||||
|
export const ModalPosition = _ModalPosition as FC<SimpleModalProps>;
|
||||||
26
src/components/Panel.ts
Normal file
26
src/components/Panel.ts
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
import { FC, ReactNode } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleDetailsByExport } from '../webpack';
|
||||||
|
|
||||||
|
// TODO where did this go?
|
||||||
|
// export const Panel: FC<{ children?: ReactNode; }> = findModuleExport((e: Export) => {
|
||||||
|
// if (typeof mod !== 'object' || !mod.__esModule) return undefined;
|
||||||
|
// return mod.Panel;
|
||||||
|
// });
|
||||||
|
|
||||||
|
export interface PanelSectionProps {
|
||||||
|
title?: string;
|
||||||
|
spinner?: boolean;
|
||||||
|
children?: ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
const [mod, panelSection] = findModuleDetailsByExport((e: Export) => e.toString()?.includes('.PanelSection'));
|
||||||
|
|
||||||
|
export const PanelSection = panelSection as FC<PanelSectionProps>;
|
||||||
|
|
||||||
|
export interface PanelSectionRowProps {
|
||||||
|
children?: ReactNode;
|
||||||
|
}
|
||||||
|
export const PanelSectionRow = Object.values(mod).filter(
|
||||||
|
(exp: any) => !exp?.toString?.()?.includes('.PanelSection'),
|
||||||
|
)[0] as FC<PanelSectionRowProps>;
|
||||||
38
src/components/ProgressBar.ts
Normal file
38
src/components/ProgressBar.ts
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
import { ReactNode, FC } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
import { ItemProps } from './Item';
|
||||||
|
import { createPropListRegex } from '../utils';
|
||||||
|
|
||||||
|
export interface ProgressBarItemProps extends ItemProps {
|
||||||
|
indeterminate?: boolean;
|
||||||
|
nTransitionSec?: number;
|
||||||
|
nProgress?: number;
|
||||||
|
focusable?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ProgressBarProps {
|
||||||
|
indeterminate?: boolean;
|
||||||
|
nTransitionSec?: number;
|
||||||
|
nProgress?: number;
|
||||||
|
focusable?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ProgressBarWithInfoProps extends ProgressBarItemProps {
|
||||||
|
sTimeRemaining?: ReactNode;
|
||||||
|
sOperationText?: ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const ProgressBar = findModuleExport((e: Export) =>
|
||||||
|
e?.toString?.()?.includes('.ProgressBar,"standard"=='),
|
||||||
|
) as FC<ProgressBarProps>;
|
||||||
|
|
||||||
|
export const ProgressBarWithInfo = findModuleExport((e: Export) =>
|
||||||
|
// new || old
|
||||||
|
e?.toString?.()?.includes('.ProgressBarFieldStatus,children') || e?.toString?.()?.includes('.ProgressBarFieldStatus},'),
|
||||||
|
) as FC<ProgressBarWithInfoProps>;
|
||||||
|
|
||||||
|
const progressBarItemRegex = createPropListRegex(["indeterminate", "nTransitionSec", "nProgress"]);
|
||||||
|
export const ProgressBarItem = findModuleExport((e: Export) =>
|
||||||
|
e?.toString && progressBarItemRegex.test(e.toString()),
|
||||||
|
) as FC<ProgressBarItemProps>;
|
||||||
16
src/components/Scroll.ts
Normal file
16
src/components/Scroll.ts
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import { FC, ReactNode } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleByExport, findModuleExport } from '../webpack';
|
||||||
|
|
||||||
|
const ScrollingModule = findModuleByExport((e: Export) => e?.render?.toString?.().includes('{case"x":'));
|
||||||
|
|
||||||
|
const ScrollingModuleProps = ScrollingModule ? Object.values(ScrollingModule) : [];
|
||||||
|
|
||||||
|
export const ScrollPanel = ScrollingModuleProps.find((prop: any) =>
|
||||||
|
prop?.render?.toString?.().includes('{case"x":'),
|
||||||
|
) as FC<{ children?: ReactNode }>;
|
||||||
|
|
||||||
|
export const ScrollPanelGroup: FC<{ children?: ReactNode }> = findModuleExport((e: Export) =>
|
||||||
|
// new || old
|
||||||
|
e?.render?.toString().includes('.FocusVisibleChild(),[])') || e?.render?.toString().includes('.FocusVisibleChild()),[])'),
|
||||||
|
);
|
||||||
30
src/components/SidebarNavigation.ts
Normal file
30
src/components/SidebarNavigation.ts
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
import { ReactNode, FC } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
import { createPropListRegex } from '../utils';
|
||||||
|
|
||||||
|
export interface SidebarNavigationPage {
|
||||||
|
title: ReactNode;
|
||||||
|
content: ReactNode;
|
||||||
|
icon?: ReactNode;
|
||||||
|
visible?: boolean;
|
||||||
|
hideTitle?: boolean;
|
||||||
|
identifier?: string;
|
||||||
|
route?: string;
|
||||||
|
link?: string;
|
||||||
|
padding?: 'none' | 'compact';
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SidebarNavigationProps {
|
||||||
|
title?: ReactNode;
|
||||||
|
pages: (SidebarNavigationPage | 'separator')[];
|
||||||
|
showTitle?: boolean;
|
||||||
|
disableRouteReporting?: boolean;
|
||||||
|
page?: string;
|
||||||
|
onPageRequested?: (page: string) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
const sidebarNavigationRegex = createPropListRegex(["pages", "fnSetNavigateToPage", "disableRouteReporting"]);
|
||||||
|
export const SidebarNavigation = findModuleExport((e: Export) =>
|
||||||
|
e?.toString && sidebarNavigationRegex.test(e.toString()),
|
||||||
|
) as FC<SidebarNavigationProps>;
|
||||||
34
src/components/SliderField.ts
Normal file
34
src/components/SliderField.ts
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
import { FC } from 'react';
|
||||||
|
|
||||||
|
import { CommonUIModule } from '../webpack';
|
||||||
|
import { ItemProps } from './Item';
|
||||||
|
|
||||||
|
export interface NotchLabel {
|
||||||
|
notchIndex: number;
|
||||||
|
label: string;
|
||||||
|
value?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SliderFieldProps extends ItemProps {
|
||||||
|
value: number;
|
||||||
|
min?: number;
|
||||||
|
max?: number;
|
||||||
|
step?: number;
|
||||||
|
notchCount?: number;
|
||||||
|
notchLabels?: NotchLabel[];
|
||||||
|
notchTicksVisible?: boolean;
|
||||||
|
showValue?: boolean;
|
||||||
|
resetValue?: number;
|
||||||
|
disabled?: boolean;
|
||||||
|
editableValue?: boolean;
|
||||||
|
validValues?: 'steps' | 'range' | ((value: number) => boolean);
|
||||||
|
valueSuffix?: string;
|
||||||
|
minimumDpadGranularity?: number;
|
||||||
|
onChange?(value: number): void;
|
||||||
|
className?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const SliderField = Object.values(CommonUIModule).find((mod: any) =>
|
||||||
|
// stable || beta as of oct 2 2024
|
||||||
|
mod?.toString?.()?.includes('SliderField,fallback') || mod?.toString?.()?.includes("SliderField\",")
|
||||||
|
) as FC<SliderFieldProps>;
|
||||||
8
src/components/Spinner.ts
Executable file
8
src/components/Spinner.ts
Executable file
@@ -0,0 +1,8 @@
|
|||||||
|
import { FC, SVGAttributes } from 'react';
|
||||||
|
|
||||||
|
import { IconsModule } from '../webpack';
|
||||||
|
|
||||||
|
// TODO type this and other icons?
|
||||||
|
export const Spinner = IconsModule && Object.values(IconsModule)?.find(
|
||||||
|
(mod: any) => mod?.toString && /Spinner\),children:\[\(0,\w+\.jsx\)\("path",\{d:"M18 /.test(mod.toString()) || /Spinner\)}\)?,.\.createElement\(\"path\",{d:\"M18 /.test(mod.toString()),
|
||||||
|
) as FC<SVGAttributes<SVGElement>>;
|
||||||
12
src/components/SteamSpinner.ts
Executable file
12
src/components/SteamSpinner.ts
Executable file
@@ -0,0 +1,12 @@
|
|||||||
|
import { FC, ReactNode, SVGAttributes } from 'react';
|
||||||
|
|
||||||
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
|
||||||
|
interface SteamSpinnerProps {
|
||||||
|
children?: ReactNode;
|
||||||
|
background?: "transparent"; // defaults to black seemingly, but only "transparent" is checked against
|
||||||
|
}
|
||||||
|
|
||||||
|
export const SteamSpinner = findModuleExport(
|
||||||
|
(e: Export) => e?.toString?.()?.includes('Steam Spinner') && e?.toString?.()?.includes('src'),
|
||||||
|
) as FC<SVGAttributes<SVGElement> & SteamSpinnerProps>;
|
||||||
70
src/components/Tabs.ts
Normal file
70
src/components/Tabs.ts
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
import { FC, ReactNode } from 'react';
|
||||||
|
import { findModuleByExport } from '../webpack';
|
||||||
|
import { FooterLegendProps } from './FooterLegend';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Individual tab objects for the Tabs component
|
||||||
|
*
|
||||||
|
* `id` ID of this tab, can be used with activeTab to auto-focus a given tab
|
||||||
|
* `title` Title shown in the header bar
|
||||||
|
* `renderTabAddon` Return a {@link ReactNode} to render it next to the tab title, i.e. the counts for each tab on the Media page
|
||||||
|
* `content` Content of the tab
|
||||||
|
* `footer` Sets up button handlers and labels
|
||||||
|
*/
|
||||||
|
export interface Tab {
|
||||||
|
id: string;
|
||||||
|
title: string;
|
||||||
|
renderTabAddon?: () => ReactNode;
|
||||||
|
content: ReactNode;
|
||||||
|
footer?: FooterLegendProps;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Props for the {@link Tabs}
|
||||||
|
*
|
||||||
|
* `tabs` array of {@link Tab}
|
||||||
|
* `activeTab` tab currently active, needs to be one of the tabs {@link Tab.id}, must be set using a `useState` in the `onShowTab` handler
|
||||||
|
* `onShowTab` Called when the active tab should change, needs to set `activeTab`. See example.
|
||||||
|
* `autoFocusContents` Whether to automatically focus the tab contents or not.
|
||||||
|
* `footer` Sets up button handlers and labels
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* const Component: FC = () => {
|
||||||
|
* const [currentTab, setCurrentTab] = useState<string>("Tab1");
|
||||||
|
*
|
||||||
|
* return (
|
||||||
|
* <Tabs
|
||||||
|
* title="Theme Manager"
|
||||||
|
* activeTab={currentTabRoute}
|
||||||
|
* onShowTab={(tabID: string) => {
|
||||||
|
* setCurrentTabRoute(tabID);
|
||||||
|
* }}
|
||||||
|
* tabs={[
|
||||||
|
* {
|
||||||
|
* title: "Tab 1",
|
||||||
|
* content: <Tab1Component />,
|
||||||
|
* id: "Tab1",
|
||||||
|
* },
|
||||||
|
* {
|
||||||
|
* title: "Tab 2",
|
||||||
|
* content: <Tab2Component />,
|
||||||
|
* id: "Tab2",
|
||||||
|
* },
|
||||||
|
* ]}
|
||||||
|
* />
|
||||||
|
* );
|
||||||
|
* };
|
||||||
|
*/
|
||||||
|
export interface TabsProps {
|
||||||
|
tabs: Tab[];
|
||||||
|
activeTab: string;
|
||||||
|
onShowTab: (tab: string) => void;
|
||||||
|
autoFocusContents?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
const tabsModule = findModuleByExport(e => e?.toString?.()?.includes(".TabRowTabs") && e?.toString?.()?.includes("activeTab:"));
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tabs component as used in the library and media tabs. See {@link TabsProps}.
|
||||||
|
*/
|
||||||
|
export const Tabs = tabsModule && Object.values(tabsModule).find((e: any) => e?.type?.toString?.()?.includes("(function()")) as FC<TabsProps>;
|
||||||
@@ -1,11 +1,12 @@
|
|||||||
import { ChangeEventHandler, ReactNode, VFC } from 'react';
|
import { ChangeEventHandler, HTMLAttributes, ReactNode, FC } from 'react';
|
||||||
|
|
||||||
import { CommonUIModule, Module } from '../webpack';
|
import { CommonUIModule, Module } from '../webpack';
|
||||||
|
|
||||||
export interface TextFieldProps {
|
export interface TextFieldProps extends HTMLAttributes<HTMLInputElement> {
|
||||||
label?: ReactNode;
|
label?: ReactNode;
|
||||||
requiredLabel?: ReactNode;
|
requiredLabel?: ReactNode;
|
||||||
description?: ReactNode;
|
description?: ReactNode;
|
||||||
|
disabled?: boolean;
|
||||||
bShowCopyAction?: boolean;
|
bShowCopyAction?: boolean;
|
||||||
bShowClearAction?: boolean;
|
bShowClearAction?: boolean;
|
||||||
bAlwaysShowClearAction?: boolean;
|
bAlwaysShowClearAction?: boolean;
|
||||||
@@ -18,12 +19,10 @@ export interface TextFieldProps {
|
|||||||
focusOnMount?: boolean;
|
focusOnMount?: boolean;
|
||||||
tooltip?: string;
|
tooltip?: string;
|
||||||
inlineControls?: ReactNode;
|
inlineControls?: ReactNode;
|
||||||
onChange?(event: ChangeEventHandler<HTMLInputElement>): void;
|
onChange?: ChangeEventHandler<HTMLInputElement>;
|
||||||
value?: string;
|
value?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const TextField = Object.values(CommonUIModule).find(
|
export const TextField = Object.values(CommonUIModule).find(
|
||||||
(mod: Module) => mod?.validateUrl && mod?.validateEmail,
|
(mod: Module) => mod?.validateUrl && mod?.validateEmail,
|
||||||
) as VFC<TextFieldProps>;
|
) as FC<TextFieldProps>;
|
||||||
|
|
||||||
console.log(TextField);
|
|
||||||
@@ -3,14 +3,12 @@ import { FC } from 'react';
|
|||||||
import { CommonUIModule } from '../webpack';
|
import { CommonUIModule } from '../webpack';
|
||||||
|
|
||||||
export interface ToggleProps {
|
export interface ToggleProps {
|
||||||
label?: string;
|
value: boolean;
|
||||||
description?: string;
|
|
||||||
checked: boolean;
|
|
||||||
icon?: JSX.Element;
|
|
||||||
disabled?: boolean;
|
disabled?: boolean;
|
||||||
onChange?(checked: boolean): void;
|
onChange?(checked: boolean): void;
|
||||||
|
navRef?: any; // TODO figure out what this is
|
||||||
}
|
}
|
||||||
|
|
||||||
export const Toggle = Object.values(CommonUIModule).find((mod: any) =>
|
export const Toggle = Object.values(CommonUIModule).find((mod: any) =>
|
||||||
mod?.render?.toString()?.includes('ToggleField,fallback'),
|
mod?.render?.toString?.()?.includes('.ToggleOff)'),
|
||||||
) as FC<ToggleProps>;
|
) as FC<ToggleProps>;
|
||||||
16
src/components/ToggleField.ts
Normal file
16
src/components/ToggleField.ts
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import { FC } from 'react';
|
||||||
|
|
||||||
|
import { CommonUIModule } from '../webpack';
|
||||||
|
import { ItemProps } from './Item';
|
||||||
|
|
||||||
|
export interface ToggleFieldProps extends ItemProps {
|
||||||
|
highlightOnFocus?: boolean;
|
||||||
|
checked: boolean;
|
||||||
|
disabled?: boolean;
|
||||||
|
onChange?(checked: boolean): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const ToggleField = Object.values(CommonUIModule).find((mod: any) =>
|
||||||
|
// stable || beta as of oct 2 2024
|
||||||
|
mod?.render?.toString?.()?.includes('ToggleField,fallback') || mod?.render?.toString?.()?.includes("ToggleField\",")
|
||||||
|
) as FC<ToggleFieldProps>;
|
||||||
26
src/components/index.ts
Executable file
26
src/components/index.ts
Executable file
@@ -0,0 +1,26 @@
|
|||||||
|
export * from './Button';
|
||||||
|
export * from './ButtonItem';
|
||||||
|
export * from './Carousel';
|
||||||
|
export * from './ControlsList';
|
||||||
|
export * from './Dialog';
|
||||||
|
export * from './DialogCheckbox';
|
||||||
|
export * from './Dropdown';
|
||||||
|
export * from './ErrorBoundary';
|
||||||
|
export * from './Field';
|
||||||
|
export * from './Focusable';
|
||||||
|
export * from './FocusRing';
|
||||||
|
export * from './FooterLegend';
|
||||||
|
export * from './Marquee';
|
||||||
|
export * from './Menu';
|
||||||
|
export * from './Modal';
|
||||||
|
export * from './Panel';
|
||||||
|
export * from './ProgressBar';
|
||||||
|
export * from './SidebarNavigation';
|
||||||
|
export * from './SliderField';
|
||||||
|
export * from './Spinner';
|
||||||
|
export * from './SteamSpinner';
|
||||||
|
export * from './Tabs';
|
||||||
|
export * from './TextField';
|
||||||
|
export * from './Toggle';
|
||||||
|
export * from './ToggleField';
|
||||||
|
export * from './Scroll';
|
||||||
132
src/custom-components/ColorPickerModal.tsx
Normal file
132
src/custom-components/ColorPickerModal.tsx
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
import { CSSProperties, FC, useState } from 'react';
|
||||||
|
|
||||||
|
import { ConfirmModal, SliderField } from '../components';
|
||||||
|
import { gamepadSliderClasses } from '../utils/static-classes';
|
||||||
|
|
||||||
|
interface ColorPickerModalProps {
|
||||||
|
closeModal: () => void;
|
||||||
|
onConfirm?(HSLString: string): any;
|
||||||
|
title?: string;
|
||||||
|
defaultH?: number;
|
||||||
|
defaultS?: number;
|
||||||
|
defaultL?: number;
|
||||||
|
defaultA?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const ColorPickerModal: FC<ColorPickerModalProps> = ({
|
||||||
|
closeModal,
|
||||||
|
onConfirm = () => {},
|
||||||
|
title = 'Color Picker',
|
||||||
|
defaultH = 0,
|
||||||
|
defaultS = 100,
|
||||||
|
defaultL = 50,
|
||||||
|
defaultA = 1,
|
||||||
|
}) => {
|
||||||
|
const [H, setH] = useState<number>(defaultH);
|
||||||
|
const [S, setS] = useState<number>(defaultS);
|
||||||
|
const [L, setL] = useState<number>(defaultL);
|
||||||
|
const [A, setA] = useState<number>(defaultA);
|
||||||
|
|
||||||
|
const colorPickerCSSVars = {
|
||||||
|
'--decky-color-picker-hvalue': `${H}`,
|
||||||
|
'--decky-color-picker-svalue': `${S}%`,
|
||||||
|
'--decky-color-picker-lvalue': `${L}%`,
|
||||||
|
'--decky-color-picker-avalue': `${A}`,
|
||||||
|
} as CSSProperties;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<ConfirmModal
|
||||||
|
bAllowFullSize
|
||||||
|
onCancel={closeModal}
|
||||||
|
onOK={() => {
|
||||||
|
onConfirm(`hsla(${H}, ${S}%, ${L}%, ${A})`);
|
||||||
|
closeModal();
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<style>
|
||||||
|
{`
|
||||||
|
/* This removes the cyan track color that is behind the slider head */
|
||||||
|
.ColorPicker_Container .${gamepadSliderClasses.SliderTrack} {
|
||||||
|
--left-track-color: #0000;
|
||||||
|
/* This is for compatibility with the "Colored Toggles" CSSLoader Theme*/
|
||||||
|
--colored-toggles-main-color: #0000;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ColorPicker_HSlider .${gamepadSliderClasses.SliderTrack} {
|
||||||
|
background: linear-gradient(
|
||||||
|
270deg,
|
||||||
|
hsla(360, var(--decky-color-picker-svalue), var(--decky-color-picker-lvalue), var(--decky-color-picker-avalue)),
|
||||||
|
hsla(270, var(--decky-color-picker-svalue), var(--decky-color-picker-lvalue), var(--decky-color-picker-avalue)),
|
||||||
|
hsla(180, var(--decky-color-picker-svalue), var(--decky-color-picker-lvalue), var(--decky-color-picker-avalue)),
|
||||||
|
hsla(90, var(--decky-color-picker-svalue), var(--decky-color-picker-lvalue), var(--decky-color-picker-avalue)),
|
||||||
|
hsla(0, var(--decky-color-picker-svalue), var(--decky-color-picker-lvalue), var(--decky-color-picker-avalue))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
.ColorPicker_SSlider .${gamepadSliderClasses.SliderTrack} {
|
||||||
|
background: linear-gradient(
|
||||||
|
90deg,
|
||||||
|
hsla(var(--decky-color-picker-hvalue), 0%, var(--decky-color-picker-lvalue), var(--decky-color-picker-avalue)),
|
||||||
|
hsla(var(--decky-color-picker-hvalue), 100%, var(--decky-color-picker-lvalue), var(--decky-color-picker-avalue))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
.ColorPicker_LSlider .${gamepadSliderClasses.SliderTrack} {
|
||||||
|
background: linear-gradient(
|
||||||
|
90deg,
|
||||||
|
hsla(var(--decky-color-picker-hvalue), var(--decky-color-picker-svalue), 0%, var(--decky-color-picker-avalue)),
|
||||||
|
hsla(var(--decky-color-picker-hvalue), var(--decky-color-picker-svalue), 50%, var(--decky-color-picker-avalue)),
|
||||||
|
hsla(var(--decky-color-picker-hvalue), var(--decky-color-picker-svalue), 100%, var(--decky-color-picker-avalue))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
.ColorPicker_ASlider .${gamepadSliderClasses.SliderTrack} {
|
||||||
|
background: linear-gradient(
|
||||||
|
90deg,
|
||||||
|
hsla(var(--decky-color-picker-hvalue), var(--decky-color-picker-svalue), var(--decky-color-picker-lvalue), 0),
|
||||||
|
hsla(var(--decky-color-picker-hvalue), var(--decky-color-picker-svalue), var(--decky-color-picker-lvalue), 1)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
`}
|
||||||
|
</style>
|
||||||
|
<div
|
||||||
|
className="ColorPicker_ColorDisplayContainer"
|
||||||
|
style={{
|
||||||
|
display: 'flex',
|
||||||
|
justifyContent: 'space-between',
|
||||||
|
alignItems: 'center',
|
||||||
|
marginBottom: '1em',
|
||||||
|
// theres a large header by default on the modal, so this just pushes it up into that unused space
|
||||||
|
marginTop: '-2.5em',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<div>
|
||||||
|
<span style={{ fontSize: '1.5em' }}>
|
||||||
|
<b>{title}</b>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
backgroundColor: `hsla(${H}, ${S}%, ${L}%, ${A})`,
|
||||||
|
width: '40px',
|
||||||
|
height: '40px',
|
||||||
|
}}
|
||||||
|
></div>
|
||||||
|
</div>
|
||||||
|
<div className="ColorPicker_Container" style={colorPickerCSSVars}>
|
||||||
|
<div className="ColorPicker_HSlider">
|
||||||
|
<SliderField showValue editableValue label="Hue" value={H} min={0} max={360} onChange={setH} />
|
||||||
|
</div>
|
||||||
|
<div className="ColorPicker_SSlider">
|
||||||
|
<SliderField showValue editableValue label="Saturation" value={S} min={0} max={100} onChange={setS} />
|
||||||
|
</div>
|
||||||
|
<div className="ColorPicker_LSlider">
|
||||||
|
<SliderField showValue editableValue label="Lightness" value={L} min={0} max={100} onChange={setL} />
|
||||||
|
</div>
|
||||||
|
<div className="ColorPicker_ASlider">
|
||||||
|
<SliderField showValue editableValue label="Alpha" value={A} step={0.1} min={0} max={1} onChange={setA} />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</ConfirmModal>
|
||||||
|
);
|
||||||
|
};
|
||||||
183
src/custom-components/ReorderableList.tsx
Normal file
183
src/custom-components/ReorderableList.tsx
Normal file
@@ -0,0 +1,183 @@
|
|||||||
|
import { Fragment, JSXElementConstructor, ReactElement, ReactNode, useEffect, useState } from 'react';
|
||||||
|
|
||||||
|
import { Field, FieldProps, Focusable, GamepadButton } from '../components';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A ReorderableList entry of type <T>.
|
||||||
|
* @param label The name of this entry in the list.
|
||||||
|
* @param data Optional data to connect to this entry.
|
||||||
|
* @param position The position of this entry in the list.
|
||||||
|
*/
|
||||||
|
export type ReorderableEntry<T> = {
|
||||||
|
label: ReactNode;
|
||||||
|
data?: T;
|
||||||
|
position: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Properties for a ReorderableList component of type <T>.
|
||||||
|
*
|
||||||
|
* @param animate If the list should animate. @default true
|
||||||
|
*/
|
||||||
|
export type ReorderableListProps<T> = {
|
||||||
|
entries: ReorderableEntry<T>[];
|
||||||
|
onSave: (entries: ReorderableEntry<T>[]) => void;
|
||||||
|
interactables?: JSXElementConstructor<{ entry: ReorderableEntry<T> }>;
|
||||||
|
fieldProps?: FieldProps;
|
||||||
|
animate?: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A component for creating reorderable lists.
|
||||||
|
*
|
||||||
|
* See an example implementation {@linkplain https://github.com/Tormak9970/Component-Testing-Plugin/blob/main/src/testing-window/ReorderableListTest.tsx here}.
|
||||||
|
*/
|
||||||
|
export function ReorderableList<T>(props: ReorderableListProps<T>) {
|
||||||
|
if (props.animate === undefined) props.animate = true;
|
||||||
|
const [entryList, setEntryList] = useState<ReorderableEntry<T>[]>(
|
||||||
|
[...props.entries].sort((a: ReorderableEntry<T>, b: ReorderableEntry<T>) => a.position - b.position),
|
||||||
|
);
|
||||||
|
const [reorderEnabled, setReorderEnabled] = useState<boolean>(false);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
setEntryList([...props.entries].sort((a: ReorderableEntry<T>, b: ReorderableEntry<T>) => a.position - b.position));
|
||||||
|
}, [props.entries]);
|
||||||
|
|
||||||
|
function toggleReorderEnabled(): void {
|
||||||
|
let newReorderValue = !reorderEnabled;
|
||||||
|
setReorderEnabled(newReorderValue);
|
||||||
|
|
||||||
|
if (!newReorderValue) {
|
||||||
|
props.onSave(entryList);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function saveOnBackout(e: Event) {
|
||||||
|
const event = e as CustomEvent;
|
||||||
|
if (event.detail.button == GamepadButton.CANCEL && reorderEnabled) {
|
||||||
|
setReorderEnabled(!reorderEnabled);
|
||||||
|
props.onSave(entryList);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Fragment>
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
width: 'inherit',
|
||||||
|
height: 'inherit',
|
||||||
|
flex: '1 1 1px',
|
||||||
|
scrollPadding: '48px 0px',
|
||||||
|
display: 'flex',
|
||||||
|
flexDirection: 'column',
|
||||||
|
justifyContent: 'flex-start',
|
||||||
|
alignContent: 'stretch',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<Focusable
|
||||||
|
onSecondaryButton={toggleReorderEnabled}
|
||||||
|
onSecondaryActionDescription={reorderEnabled ? 'Save Order' : 'Reorder'}
|
||||||
|
onClick={toggleReorderEnabled}
|
||||||
|
onButtonDown={saveOnBackout}
|
||||||
|
>
|
||||||
|
{entryList.map((entry: ReorderableEntry<T>) => (
|
||||||
|
<ReorderableItem
|
||||||
|
animate={props.animate!}
|
||||||
|
listData={entryList}
|
||||||
|
entryData={entry}
|
||||||
|
reorderEntryFunc={setEntryList}
|
||||||
|
reorderEnabled={reorderEnabled}
|
||||||
|
fieldProps={props.fieldProps}
|
||||||
|
>
|
||||||
|
{props.interactables ? <props.interactables entry={entry} /> : null}
|
||||||
|
</ReorderableItem>
|
||||||
|
))}
|
||||||
|
</Focusable>
|
||||||
|
</div>
|
||||||
|
</Fragment>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Properties for a ReorderableItem component of type <T>
|
||||||
|
*/
|
||||||
|
export type ReorderableListEntryProps<T> = {
|
||||||
|
fieldProps?: FieldProps;
|
||||||
|
listData: ReorderableEntry<T>[];
|
||||||
|
entryData: ReorderableEntry<T>;
|
||||||
|
reorderEntryFunc: CallableFunction;
|
||||||
|
reorderEnabled: boolean;
|
||||||
|
animate: boolean;
|
||||||
|
children: ReactElement<any> | null;
|
||||||
|
};
|
||||||
|
|
||||||
|
function ReorderableItem<T>(props: ReorderableListEntryProps<T>) {
|
||||||
|
const [isSelected, _setIsSelected] = useState<boolean>(false);
|
||||||
|
const [isSelectedLastFrame, setIsSelectedLastFrame] = useState<boolean>(false);
|
||||||
|
const listEntries = props.listData;
|
||||||
|
|
||||||
|
function onReorder(e: Event): void {
|
||||||
|
if (!props.reorderEnabled) return;
|
||||||
|
|
||||||
|
const event = e as CustomEvent;
|
||||||
|
const currentIdx = listEntries.findIndex((entryData: ReorderableEntry<T>) => entryData === props.entryData);
|
||||||
|
const currentIdxValue = listEntries[currentIdx];
|
||||||
|
if (currentIdx < 0) return;
|
||||||
|
|
||||||
|
let targetPosition: number = -1;
|
||||||
|
if (event.detail.button == GamepadButton.DIR_DOWN) {
|
||||||
|
targetPosition = currentIdxValue.position + 1;
|
||||||
|
} else if (event.detail.button == GamepadButton.DIR_UP) {
|
||||||
|
targetPosition = currentIdxValue.position - 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (targetPosition >= listEntries.length || targetPosition < 0) return;
|
||||||
|
|
||||||
|
let otherToUpdate = listEntries.find((entryData: ReorderableEntry<T>) => entryData.position === targetPosition);
|
||||||
|
if (!otherToUpdate) return;
|
||||||
|
|
||||||
|
let currentPosition = currentIdxValue.position;
|
||||||
|
|
||||||
|
currentIdxValue.position = otherToUpdate.position;
|
||||||
|
otherToUpdate.position = currentPosition;
|
||||||
|
|
||||||
|
props.reorderEntryFunc(
|
||||||
|
[...listEntries].sort((a: ReorderableEntry<T>, b: ReorderableEntry<T>) => a.position - b.position),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function setIsSelected(val: boolean) {
|
||||||
|
_setIsSelected(val);
|
||||||
|
// Wait 3 frames, then set. I have no idea why, but if you dont wait long enough it doesn't work.
|
||||||
|
for (let i = 0; i < 3; i++) await new Promise((res) => requestAnimationFrame(res));
|
||||||
|
setIsSelectedLastFrame(val);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
style={
|
||||||
|
props.animate
|
||||||
|
? {
|
||||||
|
transition:
|
||||||
|
isSelected || isSelectedLastFrame
|
||||||
|
? ''
|
||||||
|
: 'transform 0.3s cubic-bezier(0.25, 1, 0.5, 1), opacity 0.3s cubic-bezier(0.25, 1, 0.5, 1)', // easeOutQuart https://easings.net/#easeOutQuart
|
||||||
|
transform: !props.reorderEnabled || isSelected ? 'scale(1)' : 'scale(0.9)',
|
||||||
|
opacity: !props.reorderEnabled || isSelected ? 1 : 0.7,
|
||||||
|
}
|
||||||
|
: {}
|
||||||
|
}
|
||||||
|
>
|
||||||
|
<Field
|
||||||
|
label={props.entryData.label}
|
||||||
|
{...props.fieldProps}
|
||||||
|
focusable={!props.children}
|
||||||
|
onButtonDown={onReorder}
|
||||||
|
onGamepadBlur={() => setIsSelected(false)}
|
||||||
|
onGamepadFocus={() => setIsSelected(true)}
|
||||||
|
>
|
||||||
|
<Focusable style={{ display: 'flex', width: '100%', position: 'relative' }}>{props.children}</Focusable>
|
||||||
|
</Field>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
44
src/custom-components/SuspensefulImage.tsx
Normal file
44
src/custom-components/SuspensefulImage.tsx
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
import { useEffect } from 'react';
|
||||||
|
import { FC, ImgHTMLAttributes, useState } from 'react';
|
||||||
|
|
||||||
|
import { Spinner } from '../components';
|
||||||
|
|
||||||
|
interface SuspensefulImageProps extends ImgHTMLAttributes<HTMLImageElement> {
|
||||||
|
suspenseWidth?: string | number;
|
||||||
|
suspenseHeight?: string | number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const SuspensefulImage: FC<SuspensefulImageProps> = (props) => {
|
||||||
|
const [loading, setLoading] = useState(true);
|
||||||
|
const [error, setError] = useState(false);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
setLoading(true);
|
||||||
|
setError(false);
|
||||||
|
const img = new Image();
|
||||||
|
img.src = props.src || '';
|
||||||
|
img.addEventListener('load', () => {
|
||||||
|
setLoading(false);
|
||||||
|
});
|
||||||
|
img.addEventListener('error', () => {
|
||||||
|
setError(true);
|
||||||
|
});
|
||||||
|
}, [props.src]);
|
||||||
|
|
||||||
|
return loading ? (
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
width: props.suspenseWidth || props.style?.width,
|
||||||
|
height: props.suspenseHeight || props.style?.height,
|
||||||
|
background: 'rgba(255, 255, 255, 0.2)',
|
||||||
|
display: 'flex',
|
||||||
|
alignItems: 'center',
|
||||||
|
justifyContent: 'center',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{error ? 'Missing image' : <Spinner style={{ height: '48px' }} />}
|
||||||
|
</div>
|
||||||
|
) : (
|
||||||
|
<img {...props} />
|
||||||
|
);
|
||||||
|
};
|
||||||
3
src/custom-components/index.ts
Normal file
3
src/custom-components/index.ts
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
export * from './SuspensefulImage';
|
||||||
|
export * from './ColorPickerModal';
|
||||||
|
export * from './ReorderableList';
|
||||||
1
src/custom-hooks/index.ts
Normal file
1
src/custom-hooks/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export * from './useQuickAccessVisible';
|
||||||
65
src/custom-hooks/useQuickAccessVisible.ts
Normal file
65
src/custom-hooks/useQuickAccessVisible.ts
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
import { useEffect, useState } from 'react';
|
||||||
|
|
||||||
|
import { getGamepadNavigationTrees } from '../utils';
|
||||||
|
|
||||||
|
function getQuickAccessWindow(): Window | null {
|
||||||
|
const navTrees = getGamepadNavigationTrees();
|
||||||
|
return (
|
||||||
|
navTrees.find((tree: any) => tree?.id === 'QuickAccess-NA')?.m_Root?.m_element?.ownerDocument.defaultView ?? null
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns state indicating the visibility of quick access menu.
|
||||||
|
*
|
||||||
|
* @deprecated moved to @decky/api
|
||||||
|
*
|
||||||
|
* @returns `true` if quick access menu is visible and `false` otherwise.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* import { FC, useEffect } from "react";
|
||||||
|
* import { useQuickAccessVisible } from "@decky/ui";
|
||||||
|
*
|
||||||
|
* export const PluginPanelView: FC<{}> = ({ }) => {
|
||||||
|
* const isVisible = useQuickAccessVisible();
|
||||||
|
*
|
||||||
|
* useEffect(() => {
|
||||||
|
* if (!isVisible) {
|
||||||
|
* return;
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* const interval = setInterval(() => console.log("Hello world!"), 1000);
|
||||||
|
* return () => {
|
||||||
|
* clearInterval(interval);
|
||||||
|
* }
|
||||||
|
* }, [isVisible])
|
||||||
|
*
|
||||||
|
* return (
|
||||||
|
* <div>
|
||||||
|
* {isVisible ? "VISIBLE" : "INVISIBLE"}
|
||||||
|
* </div>
|
||||||
|
* );
|
||||||
|
* };
|
||||||
|
*/
|
||||||
|
export function useQuickAccessVisible(): boolean {
|
||||||
|
// By default we say that document is not hidden, unless we know otherwise.
|
||||||
|
// This would cover the cases when Valve breaks something and the quick access window
|
||||||
|
// cannot be accessed anymore - the plugins that use this would continue working somewhat.
|
||||||
|
const [isHidden, setIsHidden] = useState(getQuickAccessWindow()?.document.hidden ?? false);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const quickAccessWindow = getQuickAccessWindow();
|
||||||
|
if (quickAccessWindow === null) {
|
||||||
|
console.error('Could not get window of QuickAccess menu!');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const onVisibilityChange = () => setIsHidden(quickAccessWindow.document.hidden);
|
||||||
|
quickAccessWindow.addEventListener('visibilitychange', onVisibilityChange);
|
||||||
|
return () => {
|
||||||
|
quickAccessWindow.removeEventListener('visibilitychange', onVisibilityChange);
|
||||||
|
};
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
return !isHidden;
|
||||||
|
}
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
import { FC } from 'react';
|
|
||||||
|
|
||||||
import { CommonUIModule } from '../webpack';
|
|
||||||
|
|
||||||
export interface ButtonProps {
|
|
||||||
className?: string;
|
|
||||||
noFocusRing?: boolean;
|
|
||||||
disabled?: boolean;
|
|
||||||
onClick?(e: MouseEvent): void;
|
|
||||||
onPointerDown?(e: PointerEvent): void;
|
|
||||||
onPointerUp?(e: PointerEvent): void;
|
|
||||||
onPointerCancel?(e: PointerEvent): void;
|
|
||||||
onMouseDown?(e: PointerEvent): void;
|
|
||||||
onMouseUp?(e: MouseEvent): void;
|
|
||||||
onTouchStart?(e: TouchEvent): void;
|
|
||||||
onTouchEnd?(e: TouchEvent): void;
|
|
||||||
onTouchCancel?(e: TouchEvent): void;
|
|
||||||
onSubmit?(e: SubmitEvent): void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const DialogButton = Object.values(CommonUIModule).find(
|
|
||||||
(mod: any) =>
|
|
||||||
mod?.render?.toString()?.includes('Object.assign({type:"button"') &&
|
|
||||||
mod?.render?.toString()?.includes('DialogButton'),
|
|
||||||
) as any;
|
|
||||||
|
|
||||||
// Button isn't exported, so call DialogButton to grab it
|
|
||||||
|
|
||||||
export const Button = DialogButton!.render({}).type as FC<ButtonProps>; // its actually a forwarded ref but that doesn't really matter in usage
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
import { FC } from 'react';
|
|
||||||
|
|
||||||
import { CommonUIModule } from '../webpack';
|
|
||||||
|
|
||||||
export interface ButtonItemProps {
|
|
||||||
label?: string;
|
|
||||||
description?: string;
|
|
||||||
layout?: 'below';
|
|
||||||
icon?: JSX.Element;
|
|
||||||
onClick?(e: MouseEvent): void;
|
|
||||||
disabled?: boolean;
|
|
||||||
bottomSeparator?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const ButtonItem = Object.values(CommonUIModule).find((mod: any) =>
|
|
||||||
mod?.render?.toString()?.includes('childrenContainerWidth:"min"'),
|
|
||||||
) as FC<ButtonItemProps>;
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
import { FC, ReactNode } from 'react';
|
|
||||||
|
|
||||||
import { findModuleChild } from '../webpack';
|
|
||||||
|
|
||||||
export const showContextMenu: (children: ReactNode, parent?: EventTarget) => void = findModuleChild((m) => {
|
|
||||||
if (typeof m !== 'object') return undefined;
|
|
||||||
for (let prop in m) {
|
|
||||||
if (typeof m[prop] === 'function' && m[prop].toString().includes('stopPropagation))')) {
|
|
||||||
return m[prop];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
export interface MenuProps {
|
|
||||||
label: string;
|
|
||||||
onCancel?(): void;
|
|
||||||
cancelText?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const Menu: FC<MenuProps> = findModuleChild((m) => {
|
|
||||||
if (typeof m !== 'object') return undefined;
|
|
||||||
|
|
||||||
for (let prop in m) {
|
|
||||||
if (m[prop]?.prototype?.HideIfSubmenu && m[prop]?.prototype?.HideMenu) {
|
|
||||||
return m[prop];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
export interface MenuItemProps {
|
|
||||||
onSelected?(): void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const MenuItem: FC<MenuItemProps> = findModuleChild((m) => {
|
|
||||||
if (typeof m !== 'object') return undefined;
|
|
||||||
|
|
||||||
for (let prop in m) {
|
|
||||||
if (m[prop]?.prototype?.OnOKButton && m[prop]?.prototype?.OnMouseEnter) {
|
|
||||||
return m[prop];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
/*
|
|
||||||
all().map(m => {
|
|
||||||
if (typeof m !== "object") return undefined;
|
|
||||||
for (let prop in m) { if (m[prop]?.prototype?.OK && m[prop]?.prototype?.Cancel && m[prop]?.prototype?.render) return m[prop]}
|
|
||||||
}).find(x => x)
|
|
||||||
*/
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
import { FC, ReactNode } from 'react';
|
|
||||||
|
|
||||||
import { findModuleChild } from '../webpack';
|
|
||||||
|
|
||||||
// TODO: there is another argument, figure out what it does
|
|
||||||
export const showModal: (children: ReactNode, parent?: EventTarget) => void = findModuleChild((m) => {
|
|
||||||
if (typeof m !== 'object') return undefined;
|
|
||||||
for (let prop in m) {
|
|
||||||
if (typeof m[prop] === 'function' && m[prop].toString().includes('bHideMainWindowForPopouts:!0')) {
|
|
||||||
return m[prop];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
export interface ModalRootProps {
|
|
||||||
onMiddleButton?(): void;
|
|
||||||
onCancel?(): void;
|
|
||||||
onOK?(): void;
|
|
||||||
bAllowFullSize?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const ModalRoot = findModuleChild((m) => {
|
|
||||||
if (typeof m !== 'object') return undefined;
|
|
||||||
for (let prop in m) {
|
|
||||||
if (!m[prop]?.prototype?.OK && m[prop]?.prototype?.Cancel && m[prop]?.prototype?.render) {
|
|
||||||
return m[prop];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}) as FC<ModalRootProps>;
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
import { FC } from 'react';
|
|
||||||
|
|
||||||
import { findModuleChild } from '../webpack';
|
|
||||||
|
|
||||||
export interface PanelSectionProps {
|
|
||||||
title?: string;
|
|
||||||
spinner?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
const [panelSection, mod] = findModuleChild((mod: any) => {
|
|
||||||
for (let prop in mod) {
|
|
||||||
if (mod[prop]?.toString()?.includes('.PanelSection')) {
|
|
||||||
return [mod[prop], mod];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
});
|
|
||||||
|
|
||||||
export const PanelSection = panelSection as FC<PanelSectionProps>;
|
|
||||||
|
|
||||||
export const PanelSectionRow = Object.values(mod).filter(
|
|
||||||
(exp: any) => !exp?.toString()?.includes('.PanelSection'),
|
|
||||||
)[0] as FC;
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
import { Module, findModuleChild } from '../webpack';
|
|
||||||
|
|
||||||
export enum SideMenu {
|
|
||||||
None,
|
|
||||||
Main,
|
|
||||||
QuickAccess,
|
|
||||||
}
|
|
||||||
|
|
||||||
export enum QuickAccessTab {
|
|
||||||
Notifications,
|
|
||||||
RemotePlayTogetherControls,
|
|
||||||
VoiceChat,
|
|
||||||
Friends,
|
|
||||||
Settings,
|
|
||||||
Perf,
|
|
||||||
Help,
|
|
||||||
Decky,
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface Router {
|
|
||||||
CloseSideMenus(): void;
|
|
||||||
OpenQuickAccessMenu(quickAccessTab: QuickAccessTab): void;
|
|
||||||
GetQuickAccessTab(): QuickAccessTab;
|
|
||||||
Navigate(path: string): void;
|
|
||||||
NavigateToExternalWeb(url: string): void;
|
|
||||||
ToggleSideMenu(sideMenu: SideMenu): void;
|
|
||||||
CloseSideMenus(): void;
|
|
||||||
OpenSideMenu(sideMenu: SideMenu): void;
|
|
||||||
OpenPowerMenu(unknown?: any): void;
|
|
||||||
get RunningApps(): any;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const Router = findModuleChild((m: Module) => {
|
|
||||||
if (typeof m !== 'object') return undefined;
|
|
||||||
for (let prop in m) {
|
|
||||||
if (m[prop]?.Navigate && m[prop]?.NavigationManager) return m[prop];
|
|
||||||
}
|
|
||||||
}) as Router;
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
import { FC } from 'react';
|
|
||||||
|
|
||||||
import { CommonUIModule } from '../webpack';
|
|
||||||
|
|
||||||
export interface NotchLabel {
|
|
||||||
notchIndex: number;
|
|
||||||
label: string;
|
|
||||||
value: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface SliderProps {
|
|
||||||
label?: string;
|
|
||||||
value: number;
|
|
||||||
layout?: 'below';
|
|
||||||
icon?: JSX.Element;
|
|
||||||
min?: number;
|
|
||||||
max?: number;
|
|
||||||
step?: number;
|
|
||||||
notchCount?: number;
|
|
||||||
notchLabels?: NotchLabel[];
|
|
||||||
onChange?(value: number): void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const Slider = Object.values(CommonUIModule).find((mod: any) =>
|
|
||||||
mod?.render?.toString()?.includes('SliderField,fallback'),
|
|
||||||
) as FC<SliderProps>;
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
import { FC } from 'react';
|
|
||||||
|
|
||||||
import { IconsModule } from '../webpack';
|
|
||||||
|
|
||||||
// TODO type this and other icons?
|
|
||||||
export const Spinner = Object.values(IconsModule).find((mod: any) =>
|
|
||||||
mod?.toString && /Spinner\)}\),.\.createElement\(\"path\",{d:\"M18 /.test(mod.toString())
|
|
||||||
) as FC<{}>;
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
import { FC } from 'react';
|
|
||||||
import { findModuleChild } from '../webpack';
|
|
||||||
|
|
||||||
export const SteamSpinner = findModuleChild((m) => {
|
|
||||||
if (typeof m !== "object") return undefined;
|
|
||||||
for (let prop in m) {
|
|
||||||
if (m[prop]?.toString()?.includes("Steam Spinner") && m[prop].toString().includes("PreloadThrobber")) return m[prop]
|
|
||||||
}
|
|
||||||
}) as FC<{}>;
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
export * from './Button';
|
|
||||||
export * from './ButtonItem';
|
|
||||||
export * from './Menu';
|
|
||||||
export * from './Modal';
|
|
||||||
export * from './Panel';
|
|
||||||
export * from './Router';
|
|
||||||
export * from './Slider';
|
|
||||||
export * from './Spinner';
|
|
||||||
export * from './static-classes';
|
|
||||||
export * from './SteamSpinner';
|
|
||||||
export * from './TextField';
|
|
||||||
export * from './Toggle';
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
import { findModuleChild } from '../webpack';
|
|
||||||
|
|
||||||
type StaticClasses = Record<
|
|
||||||
| 'ActiveTab'
|
|
||||||
| 'AllTabContents'
|
|
||||||
| 'BatteryDetailsLabels'
|
|
||||||
| 'BatteryIcon'
|
|
||||||
| 'BatteryPercentageLabel'
|
|
||||||
| 'BatteryProjectedLabel'
|
|
||||||
| 'BatteryProjectedValue'
|
|
||||||
| 'BatterySectionContainer'
|
|
||||||
| 'Blocked'
|
|
||||||
| 'ComingSoon'
|
|
||||||
| 'Container'
|
|
||||||
| 'ContentTransition'
|
|
||||||
| 'Down'
|
|
||||||
| 'EmptyNotifications'
|
|
||||||
| 'Enter'
|
|
||||||
| 'EnterActive'
|
|
||||||
| 'Exit'
|
|
||||||
| 'ExitActive'
|
|
||||||
| 'FooterBoxShadow'
|
|
||||||
| 'FriendsListTabPanel'
|
|
||||||
| 'FriendsTitle'
|
|
||||||
| 'FullHeight'
|
|
||||||
| 'HeaderAndFooterVisible'
|
|
||||||
| 'HeaderContainer'
|
|
||||||
| 'ItemFocusAnim-darkGrey'
|
|
||||||
| 'ItemFocusAnim-darkerGrey'
|
|
||||||
| 'ItemFocusAnim-darkerGrey-nocolor'
|
|
||||||
| 'ItemFocusAnim-green'
|
|
||||||
| 'ItemFocusAnim-grey'
|
|
||||||
| 'ItemFocusAnimBorder-darkGrey'
|
|
||||||
| 'KeyboardButton'
|
|
||||||
| 'Label'
|
|
||||||
| 'LowBattery'
|
|
||||||
| 'LowBatteryGauge'
|
|
||||||
| 'Menu'
|
|
||||||
| 'Open'
|
|
||||||
| 'PanelExitAnchor'
|
|
||||||
| 'PanelOuterNav'
|
|
||||||
| 'PanelSection'
|
|
||||||
| 'PanelSectionRow'
|
|
||||||
| 'PanelSectionTitle'
|
|
||||||
| 'QuickAccessMenu'
|
|
||||||
| 'ReallyLow'
|
|
||||||
| 'Remaining'
|
|
||||||
| 'Selected'
|
|
||||||
| 'Tab'
|
|
||||||
| 'TabContentColumn'
|
|
||||||
| 'TabGroupPanel'
|
|
||||||
| 'TabPanelHidden'
|
|
||||||
| 'Tabs'
|
|
||||||
| 'Text'
|
|
||||||
| 'Title'
|
|
||||||
| 'TransitionMenuDelay'
|
|
||||||
| 'Up'
|
|
||||||
| 'ViewPlaceholder'
|
|
||||||
| 'VoiceTab'
|
|
||||||
| 'duration-app-launch'
|
|
||||||
| 'focusAnimation'
|
|
||||||
| 'hoverAnimation',
|
|
||||||
string
|
|
||||||
>;
|
|
||||||
|
|
||||||
export const staticClasses: StaticClasses = findModuleChild((mod) => {
|
|
||||||
if (typeof mod !== 'object') return false;
|
|
||||||
|
|
||||||
if (mod.TransitionMenuDelay) {
|
|
||||||
return mod;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
1
src/deck-hooks/index.ts
Normal file
1
src/deck-hooks/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export * from './useParams';
|
||||||
15
src/deck-hooks/useParams.ts
Normal file
15
src/deck-hooks/useParams.ts
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { ReactRouter } from '../webpack';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the current params from ReactRouter
|
||||||
|
*
|
||||||
|
* @returns an object with the current ReactRouter params
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* import { useParams } from "decky-frontend-lib";
|
||||||
|
*
|
||||||
|
* const { appid } = useParams<{ appid: string }>()
|
||||||
|
*/
|
||||||
|
export const useParams = Object.values(ReactRouter).find((val) => /return (\w)\?\1\.params:{}/.test(`${val}`)) as <
|
||||||
|
T,
|
||||||
|
>() => T;
|
||||||
6
src/globals/SteamClient.ts
Normal file
6
src/globals/SteamClient.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import {SteamClient} from "./steam-client";
|
||||||
|
export * from "./steam-client/shared";
|
||||||
|
|
||||||
|
declare global {
|
||||||
|
var SteamClient: SteamClient;
|
||||||
|
}
|
||||||
2
src/globals/index.ts
Normal file
2
src/globals/index.ts
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
export * from './SteamClient';
|
||||||
|
export * from './stores';
|
||||||
1749
src/globals/steam-client/App.ts
Normal file
1749
src/globals/steam-client/App.ts
Normal file
File diff suppressed because it is too large
Load Diff
105
src/globals/steam-client/Auth.ts
Normal file
105
src/globals/steam-client/Auth.ts
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
import { EResult, JsPbMessage, OperationResponse } from "./shared";
|
||||||
|
import {EOSType} from "./system";
|
||||||
|
|
||||||
|
export interface Auth {
|
||||||
|
/**
|
||||||
|
* @returns a boolean indicating if the operation succeeded.
|
||||||
|
*/
|
||||||
|
ClearCachedSignInPin(): Promise<boolean>;
|
||||||
|
|
||||||
|
CurrentUserHasCachedSignInPin(): Promise<boolean>;
|
||||||
|
|
||||||
|
GetLocalHostname(): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns a ProtoBuf message. If deserialized, returns {@link CAuthentication_DeviceDetails}.
|
||||||
|
*/
|
||||||
|
GetMachineID(): Promise<ArrayBuffer>;
|
||||||
|
|
||||||
|
GetRefreshInfo(): Promise<AuthRefreshInfo>;
|
||||||
|
|
||||||
|
GetSteamGuardData(param0: string): Promise<SteamGuardData>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* "Secured" refers to unshared.
|
||||||
|
*/
|
||||||
|
IsSecureComputer(): Promise<boolean>;
|
||||||
|
|
||||||
|
SetCachedSignInPin(pin: string): Promise<boolean>;
|
||||||
|
|
||||||
|
SetLoginToken(refreshToken: string, accountName: string): Promise<OperationResponse>;
|
||||||
|
|
||||||
|
SetSteamGuardData(accountName: string, newGuardData: string): void;
|
||||||
|
|
||||||
|
StartSignInFromCache(accountName: string, offlineMode: boolean): Promise<OperationResponse | void>;
|
||||||
|
|
||||||
|
UserHasCachedSignInPin(accountName: string): Promise<boolean>;
|
||||||
|
|
||||||
|
ValidateCachedSignInPin(accountName: string, pin: string): Promise<boolean>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AuthRefreshInfo {
|
||||||
|
reason: number;
|
||||||
|
account_name: string;
|
||||||
|
login_id_token: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SteamGuardData {
|
||||||
|
data: string;
|
||||||
|
eresult: EResult;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `deserializeBinary` argument:
|
||||||
|
* ```
|
||||||
|
* [
|
||||||
|
* await SteamClient.System.GetOSType(),
|
||||||
|
* await SteamClient.Auth.GetLocalHostname(),
|
||||||
|
* await SteamClient.Auth.GetMachineID(),
|
||||||
|
* ];
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
export interface CAuthentication_DeviceDetails extends JsPbMessage {
|
||||||
|
client_count(): number | undefined;
|
||||||
|
|
||||||
|
device_friendly_name(): string | undefined;
|
||||||
|
|
||||||
|
gaming_device_type(): EGamingDeviceType | undefined;
|
||||||
|
|
||||||
|
machine_id(): Uint8Array | string;
|
||||||
|
|
||||||
|
os_type(): EOSType | undefined;
|
||||||
|
|
||||||
|
platform_type(): EAuthTokenPlatformType | undefined;
|
||||||
|
|
||||||
|
set_client_count(): any;
|
||||||
|
|
||||||
|
set_device_friendly_name(): any;
|
||||||
|
|
||||||
|
set_gaming_device_type(): any;
|
||||||
|
|
||||||
|
set_machine_id(): any;
|
||||||
|
|
||||||
|
set_os_type(): any;
|
||||||
|
|
||||||
|
set_platform_type(): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EAuthTokenPlatformType {
|
||||||
|
Unknown,
|
||||||
|
SteamClient,
|
||||||
|
WebBrowser,
|
||||||
|
MobileApp,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EGamingDeviceType {
|
||||||
|
Unknown,
|
||||||
|
StandardPC,
|
||||||
|
Console = 256,
|
||||||
|
PS3 = 272,
|
||||||
|
Steambox = 288,
|
||||||
|
Tesla = 320,
|
||||||
|
Handheld = 512,
|
||||||
|
Phone = 528,
|
||||||
|
SteamDeck = 544,
|
||||||
|
}
|
||||||
56
src/globals/steam-client/Broadcast.ts
Normal file
56
src/globals/steam-client/Broadcast.ts
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
import { EResult, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
export interface Broadcast {
|
||||||
|
/**
|
||||||
|
* Approves a viewer request for the broadcast.
|
||||||
|
* @param steamId64 The SteamID64 of the user whose request is to be approved.
|
||||||
|
*/
|
||||||
|
ApproveViewerRequest(steamId64: string, param1: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Invites a user identified by their SteamID64 to watch the broadcast.
|
||||||
|
* @param steamId64 The SteamID64 of the user to invite.
|
||||||
|
*/
|
||||||
|
InviteToWatch(steamId64: string): Promise<EResult>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback to be called when the broadcast status changes.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForBroadcastStatus(callback: (status: BroadcastStatus) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback to be called when viewer requests are received.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForViewerRequests(
|
||||||
|
callback: (viewerFriendCode: number, param1: number, param2: number) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rejects a viewer request for the broadcast.
|
||||||
|
* @param steamId64 The SteamID64 of the user whose request is to be rejected.
|
||||||
|
*/
|
||||||
|
RejectViewerRequest(steamId64: string, param1: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stops the broadcast.
|
||||||
|
*/
|
||||||
|
StopBroadcasting(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BroadcastStatus {
|
||||||
|
broadcastid: string;
|
||||||
|
nViewers: number;
|
||||||
|
nRequests: number;
|
||||||
|
bIsBroadcasting: boolean;
|
||||||
|
bIsRecordingDesktop: boolean;
|
||||||
|
eBroadcastReady: EResult;
|
||||||
|
bBroadcastCapable: boolean;
|
||||||
|
bMicrophoneEnabled: boolean;
|
||||||
|
bMicrophoneActive: boolean;
|
||||||
|
nCurrentFPS: number;
|
||||||
|
nUploadKbps: number;
|
||||||
|
}
|
||||||
91
src/globals/steam-client/Browser.ts
Normal file
91
src/globals/steam-client/Browser.ts
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
export interface Browser {
|
||||||
|
AddWordToDictionary(word: string): void;
|
||||||
|
|
||||||
|
ClearAllBrowsingData(): void;
|
||||||
|
|
||||||
|
ClearHistory(): void;
|
||||||
|
|
||||||
|
CloseDevTools(): void;
|
||||||
|
|
||||||
|
GetBrowserID(): Promise<number>;
|
||||||
|
|
||||||
|
GetSpellingSuggestions(word: string): string[];
|
||||||
|
|
||||||
|
GetSteamBrowserID(): Promise<number>; // 16-bit unsigned integer?
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hides the mouse cursor until input.
|
||||||
|
*/
|
||||||
|
HideCursorUntilMouseEvent(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* yup that's right, clientY and clientX are reversed
|
||||||
|
*/
|
||||||
|
InspectElement(clientY: number, clientX: number): void;
|
||||||
|
|
||||||
|
NotifyUserActivation(): void;
|
||||||
|
|
||||||
|
OpenDevTools(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pastes the clipboard contents.
|
||||||
|
*/
|
||||||
|
Paste(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @note Not available on a created BrowserView.
|
||||||
|
* @todo unconfirmed
|
||||||
|
*/
|
||||||
|
RegisterForGestureEvents(callback: (gesture: TouchGesture) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @note Not available on a created BrowserView.
|
||||||
|
*/
|
||||||
|
RegisterForOpenNewTab: Unregisterable;
|
||||||
|
|
||||||
|
ReplaceMisspelling(param0: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Restarts the Steam JS context.
|
||||||
|
*/
|
||||||
|
RestartJSContext(): void;
|
||||||
|
|
||||||
|
SetBackgroundThrottlingDisabled(value: boolean): void;
|
||||||
|
|
||||||
|
SetPendingFilePath(path: string): Promise<boolean>;
|
||||||
|
|
||||||
|
SetShouldExitSteamOnBrowserClosed(value: boolean): Promise<void>;
|
||||||
|
|
||||||
|
SetTouchGesturesToCancel(gestures: ETouchGesture[]): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prompts and downloads a file.
|
||||||
|
* @param url The URL of the file to download.
|
||||||
|
*/
|
||||||
|
StartDownload(url: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TouchGesture {
|
||||||
|
eTouchGesture: ETouchGesture;
|
||||||
|
x: number;
|
||||||
|
y: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum ETouchGesture {
|
||||||
|
None,
|
||||||
|
Touch,
|
||||||
|
Tap,
|
||||||
|
DoubleTap,
|
||||||
|
ShortPress,
|
||||||
|
LongPress,
|
||||||
|
LongTap,
|
||||||
|
TwoFingerTap,
|
||||||
|
TapCancelled,
|
||||||
|
PinchBegin,
|
||||||
|
PinchUpdate,
|
||||||
|
PinchEnd,
|
||||||
|
FlingStart,
|
||||||
|
FlingCancelled,
|
||||||
|
}
|
||||||
39
src/globals/steam-client/ClientNotifications.ts
Normal file
39
src/globals/steam-client/ClientNotifications.ts
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
import { BrowserContext } from "./shared";
|
||||||
|
|
||||||
|
export interface ClientNotifications {
|
||||||
|
/**
|
||||||
|
* Displays a Steam notification.
|
||||||
|
* @param notification Notification type.
|
||||||
|
* @param options Stringified object of {@link SteamNotificationOptions}.
|
||||||
|
* @param callback
|
||||||
|
*/
|
||||||
|
DisplayClientNotification(
|
||||||
|
notification: EClientUINotificationType,
|
||||||
|
options: string,
|
||||||
|
callback: (context: BrowserContext) => void,
|
||||||
|
): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param notificationId The ID of the notification to handle.
|
||||||
|
* @param handleAction `true` to execute the callback function associated with the notification.
|
||||||
|
*/
|
||||||
|
OnRespondToClientNotification(notificationId: number, handleAction: boolean): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SteamNotificationOptions {
|
||||||
|
body: string;
|
||||||
|
chatroomgroupid?: number;
|
||||||
|
chatroomid?: number;
|
||||||
|
icon?: string;
|
||||||
|
state: string;
|
||||||
|
/** A Steam64 ID. */
|
||||||
|
steamid: string;
|
||||||
|
tag?: string;
|
||||||
|
title?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EClientUINotificationType {
|
||||||
|
GroupChatMessage = 1,
|
||||||
|
FriendChatMessage,
|
||||||
|
FriendPersonaState,
|
||||||
|
}
|
||||||
14
src/globals/steam-client/Cloud.ts
Normal file
14
src/globals/steam-client/Cloud.ts
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
export interface Cloud {
|
||||||
|
/**
|
||||||
|
* Resolves a synchronization conflict for an app in the cloud.
|
||||||
|
* @param appId The ID of the app with the sync conflict.
|
||||||
|
* @param keepLocal Whether to keep the local version during conflict resolution.
|
||||||
|
*/
|
||||||
|
ResolveAppSyncConflict(appId: number, keepLocal: boolean): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retries syncing an app with the cloud.
|
||||||
|
* @param appId The ID of the app to retry syncing.
|
||||||
|
*/
|
||||||
|
RetryAppSync(appId: number): void;
|
||||||
|
}
|
||||||
24
src/globals/steam-client/CommunityItems.ts
Normal file
24
src/globals/steam-client/CommunityItems.ts
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
export interface CommunityItems {
|
||||||
|
/*
|
||||||
|
DownloadMovie(e) {
|
||||||
|
return (0, o.mG)(this, void 0, void 0, (function* () {
|
||||||
|
if (0 != e.movie_webm_local_path.length) return !0;
|
||||||
|
let t = yield SteamClient.CommunityItems.DownloadItemAsset(e.communityitemid, w, e.movie_webm),
|
||||||
|
n = 1 == t.result;
|
||||||
|
if (n) {
|
||||||
|
e.movie_webm_local_path = t.path;
|
||||||
|
let n = [];
|
||||||
|
this.m_startupMovies.forEach((t => {
|
||||||
|
t.movie_webm == e.movie_webm ? n.push(e) : n.push(t)
|
||||||
|
})), this.m_startupMovies = n
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
DownloadItemAsset(communityItemId: string, param1: any, param2: string): any;
|
||||||
|
|
||||||
|
GetItemAssetPath(communityItemId: string, param1: any, param2: string): any;
|
||||||
|
|
||||||
|
RemoveDownloadedItemAsset(communityItemId: string, param1: any, param2: string): any;
|
||||||
|
}
|
||||||
43
src/globals/steam-client/Console.ts
Normal file
43
src/globals/steam-client/Console.ts
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents the console functionality for executing commands and handling spew output.
|
||||||
|
*/
|
||||||
|
export interface Console {
|
||||||
|
/**
|
||||||
|
* Executes a console command.
|
||||||
|
* @param command The command to execute in the console.
|
||||||
|
*/
|
||||||
|
ExecCommand(command: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves autocomplete suggestions for a given console command.
|
||||||
|
* @param command The console command to provide autocomplete suggestions for.
|
||||||
|
* @returns an array of autocomplete suggestions.
|
||||||
|
*/
|
||||||
|
GetAutocompleteSuggestions(command: string): Promise<string[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to receive spew output.
|
||||||
|
* @param callback The callback function that will receive spew output.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForSpewOutput(callback: (output: SpewOutput) => void): Unregisterable;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SpewType_t = "assert" | "error" | "warning" | "info" | "input";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents spew output information.
|
||||||
|
*/
|
||||||
|
export interface SpewOutput {
|
||||||
|
/**
|
||||||
|
* The content of the spew output.
|
||||||
|
*/
|
||||||
|
spew: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type or category of the spew output.
|
||||||
|
*/
|
||||||
|
spew_type: SpewType_t;
|
||||||
|
}
|
||||||
12
src/globals/steam-client/Customization.ts
Normal file
12
src/globals/steam-client/Customization.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
export interface Customization {
|
||||||
|
GenerateLocalStartupMoviesThumbnails(param0: number): Promise<number>;
|
||||||
|
|
||||||
|
//param0: "startupmovies"
|
||||||
|
GetDownloadedStartupMovies(param0: string): Promise<StartupMovie[]>;
|
||||||
|
|
||||||
|
GetLocalStartupMovies(): Promise<StartupMovie[]>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StartupMovie {
|
||||||
|
strMovieURL: string;
|
||||||
|
}
|
||||||
175
src/globals/steam-client/Downloads.ts
Normal file
175
src/globals/steam-client/Downloads.ts
Normal file
@@ -0,0 +1,175 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
import {EAppUpdateError} from "./App";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents functions related to managing downloads in Steam.
|
||||||
|
*/
|
||||||
|
export interface Downloads {
|
||||||
|
/**
|
||||||
|
* Enables or disables all downloads in Steam.
|
||||||
|
* @param enable True to enable downloads, false to disable.
|
||||||
|
*/
|
||||||
|
EnableAllDownloads(enable: boolean): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Moves the update for a specific app down the download queue.
|
||||||
|
* @param appId The ID of the application to move.
|
||||||
|
*/
|
||||||
|
MoveAppUpdateDown(appId: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Moves the update for a specific app up the download queue.
|
||||||
|
* @param appId The ID of the application to move.
|
||||||
|
*/
|
||||||
|
MoveAppUpdateUp(appId: number): void;
|
||||||
|
|
||||||
|
PauseAppUpdate(appId: number): void; // Broken? It seems to be removing it from download list like RemoveFromDownloadList
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds the update for a specific app to the download queue.
|
||||||
|
* @param appId The ID of the application to queue.
|
||||||
|
*/
|
||||||
|
QueueAppUpdate(appId: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when download items change.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForDownloadItems(
|
||||||
|
callback: (isDownloading: boolean, downloadItems: DownloadItem[]) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when download overview changes.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForDownloadOverview(callback: (overview: DownloadOverview) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes the update for a specific app from the download list and places it in the unscheduled list.
|
||||||
|
* @param appId The ID of the application to remove.
|
||||||
|
*/
|
||||||
|
RemoveFromDownloadList(appId: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resumes the update for a specific app in the queue.
|
||||||
|
* @param appId The ID of the application to resume.
|
||||||
|
*/
|
||||||
|
ResumeAppUpdate(appId: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets an app to launch when its download is complete.
|
||||||
|
* @param appId The ID of the application to set.
|
||||||
|
*/
|
||||||
|
SetLaunchOnUpdateComplete(appId: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the queue index for an app in the download queue.
|
||||||
|
* @param appId The ID of the application to set the index for.
|
||||||
|
* @param index The index to set.
|
||||||
|
* @remarks Index of 0 is the current download in progress.
|
||||||
|
*/
|
||||||
|
SetQueueIndex(appId: number, index: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Suspends or resumes download throttling.
|
||||||
|
* @param suspend Whether to suspend or resume download throttling.
|
||||||
|
*/
|
||||||
|
SuspendDownloadThrottling(suspend: boolean): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Suspends or resumes local transfers.
|
||||||
|
* @param suspend Whether to suspend or resume local transfers.
|
||||||
|
*/
|
||||||
|
SuspendLanPeerContent(suspend: boolean): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DownloadItem {
|
||||||
|
/** True if this app is currently downloading */
|
||||||
|
active: boolean;
|
||||||
|
/** Appid of app */
|
||||||
|
appid: number;
|
||||||
|
/** Current build ID for the installed app, zero if the app isn't installed yet */
|
||||||
|
buildid: number;
|
||||||
|
/** True if this update has been completed */
|
||||||
|
completed: boolean;
|
||||||
|
/** For completed downloads, time of completion, 0 if not completed */
|
||||||
|
completed_time: number;
|
||||||
|
deferred_time: number;
|
||||||
|
/** Bytes already downloaded, sum across all content types */
|
||||||
|
downloaded_bytes: number;
|
||||||
|
/** If true, game will launch when its download completes successfully */
|
||||||
|
launch_on_completion: boolean;
|
||||||
|
/** True if this app has been paused by the user or the system */
|
||||||
|
paused: boolean;
|
||||||
|
/** Queue index, -1 if the item is unqueued */
|
||||||
|
queue_index: number;
|
||||||
|
/** Build ID that this download is moving towards. This can be the same as buildid.*/
|
||||||
|
target_buildid: number;
|
||||||
|
/** Total bytes to download, sum across all content types */
|
||||||
|
total_bytes: number;
|
||||||
|
/**
|
||||||
|
* Update error description, when paused and there has been an error.
|
||||||
|
* Unlocalized and shouldn't be displayed to the user.
|
||||||
|
*/
|
||||||
|
update_error: string;
|
||||||
|
update_result: EAppUpdateError;
|
||||||
|
update_type_info: UpdateTypeInfo[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DownloadOverview {
|
||||||
|
/** Set if we are downloading from LAN peer content server */
|
||||||
|
lan_peer_hostname: string;
|
||||||
|
/** True if all downloads are paused */
|
||||||
|
paused: boolean;
|
||||||
|
/** True if download throttling has been temporarily suspended for the current download */
|
||||||
|
throttling_suspended: boolean;
|
||||||
|
/** Appid of currently updating app */
|
||||||
|
update_appid: number;
|
||||||
|
/** Bytes already downloaded */
|
||||||
|
update_bytes_downloaded: number;
|
||||||
|
/** Bytes already processed in current phase - resets to zero when update stage changes */
|
||||||
|
update_bytes_processed: number;
|
||||||
|
/** Bytes already staged */
|
||||||
|
update_bytes_staged: number;
|
||||||
|
/** Total bytes to download */
|
||||||
|
update_bytes_to_download: number;
|
||||||
|
/** Total bytes to process in current phase - resets to zero when update stage changes */
|
||||||
|
update_bytes_to_process: number;
|
||||||
|
/** Total bytes to be staged */
|
||||||
|
update_bytes_to_stage: number;
|
||||||
|
/** Current disk throughput estimate */
|
||||||
|
update_disc_bytes_per_second: number;
|
||||||
|
/** True if the current update is an initial install */
|
||||||
|
update_is_install: boolean;
|
||||||
|
/** True if download and staging sizes are prefetch estimates */
|
||||||
|
update_is_prefetch_estimate: boolean;
|
||||||
|
/** True if the current update is for shader update */
|
||||||
|
update_is_shader: boolean;
|
||||||
|
/** True if the client is running in peer content server mode serving other peers */
|
||||||
|
update_is_upload: boolean;
|
||||||
|
/** True if the current update is for workshop content */
|
||||||
|
update_is_workshop: boolean;
|
||||||
|
/** Current bandwidth estimate for download */
|
||||||
|
update_network_bytes_per_second: number;
|
||||||
|
/** Peak bandwidth estimate for download */
|
||||||
|
update_peak_network_bytes_per_second: number;
|
||||||
|
/** Estimate of remaining time (in seconds) until download completes (not including staging) */
|
||||||
|
update_seconds_remaining: number;
|
||||||
|
/** Time current update started */
|
||||||
|
update_start_time: number;
|
||||||
|
update_state: 'None' | 'Starting' | 'Updating' | 'Stopping';
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface UpdateTypeInfo {
|
||||||
|
/** True if this content type had an update and it has completed */
|
||||||
|
completed_update: boolean;
|
||||||
|
/** Bytes already downloaded for this content type */
|
||||||
|
downloaded_bytes: number;
|
||||||
|
/** True if this content type has or had an update */
|
||||||
|
has_update: boolean;
|
||||||
|
/** Total bytes to download for this content type */
|
||||||
|
total_bytes: number;
|
||||||
|
}
|
||||||
30
src/globals/steam-client/FamilySharing.ts
Normal file
30
src/globals/steam-client/FamilySharing.ts
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
import { EResult, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents functions related to Steam Family Sharing.
|
||||||
|
*/
|
||||||
|
export interface FamilySharing {
|
||||||
|
GetAvailableLenders(appId: number): Promise<Lender[]>;
|
||||||
|
|
||||||
|
RegisterForKickedBorrower: Unregisterable;
|
||||||
|
|
||||||
|
SetPreferredLender(appId: number, param1: number): Promise<EResult>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface LenderDLC {
|
||||||
|
rtStoreAssetModifyTime: number;
|
||||||
|
strHeaderFilename: string;
|
||||||
|
strName: string;
|
||||||
|
unAppID: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Lender {
|
||||||
|
/**
|
||||||
|
* A Steam64 ID.
|
||||||
|
*/
|
||||||
|
steamid: string;
|
||||||
|
appid: number;
|
||||||
|
numDlc: number;
|
||||||
|
bPreferred: boolean;
|
||||||
|
vecDLC: LenderDLC[];
|
||||||
|
}
|
||||||
80
src/globals/steam-client/FriendSettings.ts
Normal file
80
src/globals/steam-client/FriendSettings.ts
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
import { VDFBoolean_t } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents friend settings and configuration.
|
||||||
|
*/
|
||||||
|
export interface FriendSettings {
|
||||||
|
/**
|
||||||
|
* Retrieves a list of enabled friend settings features.
|
||||||
|
* @returns an array of enabled friend settings features.
|
||||||
|
*/
|
||||||
|
GetEnabledFeatures(): Promise<FriendSettingsFeatureObject[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be notified of friend settings changes.
|
||||||
|
* @param callback The callback function to be called when friend settings change.
|
||||||
|
* @remarks The callback receives a JSON object string which may be parsed into {@link FriendSettingsChange}.
|
||||||
|
*/
|
||||||
|
RegisterForSettingsChanges(callback: (settings: string) => void): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param details Stringified {@link FriendSettingsChange}.
|
||||||
|
*/
|
||||||
|
SetFriendSettings(details: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EChatFlashMode {
|
||||||
|
Always,
|
||||||
|
Minimized,
|
||||||
|
Never,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FriendSettingsFeatureObject {
|
||||||
|
feature: FriendSettingsFeature_t;
|
||||||
|
bEnabled: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type FriendSettingsFeature_t =
|
||||||
|
| "DoNotDisturb"
|
||||||
|
| "FriendsFilter"
|
||||||
|
| "LoaderWindowSynchronization"
|
||||||
|
| "NewVoiceHotKeyState"
|
||||||
|
| "NonFriendMessageHandling"
|
||||||
|
| "PersonaNotifications"
|
||||||
|
| "ServerVirtualizedMemberLists"
|
||||||
|
| "SteamworksChatAPI";
|
||||||
|
|
||||||
|
export type FriendSettingsEnabledFeatures<T> = {
|
||||||
|
[feature in FriendSettingsFeature_t]: T;
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface FriendSettingsChange {
|
||||||
|
bNotifications_ShowIngame: VDFBoolean_t;
|
||||||
|
bNotifications_ShowOnline: VDFBoolean_t;
|
||||||
|
bNotifications_ShowMessage: VDFBoolean_t;
|
||||||
|
bNotifications_EventsAndAnnouncements: VDFBoolean_t;
|
||||||
|
bSounds_PlayIngame: VDFBoolean_t;
|
||||||
|
bSounds_PlayOnline: VDFBoolean_t;
|
||||||
|
bSounds_PlayMessage: VDFBoolean_t;
|
||||||
|
bSounds_EventsAndAnnouncements: VDFBoolean_t;
|
||||||
|
bAlwaysNewChatWindow: VDFBoolean_t;
|
||||||
|
bForceAlphabeticFriendSorting: VDFBoolean_t;
|
||||||
|
nChatFlashMode: EChatFlashMode;
|
||||||
|
bRememberOpenChats: VDFBoolean_t;
|
||||||
|
bCompactQuickAccess: VDFBoolean_t;
|
||||||
|
bCompactFriendsList: VDFBoolean_t;
|
||||||
|
bNotifications_ShowChatRoomNotification: VDFBoolean_t;
|
||||||
|
bSounds_PlayChatRoomNotification: VDFBoolean_t;
|
||||||
|
bHideOfflineFriendsInTagGroups: VDFBoolean_t;
|
||||||
|
bHideCategorizedFriends: VDFBoolean_t;
|
||||||
|
bCategorizeInGameFriendsByGame: VDFBoolean_t;
|
||||||
|
nChatFontSize: number;
|
||||||
|
b24HourClock: VDFBoolean_t;
|
||||||
|
bDoNotDisturbMode: VDFBoolean_t;
|
||||||
|
bDisableEmbedInlining: VDFBoolean_t;
|
||||||
|
bSignIntoFriends: VDFBoolean_t;
|
||||||
|
bDisableSpellcheck: VDFBoolean_t;
|
||||||
|
bDisableRoomEffects: VDFBoolean_t;
|
||||||
|
bAnimatedAvatars: VDFBoolean_t;
|
||||||
|
featuresEnabled: FriendSettingsEnabledFeatures<VDFBoolean_t>;
|
||||||
|
}
|
||||||
70
src/globals/steam-client/Friends.ts
Normal file
70
src/globals/steam-client/Friends.ts
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents functions related to managing friends in Steam.
|
||||||
|
*/
|
||||||
|
export interface Friends {
|
||||||
|
/**
|
||||||
|
* Adds a user to the friend list.
|
||||||
|
* @param steamId The Steam ID of the user to add as a friend.
|
||||||
|
* @returns `true` if the friend was added successfully.
|
||||||
|
*/
|
||||||
|
AddFriend(steamId: string): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns a list of players you recently played with.
|
||||||
|
*/
|
||||||
|
GetCoplayData(): Promise<CoplayData>;
|
||||||
|
|
||||||
|
InviteUserToCurrentGame(steam64Id: string, steamIdTarget: string): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Invites a user to a specific game.
|
||||||
|
* @param steamId The Steam ID of the user to invite.
|
||||||
|
* @param appId The ID of the game to invite the user to.
|
||||||
|
* @param connectString Additional parameters for the invitation.
|
||||||
|
* @returns `true` if the user was invited successfully.
|
||||||
|
*/
|
||||||
|
InviteUserToGame(steamId: string, appId: number, connectString: string): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Invites a user to a specific lobby.
|
||||||
|
* @returns `true` if the user was invited successfully.
|
||||||
|
*/
|
||||||
|
InviteUserToLobby(steam64Id: string, steamIdTarget: string): Promise<boolean>;
|
||||||
|
|
||||||
|
InviteUserToRemotePlayTogetherCurrentGame(steam64Id: string): Promise<boolean>;
|
||||||
|
|
||||||
|
RegisterForMultiplayerSessionShareURLChanged(
|
||||||
|
appId: number,
|
||||||
|
callback: (param0: string, param1: string) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForVoiceChatStatus(callback: (status: VoiceChatStatus) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes a user from the friend list.
|
||||||
|
* @param steamId The Steam ID of the user to remove from the friend list.
|
||||||
|
* @returns `true` if the friend was removed successfully.
|
||||||
|
*/
|
||||||
|
RemoveFriend(steamId: string): Promise<boolean>;
|
||||||
|
|
||||||
|
ShowRemotePlayTogetherUI(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CoplayData {
|
||||||
|
currentUsers: CoplayUser[];
|
||||||
|
recentUsers: CoplayUser[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CoplayUser {
|
||||||
|
accountid: number;
|
||||||
|
rtTimePlayed: number;
|
||||||
|
appid: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface VoiceChatStatus {
|
||||||
|
bVoiceChatActive: boolean;
|
||||||
|
bMicMuted: boolean;
|
||||||
|
bOutputMuted: boolean;
|
||||||
|
}
|
||||||
73
src/globals/steam-client/GameNotes.ts
Normal file
73
src/globals/steam-client/GameNotes.ts
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
import { EResult, OperationResponse } from "./shared";
|
||||||
|
|
||||||
|
export interface GameNotes {
|
||||||
|
/**
|
||||||
|
* @returns a boolean indicating whether the operation was successful.
|
||||||
|
*/
|
||||||
|
DeleteImage(param0: string): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns a boolean indicating whether the operation was successful.
|
||||||
|
*/
|
||||||
|
DeleteNotes(param0: string): Promise<boolean>;
|
||||||
|
|
||||||
|
GetNotes(filenameForNotes: string, directoryForNoteImages: string): Promise<Notes>;
|
||||||
|
|
||||||
|
GetNotesMetadata(note: string): Promise<NoteMetadata>;
|
||||||
|
GetNumNotes(): Promise<number>;
|
||||||
|
GetQuota: Promise<NotesQuota>;
|
||||||
|
|
||||||
|
IterateNotes(appId: number, length: number): Promise<NoteMetadata[]>;
|
||||||
|
ResolveSyncConflicts(param0: boolean): Promise<EResult>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param notes Escaped JSON array of {@link Note}.
|
||||||
|
*/
|
||||||
|
SaveNotes(filenameForNotes: string, notes: string): Promise<EResult>;
|
||||||
|
SyncToClient(): Promise<EResult>;
|
||||||
|
|
||||||
|
SyncToServer(): Promise<EResult>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param mimeType Image MIME type.
|
||||||
|
* @param base64 Image contents in base64.
|
||||||
|
* @returns an image file name with its extension that's meant to be used as a part of some URL. (todo)
|
||||||
|
* @throws OperationResponse if invalid MIME type or unable to parse base64 BUT NOT if it failed.
|
||||||
|
*/
|
||||||
|
UploadImage(imageFileNamePrefix: string, mimeType: string, base64: string): Promise<EResult | OperationResponse>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Note {
|
||||||
|
appid: number;
|
||||||
|
id: string;
|
||||||
|
/**
|
||||||
|
* Note contents in BB code.
|
||||||
|
*/
|
||||||
|
content: string;
|
||||||
|
ordinal: number;
|
||||||
|
time_created: number;
|
||||||
|
time_modified: number;
|
||||||
|
title: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Notes {
|
||||||
|
result: EResult;
|
||||||
|
/**
|
||||||
|
* Escaped JSON array of {@link Note}. Not present if {@link result} is {@link EResult.FileNotFound}.
|
||||||
|
*/
|
||||||
|
notes?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface NoteMetadata {
|
||||||
|
filename: string;
|
||||||
|
filesize: number;
|
||||||
|
result: EResult;
|
||||||
|
timestamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface NotesQuota {
|
||||||
|
bytes: number;
|
||||||
|
bytesAvailable: number;
|
||||||
|
numFiles: number;
|
||||||
|
numFilesAvailable: number;
|
||||||
|
}
|
||||||
29
src/globals/steam-client/GameRecording.ts
Normal file
29
src/globals/steam-client/GameRecording.ts
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
import type { JsPbMessage, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
export interface GameRecording {
|
||||||
|
/**
|
||||||
|
* If `data` is deserialized, returns {@link CGameRecording_AudioSessionsChanged_Notification}.
|
||||||
|
*/
|
||||||
|
RegisterForAudioSessionsChanged(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||||
|
SetAudioSessionCaptureState(id: string, name: string, state: boolean): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AudioSession {
|
||||||
|
id(): string | undefined;
|
||||||
|
name(): string | undefined;
|
||||||
|
is_system(): boolean | undefined;
|
||||||
|
is_muted(): boolean | undefined;
|
||||||
|
is_active(): boolean | undefined;
|
||||||
|
is_captured(): boolean | undefined;
|
||||||
|
recent_peak(): number | undefined;
|
||||||
|
is_game(): boolean | undefined;
|
||||||
|
is_steam(): boolean | undefined;
|
||||||
|
is_saved(): boolean | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @note Taken from https://github.com/SteamDatabase/SteamTracking/blob/master/Protobufs/steammessages_gamerecording_objects.proto
|
||||||
|
*/
|
||||||
|
export interface CGameRecording_AudioSessionsChanged_Notification extends JsPbMessage {
|
||||||
|
sessions(): AudioSession[];
|
||||||
|
}
|
||||||
59
src/globals/steam-client/GameSessions.ts
Normal file
59
src/globals/steam-client/GameSessions.ts
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
import {AppAchievements} from "./App";
|
||||||
|
import { Screenshot } from "./Screenshots";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents functions related to Steam Game Sessions.
|
||||||
|
*/
|
||||||
|
export interface GameSessions {
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when an achievement notification is received.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForAchievementNotification(
|
||||||
|
callback: (notification: AchievementNotification) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when an app lifetime notification is received.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForAppLifetimeNotifications(
|
||||||
|
callback: (notification: AppLifetimeNotification) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when a screenshot notification is received.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForScreenshotNotification(
|
||||||
|
callback: (notification: ScreenshotNotification) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @prop unAppID is not properly set by Steam for non-steam game shortcuts, so it defaults to 0 for them
|
||||||
|
*/
|
||||||
|
interface GameSessionNotificationBase {
|
||||||
|
unAppID: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AchievementNotification extends GameSessionNotificationBase {
|
||||||
|
achievement: AppAchievements;
|
||||||
|
nCurrentProgress: number;
|
||||||
|
nMaxProgress: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AppLifetimeNotification extends GameSessionNotificationBase {
|
||||||
|
nInstanceID: number;
|
||||||
|
bRunning: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ScreenshotNotification extends GameSessionNotificationBase {
|
||||||
|
details: Screenshot;
|
||||||
|
hScreenshot: number;
|
||||||
|
strOperation: "deleted" | "written";
|
||||||
|
}
|
||||||
810
src/globals/steam-client/Input.ts
Normal file
810
src/globals/steam-client/Input.ts
Normal file
@@ -0,0 +1,810 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents functions related to input and controllers in Steam.
|
||||||
|
*/
|
||||||
|
export interface Input {
|
||||||
|
CalibrateControllerIMU(controllerIndex: any): any;
|
||||||
|
|
||||||
|
CalibrateControllerJoystick(controllerIndex: any): any;
|
||||||
|
|
||||||
|
CalibrateControllerTrackpads(controllerIndex: any): any;
|
||||||
|
|
||||||
|
CancelGyroSWCalibration(): any;
|
||||||
|
|
||||||
|
ClearSelectedConfigForApp(appId: number, controllerIndex: number): any;
|
||||||
|
|
||||||
|
CloseDesktopConfigurator: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Writes text.
|
||||||
|
* @param textToWrite The text to write.
|
||||||
|
*/
|
||||||
|
ControllerKeyboardSendText(textToWrite: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets a specified key's pressed state.
|
||||||
|
* @param key The key index to set the state for.
|
||||||
|
* @param state `true` for pressed, `false` otherwise.
|
||||||
|
* @example
|
||||||
|
* Send paste command:
|
||||||
|
* ```
|
||||||
|
* SteamClient.Input.ControllerKeyboardSetKeyState(EHIDKeyboardKey.LControl, true);
|
||||||
|
* SteamClient.Input.ControllerKeyboardSetKeyState(EHIDKeyboardKey.V, true);
|
||||||
|
* SteamClient.Input.ControllerKeyboardSetKeyState(EHIDKeyboardKey.V, false);
|
||||||
|
* SteamClient.Input.ControllerKeyboardSetKeyState(EHIDKeyboardKey.LControl, false);
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
ControllerKeyboardSetKeyState(key: EHIDKeyboardKey, state: boolean): void;
|
||||||
|
|
||||||
|
DecrementCloudedControllerConfigsCounter(): any;
|
||||||
|
|
||||||
|
DeletePersonalControllerConfiguration(param0: any): any;
|
||||||
|
|
||||||
|
//f.Debug("sending to client"), this.SetEditingConfigurationValue(e, t, c.QU, (e => SteamClient.Input.DuplicateControllerConfigurationSourceMode(this.m_unControllerIndex, e))), this.SaveEditingConfiguration(e), this
|
||||||
|
DuplicateControllerConfigurationSourceMode(controllerIndex: number, param1: any): any;
|
||||||
|
|
||||||
|
EndControllerDeviceSupportFlow(): any;
|
||||||
|
|
||||||
|
ExportCurrentControllerConfiguration(controllerIndex: number, appId: number, param2: number, title: string, description: string, param5: string): Promise<any>;
|
||||||
|
|
||||||
|
ForceConfiguratorFocus(param0: boolean): any;
|
||||||
|
|
||||||
|
ForceSimpleHapticEvent(param0: number, param1: number, param2: number, param3: number, param4: number): any;
|
||||||
|
|
||||||
|
FreeControllerConfig(m_ChordSummaryConfiguration: any): any;
|
||||||
|
|
||||||
|
GetConfigForAppAndController(appId: number, unControllerIndex: number): any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the controller mapping string for the specified controller index.
|
||||||
|
* @param unControllerIndex The controller index.
|
||||||
|
* @returns the controller mapping string.
|
||||||
|
*/
|
||||||
|
GetControllerMappingString(unControllerIndex: number): Promise<string>;
|
||||||
|
|
||||||
|
GetControllerPreviouslySeen(): Promise<number[]>;
|
||||||
|
|
||||||
|
GetSteamControllerDongleState(): Promise<boolean>;
|
||||||
|
|
||||||
|
GetTouchMenuIconsForApp(appId: number): Promise<any>;
|
||||||
|
|
||||||
|
GetXboxDriverInstallState(): Promise<any>; // "{"nResult":0}"
|
||||||
|
IdentifyController(controllerIndex: number): any;
|
||||||
|
|
||||||
|
InitControllerSounds(): any;
|
||||||
|
|
||||||
|
InitializeControllerPersonalizationSettings(controllerIndex: number): any;
|
||||||
|
|
||||||
|
ModalKeyboardDismissed(): void;
|
||||||
|
|
||||||
|
OpenDesktopConfigurator: any;
|
||||||
|
|
||||||
|
PreviewConfigForAppAndController(appId: number, controllerIndex: number, workshopUri: string): any;
|
||||||
|
|
||||||
|
PreviewControllerLEDColor(flHue: number, flSaturation: number, flBrightness: number): any;
|
||||||
|
|
||||||
|
QueryControllerConfigsForApp(appId: number, controllerIndex: number, param2: boolean): any;
|
||||||
|
|
||||||
|
RegisterForActiveControllerChanges: Unregisterable; // {"nActiveController":0}
|
||||||
|
//param0 - e possibly appid?
|
||||||
|
//param1 - some index?
|
||||||
|
RegisterForConfigSelectionChanges(callback: (param0: number, param1: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForControllerAccountChanges: Unregisterable;
|
||||||
|
|
||||||
|
RegisterForControllerAnalogInputMessages(
|
||||||
|
callback: (msgs: ControllerAnalogInputMessage[]) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForControllerBatteryChanges(callback: any): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForControllerCommandMessages(
|
||||||
|
callback: (msg: ControllerCommandMessage) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback for changes in controller configuration cloud state.
|
||||||
|
* @param callback The callback function for config cloud state changes.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForControllerConfigCloudStateChanges(
|
||||||
|
callback: (state: ControllerConfigCloudState) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback for receiving controller configuration info messages (controller layouts query, personal controller layout query).
|
||||||
|
* @param callback The callback function for controller config info messages.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
* @remarks Do Not Use, this will break the controller layout selection unless you know what you are doing.
|
||||||
|
*/
|
||||||
|
RegisterForControllerConfigInfoMessages(
|
||||||
|
callback: (
|
||||||
|
msgs: ControllerConfigInfoMessageList[] | ControllerConfigInfoMessageQuery[],
|
||||||
|
) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be invoked when controller input messages are received.
|
||||||
|
* @param callback The callback function to be invoked when controller input messages are received.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForControllerInputMessages(
|
||||||
|
callback: (controllerIndex: number, gamepadButton: ControllerInputGamepadButton, isButtonPressed: boolean) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForControllerListChanges(callback: (controllerListChanges: ControllerInfo[]) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback for changes in the controller state (buttons presses, triggers presses, joystick changes etc...).
|
||||||
|
* @param callback The callback function for controller state changes.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForControllerStateChanges(
|
||||||
|
callback: (changes: ControllerStateChange[]) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForDualSenseUpdateNotification(callback: (m_strDualSenseUpdateProduct: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback for receiving game keyboard messages (text field popup for inputting text for games when in character creation or etc...).
|
||||||
|
* @param callback The callback function for game keyboard messages.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForGameKeyboardMessages(callback: (msg: GameKeyboardMessage) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForRemotePlayConfigChanges(callback: () => void): Unregisterable;
|
||||||
|
|
||||||
|
//data.appId, data.ulConfigId
|
||||||
|
RegisterForShowControllerLayoutPreviewMessages(callback: (data: any) => void): Unregisterable;
|
||||||
|
|
||||||
|
/*
|
||||||
|
onTouchMenuInput(e) {
|
||||||
|
for (let t = 0; t < e.length; t++) {
|
||||||
|
const n = this.TouchMenuGetKey(e[t]), o = this.m_mapActiveTouchMenus.get(n);
|
||||||
|
void 0 !== o && o.updateTouchMenuState(e[t])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
RegisterForTouchMenuInputMessages(callback: (inputs: number[]) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForTouchMenuMessages(callback: (msg: TouchMenuMessage) => void): Unregisterable;
|
||||||
|
|
||||||
|
//param0 - index?
|
||||||
|
RegisterForUIVisualization(param0: any, param1: any, param2: any): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForUnboundControllerListChanges(callback: (m_unboundControllerList: any) => void): Unregisterable; // param0 is an array
|
||||||
|
|
||||||
|
/*
|
||||||
|
OnDismissKeyboardMessage(e) {
|
||||||
|
this.m_WindowStore.SteamUIWindows.forEach((e => e.VirtualKeyboardManager.SetVirtualKeyboardHidden(e.BrowserWindow)))
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
RegisterForUserDismissKeyboardMessages(callback: (param0: any) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForUserKeyboardMessages: Unregisterable;
|
||||||
|
|
||||||
|
RequestGyroActive(controllerIndex: number, param1: boolean): any;
|
||||||
|
|
||||||
|
RequestRemotePlayControllerConfigs(param0: any): any;
|
||||||
|
|
||||||
|
ResetControllerBindings(param0: any): any;
|
||||||
|
|
||||||
|
ResolveCloudedControllerConfigConflict(param0: any): any;
|
||||||
|
|
||||||
|
RestoreControllerPersonalizationSettings(controllerIndex: number): any;
|
||||||
|
|
||||||
|
SaveControllerCalibration(controllerIndex: number): any;
|
||||||
|
|
||||||
|
SaveControllerPersonalizationSettings(param0: any): any;
|
||||||
|
|
||||||
|
SaveControllerSounds: any;
|
||||||
|
|
||||||
|
SaveEditingControllerConfiguration(controllerIndex: number, sharedConfig: boolean): any;
|
||||||
|
|
||||||
|
//this.SetEditingConfigurationValue(e, t, c.sL, (e => SteamClient.Input.SetControllerConfigurationModeShiftBinding(this.m_unControllerIndex, e)))
|
||||||
|
SetControllerConfigurationModeShiftBinding(controllerIndex: number, param1: any): any;
|
||||||
|
|
||||||
|
SetControllerHapticSetting(controllerIndex: number, eHapticSetting: any): any;
|
||||||
|
|
||||||
|
SetControllerMappingString(mapping: string): void;
|
||||||
|
|
||||||
|
SetControllerName(controllerIndex: number, controllerName: string): any;
|
||||||
|
|
||||||
|
SetControllerNintendoLayoutSetting: any;
|
||||||
|
SetControllerPersonalizationName: any;
|
||||||
|
|
||||||
|
//param0 - nLStickDeadzone, bSWAntiDrift, nRHapticStrength, flRPadPressureCurve
|
||||||
|
/*
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("nLStickDeadzone", e.nLStickDeadzone),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("nRStickDeadzone", e.nRStickDeadzone),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("bSWAntiDrift", e.bSWAntiDrift ? 1 : 0),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("nLHapticStrength", e.nLHapticStrength),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("nRHapticStrength", e.nRHapticStrength),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("flLPadPressureCurve", 100 * e.flLPadPressureCurve),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("flRPadPressureCurve", 100 * e.flRPadPressureCurve),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("ePlayerSlotLEDSetting", e),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nGyroSampleAngleOffsetX", e.nGyroSampleAngleOffsetX),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.bMomentumEnabled", e.bMomentumEnabled ? 1 : 0),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nMomentumFrictionX", e.nMomentumFrictionX),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nMomentumFrictionY", e.nMomentumFrictionY),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nAccerationLevel", e.nAccerationLevel),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.bInvertX", e.bInvertX ? 1 : 0),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.bInvertY", e.bInvertY ? 1 : 0),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nRotationAngle", e.nRotationAngle),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nTriggerClamping", e.nTriggerClamping),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nTriggerClampingAmount", e.nTriggerClampingAmount),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nGyroEnableButton", e.nGyroEnableButton),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nGyroEnableButtonBehavior", e.nGyroEnableButtonBehavior),
|
||||||
|
*/
|
||||||
|
SetControllerPersonalizationSetting(param0: string, param1: number): any;
|
||||||
|
|
||||||
|
//param0 - flGyroStationaryTolerance, flAccelerometerStationaryTolerance,
|
||||||
|
/*
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSettingFloat("GyroPreferenceData.flGyroNaturalSensitivity", e.flGyroNaturalSensitivity),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSettingFloat("GyroPreferenceData.flGyroXYRatio", e.flGyroXYRatio),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSettingFloat("GyroPreferenceData.flGyroSpeedDeadzone", e.flGyroSpeedDeadzone),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSettingFloat("GyroPreferenceData.flGyroPrecisionSpeed", e.flGyroPrecisionSpeed),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSettingFloat("flGyroStationaryTolerance", e.flGyroStationaryTolerance),
|
||||||
|
SteamClient.Input.SetControllerPersonalizationSettingFloat("flAccelerometerStationaryTolerance", e.flAccelerometerStationaryTolerance),
|
||||||
|
*/
|
||||||
|
SetControllerPersonalizationSettingFloat(param0: string, param1: number): any;
|
||||||
|
|
||||||
|
SetControllerRumbleSetting(controllerIndex: number, rumblePreference: EControllerRumbleSetting): any;
|
||||||
|
|
||||||
|
SetControllerUseUniversalFaceButtonGlyphs(controllerIndex: number, value: boolean): void;
|
||||||
|
|
||||||
|
SetCursorActionset(param0: boolean): any;
|
||||||
|
|
||||||
|
SetDualSenseUpdateNotification(param0: boolean): any
|
||||||
|
|
||||||
|
/*
|
||||||
|
SetEditingConfigurationValue(e, t, n, o) {
|
||||||
|
const a = new r.BinaryWriter;
|
||||||
|
n.serializeBinaryToWriter(n.fromObject(t), a);
|
||||||
|
const s = a.getResultBase64String();
|
||||||
|
f.Debug("SetEditingConfigurationValue serializeBinaryToWriter", (0, i.ZN)(t), s), this.EditingConfigurationWillUpdate(), this.m_updatingEditingConfigurationPromise = o(s).then((t => {
|
||||||
|
if (null == t) return f.Debug("SetEditingConfigurationValue returned nothing."), void (0, i.z)((() => this.UpdateEditingConfiguration(e, this.m_unControllerIndex, this.EditingConfiguration)));
|
||||||
|
const n = c.bE.deserializeBinary(t).toObject();
|
||||||
|
f.Debug("SetEditingConfigurationValue returned controller configuration.", n), this.UpdateEditingConfiguration(e, this.m_unControllerIndex, n), this.m_nEditNumber++, -1 == n.url.indexOf("autosave://") && this.SaveEditingConfiguration(e)
|
||||||
|
})).catch((e => {
|
||||||
|
f.Error("SetEditingConfigurationValue fail:", o, l.jt(e.result), e.message), this.m_bIsUpdatingActiveConfiguration = !1
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
|
SetControllerActionSet(e, t) {
|
||||||
|
this.SetEditingConfigurationValue(e, t, c.X3, (e => SteamClient.Input.SetEditingControllerConfigurationActionSet(this.m_unControllerIndex, e)))
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
SetEditingControllerConfigurationActionSet(controllerIndex: number, param1: any): any;
|
||||||
|
|
||||||
|
//this.SetEditingConfigurationValue(e, t, c.io, (e => SteamClient.Input.SetEditingControllerConfigurationInputActivator(this.m_unControllerIndex, e)))
|
||||||
|
SetEditingControllerConfigurationInputActivator(controllerIndex: number, param1: any): any;
|
||||||
|
|
||||||
|
//this.SetEditingConfigurationValue(e, t, c.tH, (e => SteamClient.Input.SetEditingControllerConfigurationInputActivatorEnabled(this.m_unControllerIndex, e)))
|
||||||
|
SetEditingControllerConfigurationInputActivatorEnabled(controllerIndex: number, param1: any): any;
|
||||||
|
|
||||||
|
//this.SetEditingConfigurationValue(e, t, c.J2, (e => SteamClient.Input.SetEditingControllerConfigurationInputBinding(this.m_unControllerIndex, e)))
|
||||||
|
SetEditingControllerConfigurationInputBinding(controllerIndex: number, param1: any): any;
|
||||||
|
|
||||||
|
//this.SetEditingConfigurationValue(e, t, c.Sz, (e => SteamClient.Input.SetEditingControllerConfigurationMiscSetting(this.m_unControllerIndex, e)))
|
||||||
|
SetEditingControllerConfigurationMiscSetting(controllerIndex: number, param1: any): any;
|
||||||
|
|
||||||
|
//f.Debug("sending to client"), this.SetEditingConfigurationValue(e, t, c.QU, (e => SteamClient.Input.SetEditingControllerConfigurationSourceMode(this.m_unControllerIndex, e)))
|
||||||
|
SetEditingControllerConfigurationSourceMode(controllerIndex: number, param1: any): any;
|
||||||
|
|
||||||
|
SetGamepadKeyboardText(param0: boolean, param1: string): any;
|
||||||
|
|
||||||
|
SetKeyboardActionset(param0: boolean, param1: boolean): any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the mouse position.
|
||||||
|
* @param pid 0
|
||||||
|
* @param x Mouse X position.
|
||||||
|
* @param y Mouse Y position.
|
||||||
|
*/
|
||||||
|
SetMousePosition(pid: number, x: number, y: number): void;
|
||||||
|
|
||||||
|
SetSelectedConfigForApp(appId: number, controllerIndex: number, url: string, param3: boolean): any;
|
||||||
|
|
||||||
|
SetSteamControllerDonglePairingMode(bEnable: boolean, bSilent: boolean): any;
|
||||||
|
|
||||||
|
SetVirtualMenuKeySelected(unControllerIndex: number, unMenuIndex: number, m_controllerMenuActiveMenuItem: number): any; //
|
||||||
|
SetWebBrowserActionset(param0: boolean): any;
|
||||||
|
|
||||||
|
SetXboxDriverInstallState(param0: any): any; // state
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the Steam Input controller settings.
|
||||||
|
* This function displays the Steam Input controller settings for configuration.
|
||||||
|
*/
|
||||||
|
ShowControllerSettings(): void;
|
||||||
|
|
||||||
|
StandaloneKeyboardDismissed(): any;
|
||||||
|
|
||||||
|
StartControllerDeviceSupportFlow(param0: any, param1: any, callback: (param2: any) => void): any;
|
||||||
|
|
||||||
|
/*
|
||||||
|
this.m_updatingEditingConfigurationPromise = SteamClient.Input.StartEditingControllerConfigurationForAppIDAndControllerIndex(e, t).then((n=>{
|
||||||
|
const o = c.bE.deserializeBinary(n).toObject();
|
||||||
|
f.Debug("Loaded controller config for appid", e, n, o),
|
||||||
|
(0,
|
||||||
|
i.z)((()=>this.UpdateEditingConfiguration(e, t, o)))
|
||||||
|
}
|
||||||
|
)).catch((n=>{
|
||||||
|
f.Debug("Loading controller config for appid rejected", e, n),
|
||||||
|
(0,
|
||||||
|
i.z)((()=>this.UpdateEditingConfiguration(e, t, null)))
|
||||||
|
}
|
||||||
|
))
|
||||||
|
*/
|
||||||
|
StartEditingControllerConfigurationForAppIDAndControllerIndex(m_appId: number, m_unControllerIndex: number): Promise<any>;
|
||||||
|
|
||||||
|
StartGyroSWCalibration(callback: () => void): any;
|
||||||
|
|
||||||
|
StopEditingControllerConfiguration(controllerIndex: number): any;
|
||||||
|
|
||||||
|
SwapControllerConfigurationSourceModes: any;
|
||||||
|
|
||||||
|
//this.SetEditingConfigurationValue(e, t, c.Qb, (e => SteamClient.Input.SwapControllerModeInputBindings(this.m_unControllerIndex, e)))
|
||||||
|
SwapControllerModeInputBindings(controllerIndex: number, param1: any): any;
|
||||||
|
|
||||||
|
SwapControllerOrder(controllerIndex1: number, controllerIndex2: number): any;
|
||||||
|
|
||||||
|
SyncCloudedControllerConfigs(): any;
|
||||||
|
|
||||||
|
// type - enum
|
||||||
|
/*
|
||||||
|
Off - 0, Tick, Click
|
||||||
|
*/
|
||||||
|
TriggerHapticPulse(controllerIndex: number, eHapticType: number, param2: number): any;
|
||||||
|
|
||||||
|
TriggerSimpleHapticEvent(
|
||||||
|
controllerIndex: number,
|
||||||
|
eHapticType: number,
|
||||||
|
unIntensity: number,
|
||||||
|
ndBGain: number,
|
||||||
|
param4: number,
|
||||||
|
): any;
|
||||||
|
|
||||||
|
UnregisterForControllerStateChanges(): void;
|
||||||
|
|
||||||
|
UnregisterForUIVisualization(controllerIndex: number): any;
|
||||||
|
|
||||||
|
UploadChangesForCloudedControllerConfigs(): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EHIDKeyboardKey {
|
||||||
|
Invalid,
|
||||||
|
BeforeFirst = 3,
|
||||||
|
A,
|
||||||
|
B,
|
||||||
|
C,
|
||||||
|
D,
|
||||||
|
E,
|
||||||
|
F,
|
||||||
|
G,
|
||||||
|
H,
|
||||||
|
I,
|
||||||
|
J,
|
||||||
|
K,
|
||||||
|
L,
|
||||||
|
M,
|
||||||
|
N,
|
||||||
|
O,
|
||||||
|
P,
|
||||||
|
Q,
|
||||||
|
R,
|
||||||
|
S,
|
||||||
|
T,
|
||||||
|
U,
|
||||||
|
V,
|
||||||
|
W,
|
||||||
|
X,
|
||||||
|
Y,
|
||||||
|
Z,
|
||||||
|
Key_1,
|
||||||
|
Key_2,
|
||||||
|
Key_3,
|
||||||
|
Key_4,
|
||||||
|
Key_5,
|
||||||
|
Key_6,
|
||||||
|
Key_7,
|
||||||
|
Key_8,
|
||||||
|
Key_9,
|
||||||
|
Key_0,
|
||||||
|
Return,
|
||||||
|
Escape,
|
||||||
|
Backspace,
|
||||||
|
Tab,
|
||||||
|
Space,
|
||||||
|
Dash,
|
||||||
|
Equals,
|
||||||
|
LeftBracket,
|
||||||
|
RightBracket,
|
||||||
|
Backslash,
|
||||||
|
Unused1,
|
||||||
|
Semicolon,
|
||||||
|
SingleQuote,
|
||||||
|
Backtick,
|
||||||
|
Comma,
|
||||||
|
Period,
|
||||||
|
ForwardSlash,
|
||||||
|
CapsLock,
|
||||||
|
F1,
|
||||||
|
F2,
|
||||||
|
F3,
|
||||||
|
F4,
|
||||||
|
F5,
|
||||||
|
F6,
|
||||||
|
F7,
|
||||||
|
F8,
|
||||||
|
F9,
|
||||||
|
F10,
|
||||||
|
F11,
|
||||||
|
F12,
|
||||||
|
PrintScreen,
|
||||||
|
ScrollLock,
|
||||||
|
Break,
|
||||||
|
Insert,
|
||||||
|
Home,
|
||||||
|
PageUp,
|
||||||
|
Delete,
|
||||||
|
End,
|
||||||
|
PageDown,
|
||||||
|
RightArrow,
|
||||||
|
LeftArrow,
|
||||||
|
DownArrow,
|
||||||
|
UpArrow,
|
||||||
|
NumLock,
|
||||||
|
KeypadForwardSlash,
|
||||||
|
KeypadAsterisk,
|
||||||
|
KeypadDash,
|
||||||
|
KeypadPlus,
|
||||||
|
KeypadEnter,
|
||||||
|
Keypad_1,
|
||||||
|
Keypad_2,
|
||||||
|
Keypad_3,
|
||||||
|
Keypad_4,
|
||||||
|
Keypad_5,
|
||||||
|
Keypad_6,
|
||||||
|
Keypad_7,
|
||||||
|
Keypad_8,
|
||||||
|
Keypad_9,
|
||||||
|
Keypad_0,
|
||||||
|
KeypadPeriod,
|
||||||
|
LAlt,
|
||||||
|
LShift,
|
||||||
|
LWin,
|
||||||
|
LControl,
|
||||||
|
RAlt,
|
||||||
|
RShift,
|
||||||
|
RWin,
|
||||||
|
RControl,
|
||||||
|
VolUp,
|
||||||
|
VolDown,
|
||||||
|
Mute,
|
||||||
|
Play,
|
||||||
|
Stop,
|
||||||
|
Next,
|
||||||
|
Prev,
|
||||||
|
AfterLast,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ControllerAnalogInputMessage {
|
||||||
|
nA: number;
|
||||||
|
x: number;
|
||||||
|
y: number;
|
||||||
|
nC: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ControllerCommandMessage {
|
||||||
|
/**
|
||||||
|
* @todo enum
|
||||||
|
*/
|
||||||
|
eAction: number;
|
||||||
|
nControllerIndex: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ControllerConfigCloudState {
|
||||||
|
bSyncDone: boolean;
|
||||||
|
bSyncConflict: boolean;
|
||||||
|
bSyncError: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ControllerConfigInfoMessage {
|
||||||
|
appID: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ControllerConfigInfoMessageQuery extends ControllerConfigInfoMessage {
|
||||||
|
bPersonalQueryDone: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ControllerConfigInfoMessageList extends ControllerConfigInfoMessage {
|
||||||
|
nControllerType: number;
|
||||||
|
publishedFileID: string;
|
||||||
|
accountID: number;
|
||||||
|
Title: string;
|
||||||
|
Description: string;
|
||||||
|
URL: string;
|
||||||
|
timeUpdated: string;
|
||||||
|
bOfficial: boolean;
|
||||||
|
bProgenitorOfficial: boolean;
|
||||||
|
bRecommended: boolean;
|
||||||
|
bProgenitorRecommended: boolean;
|
||||||
|
bUsesSIAPI: boolean;
|
||||||
|
bUsesMouse: boolean;
|
||||||
|
bUsesKeyboard: boolean;
|
||||||
|
bUsesGamepad: boolean;
|
||||||
|
/**
|
||||||
|
* @todo unconfirmed
|
||||||
|
*/
|
||||||
|
eExportType: EControllerConfigExportType;
|
||||||
|
playtime: string;
|
||||||
|
bSelected: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EControllerConfigExportType {
|
||||||
|
Unknown,
|
||||||
|
PersonalLocal,
|
||||||
|
PersonalCloud,
|
||||||
|
Community,
|
||||||
|
Template,
|
||||||
|
Official,
|
||||||
|
OfficialDefault,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EControllerRumbleSetting {
|
||||||
|
ControllerPreference,
|
||||||
|
Off,
|
||||||
|
On,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum ControllerInputGamepadButton {
|
||||||
|
GAMEPAD_BUTTON_A = 0,
|
||||||
|
GAMEPAD_BUTTON_B = 1,
|
||||||
|
GAMEPAD_BUTTON_X = 2,
|
||||||
|
GAMEPAD_BUTTON_Y = 3,
|
||||||
|
GAMEPAD_BUTTON_DPAD_UP = 4,
|
||||||
|
GAMEPAD_BUTTON_DPAD_RIGHT = 5,
|
||||||
|
GAMEPAD_BUTTON_DPAD_DOWN = 6,
|
||||||
|
GAMEPAD_BUTTON_DPAD_LEFT = 7,
|
||||||
|
GAMEPAD_BUTTON_MENU = 8,
|
||||||
|
GAMEPAD_BUTTON_VIEW = 9,
|
||||||
|
GAMEPAD_LEFTPAD_UP = 10,
|
||||||
|
GAMEPAD_LEFTPAD_DOWN = 11,
|
||||||
|
GAMEPAD_LEFTPAD_LEFT = 12,
|
||||||
|
GAMEPAD_LEFTPAD_RIGHT = 13,
|
||||||
|
GAMEPAD_LEFTPAD_ANALOG = 14,
|
||||||
|
GAMEPAD_RIGHTPAD_UP = 15,
|
||||||
|
GAMEPAD_RIGHTPAD_DOWN = 16,
|
||||||
|
GAMEPAD_RIGHTPAD_LEFT = 17,
|
||||||
|
GAMEPAD_RIGHTPAD_RIGHT = 18,
|
||||||
|
GAMEPAD_RIGHTPAD_ANALOG = 19,
|
||||||
|
GAMEPAD_LEFTSTICK_UP = 20,
|
||||||
|
GAMEPAD_LEFTSTICK_DOWN = 21,
|
||||||
|
GAMEPAD_LEFTSTICK_LEFT = 22,
|
||||||
|
GAMEPAD_LEFTSTICK_RIGHT = 23,
|
||||||
|
GAMEPAD_LEFTSTICK_ANALOG = 24,
|
||||||
|
GAMEPAD_LEFTSTICK_CLICK = 25,
|
||||||
|
GAMEPAD_LTRIGGER_ANALOG = 26,
|
||||||
|
GAMEPAD_RTRIGGER_ANALOG = 27,
|
||||||
|
GAMEPAD_BUTTON_LTRIGGER = 28,
|
||||||
|
GAMEPAD_BUTTON_RTRIGGER = 29,
|
||||||
|
GAMEPAD_BUTTON_LSHOULDER = 30,
|
||||||
|
GAMEPAD_BUTTON_RSHOULDER = 31,
|
||||||
|
GAMEPAD_BUTTON_LBACK = 32,
|
||||||
|
GAMEPAD_BUTTON_RBACK = 33,
|
||||||
|
GAMEPAD_BUTTON_GUIDE = 34,
|
||||||
|
GAMEPAD_BUTTON_SELECT = 35,
|
||||||
|
GAMEPAD_BUTTON_START = 36,
|
||||||
|
GAMEPAD_BUTTON_LPAD_CLICKED = 37,
|
||||||
|
GAMEPAD_BUTTON_LPAD_TOUCH = 38,
|
||||||
|
GAMEPAD_BUTTON_RPAD_CLICKED = 39,
|
||||||
|
GAMEPAD_BUTTON_RPAD_TOUCH = 40,
|
||||||
|
GAMEPAD_RIGHTSTICK_CLICK = 41,
|
||||||
|
GAMEPAD_RIGHTSTICK_TOUCH = 42,
|
||||||
|
GAMEPAD_LEFTSTICK_TOUCH = 43,
|
||||||
|
GAMEPAD_BUTTON_LBACK_UPPER = 44,
|
||||||
|
GAMEPAD_BUTTON_RBACK_UPPER = 45,
|
||||||
|
GAMEPAD_BUTTON_LAST = 46,
|
||||||
|
GAMEPAD_ANALOG_SCROLL = 47,
|
||||||
|
GAMEPAD_ANALOG_LEFT_KEYBOARD_CURSOR = 48,
|
||||||
|
GAMEPAD_ANALOG_RIGHT_KEYBOARD_CURSOR = 49,
|
||||||
|
GAMEPAD_ANALOG_LAST = 50
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: Not the actual name, but the enum is only represented in a dropdown
|
||||||
|
// options vector, ty valve
|
||||||
|
export enum EThirdPartyControllerConfiguration {
|
||||||
|
Off,
|
||||||
|
DefaultSetting,
|
||||||
|
On,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ActiveAccount {
|
||||||
|
strActiveAccountID: string;
|
||||||
|
strName: string;
|
||||||
|
strAvatarHash: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ControllerInfo {
|
||||||
|
strName: string;
|
||||||
|
eControllerType: EControllerType;
|
||||||
|
nXInputIndex: number;
|
||||||
|
nControllerIndex: number;
|
||||||
|
eRumblePreference: EControllerRumbleSetting;
|
||||||
|
bWireless: boolean;
|
||||||
|
unUniqueID: number;
|
||||||
|
unVendorID: number;
|
||||||
|
unProductID: number;
|
||||||
|
/** Bitmask */
|
||||||
|
unCapabilities: number;
|
||||||
|
strFirmwareBuildTime: string;
|
||||||
|
strSerialNumber: string;
|
||||||
|
strChipID: string;
|
||||||
|
nLEDColorR: number;
|
||||||
|
nLEDColorG: number;
|
||||||
|
nLEDColorB: number;
|
||||||
|
flLEDBrightness: number;
|
||||||
|
flLEDSaturation: number;
|
||||||
|
nTurnOnSound: number;
|
||||||
|
nTurnOffSound: number;
|
||||||
|
nLStickDeadzone: number;
|
||||||
|
nRStickDeadzone: number;
|
||||||
|
nLHapticStrength: number;
|
||||||
|
nRHapticStrength: number;
|
||||||
|
flLPadPressureCurve: number;
|
||||||
|
flRPadPressureCurve: number;
|
||||||
|
bHaptics: boolean;
|
||||||
|
bSWAntiDrift: boolean;
|
||||||
|
flGyroStationaryTolerance: number;
|
||||||
|
flAccelerometerStationaryTolerance: number;
|
||||||
|
bRemoteDevice: boolean;
|
||||||
|
bNintendoLayout: boolean;
|
||||||
|
bUseReversedLayout: boolean;
|
||||||
|
ActiveAccount: ActiveAccount | undefined;
|
||||||
|
vecAltAccounts: any[]; // The type for this property might need to be more specific based on the actual data structure
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EControllerType {
|
||||||
|
None = -1,
|
||||||
|
Unknown,
|
||||||
|
UnknownSteamController,
|
||||||
|
SteamController, // Codename Gordon
|
||||||
|
SteamControllerV2, // Codename Headcrab
|
||||||
|
SteamControllerNeptune, // Steam Deck
|
||||||
|
FrontPanelBoard = 20,
|
||||||
|
Generic = 30,
|
||||||
|
XBox360Controller,
|
||||||
|
XBoxOneController,
|
||||||
|
PS3Controller,
|
||||||
|
PS4Controller,
|
||||||
|
WiiController,
|
||||||
|
AppleController,
|
||||||
|
AndroidController,
|
||||||
|
SwitchProController,
|
||||||
|
SwitchJoyConLeft,
|
||||||
|
SwitchJoyConRight,
|
||||||
|
SwitchJoyConPair,
|
||||||
|
SwitchProGenericInputOnlyController,
|
||||||
|
MobileTouch,
|
||||||
|
SwitchProXInputSwitchController,
|
||||||
|
PS5Controller,
|
||||||
|
XboxEliteController,
|
||||||
|
LastController, // Unverified
|
||||||
|
PS5EdgeController,
|
||||||
|
GenericKeyboard = 400,
|
||||||
|
GenericMouse = 800,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ControllerStateChange {
|
||||||
|
unControllerIndex: number;
|
||||||
|
unPacketNum: number;
|
||||||
|
/**
|
||||||
|
* Bitmask representing pressed upper buttons.
|
||||||
|
* - Bit 0-8: Unknown (@todo Please provide more details if known)
|
||||||
|
* - Bit 9: L4
|
||||||
|
* - Bit 10: R4
|
||||||
|
* - Bit 11-13: Unknown (@todo Please provide more details if known)
|
||||||
|
* - Bit 14: Left Joystick Touch
|
||||||
|
* - Bit 15: Right Joystick Touch
|
||||||
|
* - Bit 16-17: Unknown (@todo Please provide more details if known)
|
||||||
|
* - Bit 18: Quick Access Menu
|
||||||
|
*/
|
||||||
|
ulUpperButtons: number;
|
||||||
|
/**
|
||||||
|
* Bitmask representing pressed buttons.
|
||||||
|
* - Bit 0: R2
|
||||||
|
* - Bit 1: L2
|
||||||
|
* - Bit 2: R1
|
||||||
|
* - Bit 3: L1
|
||||||
|
* - Bit 4: Y
|
||||||
|
* - Bit 5: B
|
||||||
|
* - Bit 6: X
|
||||||
|
* - Bit 7: A
|
||||||
|
* - Bit 8: D-Pad Up
|
||||||
|
* - Bit 9: D-Pad Right
|
||||||
|
* - Bit 10: D-Pad Left
|
||||||
|
* - Bit 11: D-Pad Down
|
||||||
|
* - Bit 12: Select
|
||||||
|
* - Bit 13: Steam/Home
|
||||||
|
* - Bit 14: Start
|
||||||
|
* - Bit 15: L5
|
||||||
|
* - Bit 16: R5
|
||||||
|
* - Bit 17: Left Touchpad Click
|
||||||
|
* - Bit 18: Right Touchpad Click
|
||||||
|
* - Bit 19: Left Touchpad Touch
|
||||||
|
* - Bit 20: Right Touchpad Touch
|
||||||
|
* - Bit 21: Unknown (@todo Please provide more details if known)
|
||||||
|
* - Bit 22: L3
|
||||||
|
* - Bit 23-25: Unknown (@todo Please provide more details if known)
|
||||||
|
* - Bit 26: R3
|
||||||
|
* - Bit 27-28: Unknown (@todo Please provide more details if known)
|
||||||
|
* - Bit 29: Mute (Dualsense)
|
||||||
|
* - Bit 30-31: Unknown (@todo Please provide more details if known)
|
||||||
|
*/
|
||||||
|
ulButtons: number;
|
||||||
|
sLeftPadX: number;
|
||||||
|
sLeftPadY: number;
|
||||||
|
sRightPadX: number;
|
||||||
|
sRightPadY: number;
|
||||||
|
sCenterPadX: number;
|
||||||
|
sCenterPadY: number;
|
||||||
|
sLeftStickX: number;
|
||||||
|
sLeftStickY: number;
|
||||||
|
sRightStickX: number;
|
||||||
|
sRightStickY: number;
|
||||||
|
sTriggerL: number;
|
||||||
|
sTriggerR: number;
|
||||||
|
flTrustedGravityVectorX: number;
|
||||||
|
flTrustedGravityVectorY: number;
|
||||||
|
flTrustedGravityVectorZ: number;
|
||||||
|
flSoftwareQuatW: number;
|
||||||
|
flSoftwareQuatX: number;
|
||||||
|
flSoftwareQuatY: number;
|
||||||
|
flSoftwareQuatZ: number;
|
||||||
|
flSoftwareGyroDegreesPerSecondPitch: number;
|
||||||
|
flSoftwareGyroDegreesPerSecondYaw: number;
|
||||||
|
flSoftwareGyroDegreesPerSecondRoll: number;
|
||||||
|
flHardwareQuatW: number;
|
||||||
|
flHardwareQuatX: number;
|
||||||
|
flHardwareQuatY: number;
|
||||||
|
flHardwareQuatZ: number;
|
||||||
|
flHardwareGyroDegreesPerSecondPitch: number;
|
||||||
|
flHardwareGyroDegreesPerSecondYaw: number;
|
||||||
|
flHardwareGyroDegreesPerSecondRoll: number;
|
||||||
|
flGyroNoiseLength: number;
|
||||||
|
flGyroCalibrationProgress: number;
|
||||||
|
flGravityVectorX: number;
|
||||||
|
flGravityVectorY: number;
|
||||||
|
flGravityVectorZ: number;
|
||||||
|
flAccelerometerNoiseLength: number;
|
||||||
|
sBatteryLevel: number;
|
||||||
|
sPressurePadLeft: number;
|
||||||
|
sPressurePadRight: number;
|
||||||
|
sPressureBumperLeft: number;
|
||||||
|
sPressureBumperRight: number;
|
||||||
|
unHardwareUpdateInMicrosec: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface GameKeyboardMessage {
|
||||||
|
m_bOpen: boolean;
|
||||||
|
nAppID: number;
|
||||||
|
m_dwPID: number;
|
||||||
|
m_dwOverlayPID: number;
|
||||||
|
m_hPipe: number;
|
||||||
|
/** @todo enum */
|
||||||
|
m_eInputMode: number;
|
||||||
|
/** @todo enum */
|
||||||
|
m_eLineInputMode: number;
|
||||||
|
m_pchDescription: string;
|
||||||
|
m_unCharMax: number;
|
||||||
|
m_pchExistingText: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TouchMenuMessage {
|
||||||
|
bHasVirtualMenus: boolean;
|
||||||
|
unControllerIndex: number;
|
||||||
|
appID: number;
|
||||||
|
}
|
||||||
167
src/globals/steam-client/InstallFolder.ts
Normal file
167
src/globals/steam-client/InstallFolder.ts
Normal file
@@ -0,0 +1,167 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
import {EAppUpdateError} from "./App";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents functions related to Steam Install Folders.
|
||||||
|
*/
|
||||||
|
export interface InstallFolder {
|
||||||
|
/**
|
||||||
|
* Adds a Steam Library folder to the Steam client.
|
||||||
|
* @param path The path of the Steam Library folder to be added.
|
||||||
|
* @returns the index of the added folder.
|
||||||
|
*/
|
||||||
|
AddInstallFolder(path: string): Promise<number>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the file explorer to browse files in a specific Steam Library folder.
|
||||||
|
* @param folderIndex The index of the folder to be opened.
|
||||||
|
*/
|
||||||
|
BrowseFilesInFolder(folderIndex: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cancels the current move operation for moving game content.
|
||||||
|
*/
|
||||||
|
CancelMove(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves a list of installed Steam Library folders.
|
||||||
|
* @returns an array of SteamInstallFolder objects.
|
||||||
|
*/
|
||||||
|
GetInstallFolders(): Promise<SteamInstallFolder[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves a list of potential Steam Library folders that can be added.
|
||||||
|
* @returns an array of PotentialInstallFolder objects.
|
||||||
|
*/
|
||||||
|
GetPotentialFolders(): Promise<PotentialInstallFolder[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Moves the installation folder for a specific app to another Steam Library folder.
|
||||||
|
* @param appId The ID of the application to be moved.
|
||||||
|
* @param folderIndex The index of the target Steam Library folder.
|
||||||
|
*/
|
||||||
|
MoveInstallFolderForApp(appId: number, folderIndex: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Refreshes the list of installed Steam Library folders.
|
||||||
|
*/
|
||||||
|
RefreshFolders(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when changes occur in Steam Install Folders.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForInstallFolderChanges(callback: (change: FolderChange) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when moving game content progresses.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForMoveContentProgress(callback: (progress: MoveContentProgress) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when repairing an install folder is finished.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForRepairFolderFinished(callback: (change: FolderChange) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes a Steam Library folder from the Steam client.
|
||||||
|
* @param folderIndex The index of the folder to be removed.
|
||||||
|
*/
|
||||||
|
RemoveInstallFolder(folderIndex: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Repairs an installed Steam Library folder.
|
||||||
|
* @param folderIndex The index of the folder to be repaired.
|
||||||
|
*/
|
||||||
|
RepairInstallFolder(folderIndex: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets a specific Steam Library folder as the default install folder.
|
||||||
|
* @param folderIndex The index of the folder to be set as default.
|
||||||
|
*/
|
||||||
|
SetDefaultInstallFolder(folderIndex: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets a user-defined label for a specific Steam Library folder.
|
||||||
|
* @param folderIndex The index of the folder to be labeled.
|
||||||
|
* @param label The label to be assigned to the folder.
|
||||||
|
*/
|
||||||
|
SetFolderLabel(folderIndex: number, label: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents information about an installation folder.
|
||||||
|
*/
|
||||||
|
export interface SteamInstallFolder extends PotentialInstallFolder {
|
||||||
|
/** Index of the folder. */
|
||||||
|
nFolderIndex: number;
|
||||||
|
/** Used space in the folder. */
|
||||||
|
strUsedSize: string;
|
||||||
|
/** Size of DLC storage used in the folder. */
|
||||||
|
strDLCSize: string;
|
||||||
|
/** Size of workshop storage used in the folder. */
|
||||||
|
strWorkshopSize: string;
|
||||||
|
/** Size of staged storage used in the folder. */
|
||||||
|
strStagedSize: string;
|
||||||
|
/** Indicates if the folder is set as the default installation folder. */
|
||||||
|
bIsDefaultFolder: boolean;
|
||||||
|
/** Indicates if the folder is currently mounted. */
|
||||||
|
bIsMounted: boolean;
|
||||||
|
/** List of applications installed in the folder. */
|
||||||
|
vecApps: AppInfo[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PotentialInstallFolder {
|
||||||
|
/** Path of the folder. */
|
||||||
|
strFolderPath: string;
|
||||||
|
/** User label for the folder. */
|
||||||
|
strUserLabel: string;
|
||||||
|
/** Name of the drive where the folder is located. */
|
||||||
|
strDriveName: string;
|
||||||
|
/** Total capacity of the folder. */
|
||||||
|
strCapacity: string;
|
||||||
|
/** Available free space in the folder. */
|
||||||
|
strFreeSpace: string;
|
||||||
|
/** Indicates if the folder is on a fixed drive. */
|
||||||
|
bIsFixed: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents information about an installed application.
|
||||||
|
*/
|
||||||
|
export interface AppInfo {
|
||||||
|
/** ID of the application. */
|
||||||
|
nAppID: number;
|
||||||
|
/** Name of the application. */
|
||||||
|
strAppName: string;
|
||||||
|
/** Sorting information for the application. */
|
||||||
|
strSortAs: string;
|
||||||
|
/** Last played time in Unix Epoch time format. */
|
||||||
|
rtLastPlayed: number;
|
||||||
|
/** Size of used storage by the application. */
|
||||||
|
strUsedSize: string;
|
||||||
|
/** Size of DLC storage used by the application. */
|
||||||
|
strDLCSize: string;
|
||||||
|
/** Size of workshop storage used by the application. */
|
||||||
|
strWorkshopSize: string;
|
||||||
|
/** Size of staged storage used by the application. */
|
||||||
|
strStagedSize: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FolderChange {
|
||||||
|
folderIndex: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MoveContentProgress {
|
||||||
|
appid: number;
|
||||||
|
eError: EAppUpdateError;
|
||||||
|
flProgress: number;
|
||||||
|
strBytesMoved: string;
|
||||||
|
strTotalBytesToMove: string;
|
||||||
|
nFilesMoved: number;
|
||||||
|
}
|
||||||
131
src/globals/steam-client/Installs.ts
Normal file
131
src/globals/steam-client/Installs.ts
Normal file
@@ -0,0 +1,131 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
import {EAppUpdateError} from "./App";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents functions related to managing installs and installation wizards in Steam.
|
||||||
|
*/
|
||||||
|
export interface Installs {
|
||||||
|
/**
|
||||||
|
* Cancels the installation wizard if it is open.
|
||||||
|
*/
|
||||||
|
CancelInstall(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Continues and starts the installation if the wizard is still open.
|
||||||
|
*/
|
||||||
|
ContinueInstall(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves information from the last opened or currently opened installation wizard.
|
||||||
|
*/
|
||||||
|
GetInstallManagerInfo(): Promise<InstallMgrInfo>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the restore from backup installer wizard for a specific app.
|
||||||
|
* @param appBackupPath The backup path of the app.
|
||||||
|
*/
|
||||||
|
OpenInstallBackup(appBackupPath: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the installation wizard for specified app IDs.
|
||||||
|
* @param appIds An array of app IDs to install.
|
||||||
|
*/
|
||||||
|
OpenInstallWizard(appIds: number[]): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the uninstall wizard for specified app IDs.
|
||||||
|
* @param appIds An array of app IDs to uninstall.
|
||||||
|
* @param dontPrompt Whether to *not* prompt the user to uninstall.
|
||||||
|
*/
|
||||||
|
OpenUninstallWizard(appIds: number[], dontPrompt: boolean): void;
|
||||||
|
|
||||||
|
RegisterForShowConfirmUninstall: Unregisterable; // Broken? doesn't seem to work
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when the "Failed Uninstall" dialog is shown.
|
||||||
|
* @param callback The callback function to be called when the dialog is shown.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForShowFailedUninstall(callback: (appId: number, reason: EAppUpdateError) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when the installation wizard is shown.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForShowInstallWizard(callback: (data: InstallMgrInfo) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForShowRegisterCDKey: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets a list of app identifiers for downloads in the installation wizard.
|
||||||
|
* @param appIds An array of app IDs to set.
|
||||||
|
* @remarks The wizard will not reflect this change immediately, but changing another option will.
|
||||||
|
*/
|
||||||
|
SetAppList(appIds: number[]): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the options for creating shortcuts in the installation wizard.
|
||||||
|
* @param bDesktopShortcut Whether to create a desktop shortcut.
|
||||||
|
* @param bSystemMenuShortcut Whether to create a system menu shortcut.
|
||||||
|
* @remarks The wizard will not reflect this change immediately, but changing another option will.
|
||||||
|
*/
|
||||||
|
SetCreateShortcuts(bDesktopShortcut: boolean, bSystemMenuShortcut: boolean): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the install folder for the installation wizard using an install folder index.
|
||||||
|
* @param folderIndex The index of the install folder.
|
||||||
|
* @remarks The wizard will not reflect this change immediately, but changing another option will.
|
||||||
|
*/
|
||||||
|
SetInstallFolder(folderIndex: number): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface InstallMgrInfo {
|
||||||
|
rgAppIDs: InstallInfoApps[];
|
||||||
|
eInstallState: EInstallMgrState;
|
||||||
|
nDiskSpaceRequired: number;
|
||||||
|
nDiskSpaceAvailable: number;
|
||||||
|
nCurrentDisk: number;
|
||||||
|
nTotalDisks: number;
|
||||||
|
bCanChangeInstallFolder: boolean;
|
||||||
|
/**
|
||||||
|
* Index of the install folder. -1 if not installed.
|
||||||
|
*/
|
||||||
|
iInstallFolder: number;
|
||||||
|
iUnmountedFolder: number;
|
||||||
|
currentAppID: number;
|
||||||
|
eAppError: EAppUpdateError;
|
||||||
|
errorDetail: string;
|
||||||
|
bSystemMenuShortcut: boolean;
|
||||||
|
bDesktopShortcut: boolean;
|
||||||
|
bIsBackupInstall: boolean;
|
||||||
|
// device/hostname
|
||||||
|
strPeerContentServer: string;
|
||||||
|
bPeerContentServerOnline: boolean;
|
||||||
|
bPeerContentServerAvailable: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface InstallInfoApps {
|
||||||
|
nAppID: number;
|
||||||
|
lDiskSpaceRequiredBytes: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EInstallMgrState {
|
||||||
|
None,
|
||||||
|
Setup,
|
||||||
|
WaitLicense,
|
||||||
|
FreeLicense,
|
||||||
|
ShowCDKey,
|
||||||
|
WaitAppInfo,
|
||||||
|
ShowPassword,
|
||||||
|
ShowConfig,
|
||||||
|
ShowEULAs,
|
||||||
|
CreateApps,
|
||||||
|
ReadFromMedia,
|
||||||
|
ShowChangeMedia,
|
||||||
|
WaitLegacyCDKeys,
|
||||||
|
ShowSignup,
|
||||||
|
Complete,
|
||||||
|
Failed,
|
||||||
|
Canceled,
|
||||||
|
}
|
||||||
20
src/globals/steam-client/Messaging.ts
Normal file
20
src/globals/steam-client/Messaging.ts
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
export interface Messaging {
|
||||||
|
// section - "ContentManagement", "JumpList", "PostToLibrary"
|
||||||
|
// seems multipurpose
|
||||||
|
RegisterForMessages<T extends string>(
|
||||||
|
message: T,
|
||||||
|
callback: (message: T, section: string, args: string) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/*
|
||||||
|
function m(e) {
|
||||||
|
SteamClient.Messaging.PostMessage("LibraryCommands", "ShowFriendChatDialog", JSON.stringify({
|
||||||
|
steamid: e.persona.m_steamid.ConvertTo64BitString()
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
SteamClient.Messaging.PostMessage("FriendsUI", "AcceptedRemotePlayInvite", JSON.stringify({id: this.appID})) : SteamClient.Messaging.PostMessage("FriendsUI", "AcceptedGameInvite", JSON.stringify({id: this.appID}))
|
||||||
|
*/
|
||||||
|
PostMessage(message: string, section: string, args: string): void;
|
||||||
|
}
|
||||||
99
src/globals/steam-client/Music.ts
Normal file
99
src/globals/steam-client/Music.ts
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents functions related to controlling music playback in the Steam client.
|
||||||
|
*/
|
||||||
|
export interface Music {
|
||||||
|
/**
|
||||||
|
* Decreases the music volume by 10%.
|
||||||
|
*/
|
||||||
|
DecreaseVolume(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Increases the music volume by 10%.
|
||||||
|
*/
|
||||||
|
IncreaseVolume(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Plays the next track in the music playlist.
|
||||||
|
*/
|
||||||
|
PlayNext(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Plays the previous track in the music playlist.
|
||||||
|
*/
|
||||||
|
PlayPrevious(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when music playback changes.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForMusicPlaybackChanges(callback: (param0: boolean | MusicTrack) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when the music playback position changes.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForMusicPlaybackPosition(callback: (position: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the playback position of the music track.
|
||||||
|
* @param position The position to set in seconds.
|
||||||
|
*/
|
||||||
|
SetPlaybackPosition(position: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the repeat status for music playback.
|
||||||
|
* @param status The repeat status.
|
||||||
|
*/
|
||||||
|
SetPlayingRepeatStatus(status: EMusicPlayingRepeatStatus): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the shuffle status for music playback.
|
||||||
|
* @param value True to enable shuffle, false to disable shuffle.
|
||||||
|
*/
|
||||||
|
SetPlayingShuffled(value: boolean): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the volume for music playback.
|
||||||
|
* @param volume The volume level to set.
|
||||||
|
* @remarks Ranges from 0 to 100.
|
||||||
|
*/
|
||||||
|
SetVolume(volume: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Toggles the mute state of the music volume.
|
||||||
|
*/
|
||||||
|
ToggleMuteVolume(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Toggles between play and pause for music playback.
|
||||||
|
*/
|
||||||
|
TogglePlayPause(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MusicTrack {
|
||||||
|
uSoundtrackAppId: number;
|
||||||
|
ePlaybackStatus: EAudioPlayback;
|
||||||
|
eRepeatStatus: EMusicPlayingRepeatStatus;
|
||||||
|
bShuffle: boolean;
|
||||||
|
nVolume: number;
|
||||||
|
nActiveTrack: number;
|
||||||
|
nLengthInMsec: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EAudioPlayback {
|
||||||
|
Undefined,
|
||||||
|
Playing,
|
||||||
|
Paused,
|
||||||
|
Idle,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EMusicPlayingRepeatStatus {
|
||||||
|
None,
|
||||||
|
All,
|
||||||
|
Once,
|
||||||
|
Max,
|
||||||
|
}
|
||||||
333
src/globals/steam-client/Notifications.ts
Normal file
333
src/globals/steam-client/Notifications.ts
Normal file
@@ -0,0 +1,333 @@
|
|||||||
|
import { JsPbMessage, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Everything is taken from here:
|
||||||
|
* https://github.com/SteamDatabase/SteamTracking/blob/master/Protobufs/steammessages_clientnotificationtypes.proto
|
||||||
|
*/
|
||||||
|
export interface Notifications {
|
||||||
|
/**
|
||||||
|
* If `data` is deserialized, returns one of the following here: {@link Notifications}
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForNotifications(
|
||||||
|
callback: (notificationIndex: number, type: EClientNotificationType, data: ArrayBuffer) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EClientNotificationType {
|
||||||
|
Invalid,
|
||||||
|
DownloadComplete,
|
||||||
|
FriendInvite,
|
||||||
|
FriendInGame,
|
||||||
|
FriendOnline,
|
||||||
|
Achievement,
|
||||||
|
LowBattery,
|
||||||
|
SystemUpdate,
|
||||||
|
FriendMessage,
|
||||||
|
GroupChatMessage,
|
||||||
|
FriendInviteRollup,
|
||||||
|
FamilySharingDeviceAuthorizationChanged,
|
||||||
|
FamilySharingStopPlaying,
|
||||||
|
FamilySharingLibraryAvailable,
|
||||||
|
Screenshot,
|
||||||
|
CloudSyncFailure,
|
||||||
|
CloudSyncConflict,
|
||||||
|
IncomingVoiceChat,
|
||||||
|
ClaimSteamDeckRewards,
|
||||||
|
GiftReceived,
|
||||||
|
ItemAnnouncement,
|
||||||
|
HardwareSurvey,
|
||||||
|
LowDiskSpace,
|
||||||
|
BatteryTemperature,
|
||||||
|
DockUnsupportedFirmware,
|
||||||
|
PeerContentUpload,
|
||||||
|
CannotReadControllerGuideButton,
|
||||||
|
Comment,
|
||||||
|
Wishlist,
|
||||||
|
TradeOffer,
|
||||||
|
AsyncGame,
|
||||||
|
General,
|
||||||
|
HelpRequest,
|
||||||
|
OverlaySplashScreen,
|
||||||
|
BroadcastAvailableToWatch,
|
||||||
|
TimedTrialRemaining,
|
||||||
|
LoginRefresh,
|
||||||
|
MajorSale,
|
||||||
|
TimerExpired,
|
||||||
|
ModeratorMsg,
|
||||||
|
SteamInputActionSetChanged,
|
||||||
|
RemoteClientConnection,
|
||||||
|
RemoteClientStartStream,
|
||||||
|
StreamingClientConnection,
|
||||||
|
FamilyInvite,
|
||||||
|
PlaytimeWarning,
|
||||||
|
FamilyPurchaseRequest,
|
||||||
|
FamilyPurchaseRequestResponse,
|
||||||
|
ParentalFeatureRequest,
|
||||||
|
ParentalPlaytimeRequest,
|
||||||
|
GameRecordingError,
|
||||||
|
ParentalFeatureResponse,
|
||||||
|
ParentalPlaytimeResponse,
|
||||||
|
RequestedGameAdded,
|
||||||
|
ClipDownloaded,
|
||||||
|
GameRecordingStart,
|
||||||
|
GameRecordingStop,
|
||||||
|
GameRecordingUserMarkerAdded,
|
||||||
|
GameRecordingInstantClip,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum ESystemUpdateNotificationType {
|
||||||
|
Invalid,
|
||||||
|
Available,
|
||||||
|
NeedsRestart,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EGameRecordingErrorType {
|
||||||
|
General = 1,
|
||||||
|
LowDiskSpace,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationGroupChatMessage extends JsPbMessage {
|
||||||
|
tag(): string;
|
||||||
|
|
||||||
|
/** A Steam64 ID. */
|
||||||
|
steamid_sender(): string;
|
||||||
|
|
||||||
|
chat_group_id(): string;
|
||||||
|
|
||||||
|
chat_id(): string;
|
||||||
|
|
||||||
|
title(): string;
|
||||||
|
|
||||||
|
body(): string;
|
||||||
|
|
||||||
|
rawbody(): string;
|
||||||
|
|
||||||
|
icon(): string;
|
||||||
|
|
||||||
|
notificationid(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationFriendMessage extends JsPbMessage {
|
||||||
|
body(): string;
|
||||||
|
|
||||||
|
icon(): string;
|
||||||
|
|
||||||
|
notificationid(): number;
|
||||||
|
|
||||||
|
response_steamurl(): string;
|
||||||
|
|
||||||
|
/** A Steam64 ID. */
|
||||||
|
steamid(): string;
|
||||||
|
|
||||||
|
tag(): string;
|
||||||
|
|
||||||
|
title(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationCloudSyncFailure extends JsPbMessage {
|
||||||
|
appid(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationCloudSyncConflict extends JsPbMessage {
|
||||||
|
appid(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationScreenshot extends JsPbMessage {
|
||||||
|
screenshot_handle(): string;
|
||||||
|
description(): string;
|
||||||
|
local_url(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationDownloadCompleted extends JsPbMessage {
|
||||||
|
appid(): number;
|
||||||
|
dlc_appid(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationFriendInvite extends JsPbMessage {
|
||||||
|
steamid(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationFriendInviteRollup extends JsPbMessage {
|
||||||
|
new_invite_count(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationFriendInGame extends JsPbMessage {
|
||||||
|
steamid(): number;
|
||||||
|
game_name(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationFriendOnline extends JsPbMessage {
|
||||||
|
steamid(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationAchievement extends JsPbMessage {
|
||||||
|
achievement_id(): string;
|
||||||
|
appid(): number;
|
||||||
|
name(): string;
|
||||||
|
description(): string;
|
||||||
|
image_url(): string;
|
||||||
|
achieved(): boolean;
|
||||||
|
rtime_unlocked(): number;
|
||||||
|
min_progress(): number;
|
||||||
|
current_progress(): number;
|
||||||
|
max_progress(): number;
|
||||||
|
global_achieved_pct(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationLowBattery extends JsPbMessage {
|
||||||
|
pct_remaining(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationSystemUpdate extends JsPbMessage {
|
||||||
|
type(): ESystemUpdateNotificationType;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationFriendMessage extends JsPbMessage {
|
||||||
|
tag(): string;
|
||||||
|
steamid(): string;
|
||||||
|
title(): string;
|
||||||
|
body(): string;
|
||||||
|
icon(): string;
|
||||||
|
notificationid(): number;
|
||||||
|
response_steamurl(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationGroupChatMessage extends JsPbMessage {
|
||||||
|
tag(): string;
|
||||||
|
steamid_sender(): string;
|
||||||
|
chat_group_id(): string;
|
||||||
|
chat_id(): string;
|
||||||
|
title(): string;
|
||||||
|
body(): string;
|
||||||
|
rawbody(): string;
|
||||||
|
icon(): string;
|
||||||
|
notificationid(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationFamilySharingDeviceAuthorizationChanged extends JsPbMessage {
|
||||||
|
accountid_owner(): number;
|
||||||
|
authorized(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationFamilySharingStopPlaying extends JsPbMessage {
|
||||||
|
accountid_owner(): number;
|
||||||
|
seconds_remaining(): number;
|
||||||
|
appid(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationFamilySharingLibraryAvailable extends JsPbMessage {
|
||||||
|
accountid_owner(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationIncomingVoiceChat extends JsPbMessage {
|
||||||
|
steamid(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationClaimSteamDeckRewards extends JsPbMessage {
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationGiftReceived extends JsPbMessage {
|
||||||
|
sender_name(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationItemAnnouncement extends JsPbMessage {
|
||||||
|
new_item_count(): number;
|
||||||
|
new_backpack_items(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationHardwareSurveyPending extends JsPbMessage {
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationLowDiskSpace extends JsPbMessage {
|
||||||
|
folder_index(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationBatteryTemperature extends JsPbMessage {
|
||||||
|
temperature(): number;
|
||||||
|
notification_type(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationDockUnsupportedFirmware extends JsPbMessage {
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationPeerContentUpload extends JsPbMessage {
|
||||||
|
appid(): number;
|
||||||
|
peer_name(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationCannotReadControllerGuideButton extends JsPbMessage {
|
||||||
|
controller_index(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationOverlaySplashScreen extends JsPbMessage {
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationBroadcastAvailableToWatch extends JsPbMessage {
|
||||||
|
broadcast_permission(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationTimedTrialRemaining extends JsPbMessage {
|
||||||
|
appid(): number;
|
||||||
|
icon(): string;
|
||||||
|
offline(): boolean;
|
||||||
|
allowed_seconds(): number;
|
||||||
|
played_seconds(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationLoginRefresh extends JsPbMessage {
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationTimerExpired extends JsPbMessage {
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationSteamInputActionSetChanged extends JsPbMessage {
|
||||||
|
controller_index(): number;
|
||||||
|
action_set_name(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationRemoteClientConnection extends JsPbMessage {
|
||||||
|
machine(): string;
|
||||||
|
connected(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationRemoteClientStartStream extends JsPbMessage {
|
||||||
|
machine(): string;
|
||||||
|
game_name(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationStreamingClientConnection extends JsPbMessage {
|
||||||
|
hostname(): string;
|
||||||
|
machine(): string;
|
||||||
|
connected(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationPlaytimeWarning extends JsPbMessage {
|
||||||
|
type(): string;
|
||||||
|
playtime_remaining(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationGameRecordingError extends JsPbMessage {
|
||||||
|
game_id(): number;
|
||||||
|
error_type(): EGameRecordingErrorType;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationGameRecordingStart extends JsPbMessage {
|
||||||
|
game_id(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationGameRecordingStop extends JsPbMessage {
|
||||||
|
game_id(): number;
|
||||||
|
clip_id(): string;
|
||||||
|
duration_secs(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientNotificationGameRecordingUserMarkerAdded extends JsPbMessage {
|
||||||
|
game_id(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CClientNotificationGameRecordingInstantClip extends JsPbMessage {
|
||||||
|
game_id(): number;
|
||||||
|
clip_id(): string;
|
||||||
|
duration_secs(): number;
|
||||||
|
}
|
||||||
122
src/globals/steam-client/OpenVR.ts
Normal file
122
src/globals/steam-client/OpenVR.ts
Normal file
@@ -0,0 +1,122 @@
|
|||||||
|
import { Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
|
||||||
|
export interface OpenVR {
|
||||||
|
Device: VRDevice;
|
||||||
|
DeviceProperties: DeviceProperties;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throws OperationResponse if mutual capabilities haven't been loaded.
|
||||||
|
*/
|
||||||
|
GetMutualCapabilities(): Promise<any>;
|
||||||
|
|
||||||
|
GetWebSecret(): Promise<string>;
|
||||||
|
|
||||||
|
InstallVR(): any;
|
||||||
|
|
||||||
|
Keyboard: Keyboard;
|
||||||
|
PathProperties: PathProperties;
|
||||||
|
|
||||||
|
QuitAllVR(): any;
|
||||||
|
|
||||||
|
RegisterForButtonPress: Unregisterable;
|
||||||
|
|
||||||
|
RegisterForHMDActivityLevelChanged(callback: (m_eHMDActivityLevel: EHMDActivityLevel) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForInstallDialog: Unregisterable;
|
||||||
|
|
||||||
|
RegisterForStartupErrors(callback: (clientError: any, initError: any, initErrorString: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForVRHardwareDetected(callback: (m_bHMDPresent: any, m_bHMDHardwareDetected: any, m_strHMDName: any) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForVRModeChange(callback: (m_bIsVRRunning: boolean) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForVRSceneAppChange(callback: (param0: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
SetOverlayInteractionAffordance: any;
|
||||||
|
|
||||||
|
StartVR: any;
|
||||||
|
TriggerOverlayHapticEffect: any;
|
||||||
|
VRNotifications: VRNotifications;
|
||||||
|
VROverlay: VROverlay;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface VRDevice {
|
||||||
|
BIsConnected: any;
|
||||||
|
RegisterForDeviceConnectivityChange: Unregisterable;
|
||||||
|
|
||||||
|
RegisterForVRDeviceSeenRecently(callback: (m_bVRDeviceSeenRecently: any) => void): Unregisterable;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DeviceProperties {
|
||||||
|
GetBoolDeviceProperty: any;
|
||||||
|
GetDoubleDeviceProperty: any;
|
||||||
|
GetFloatDeviceProperty: any;
|
||||||
|
GetInt32DeviceProperty: any;
|
||||||
|
GetStringDeviceProperty: any;
|
||||||
|
RegisterForDevicePropertyChange: Unregisterable;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Keyboard {
|
||||||
|
Hide(): any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@link EKeyboardFlags} could be useful here
|
||||||
|
*/
|
||||||
|
RegisterForStatus(callback: (m_bIsKeyboardOpen: boolean, m_eKeyboardFlags: number, m_sInitialKeyboardText: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
SendDone(): any;
|
||||||
|
|
||||||
|
SendText(key: string): any; //???
|
||||||
|
Show(): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PathProperties {
|
||||||
|
GetBoolPathProperty: any;
|
||||||
|
GetDoublePathProperty: any;
|
||||||
|
GetFloatPathProperty: any;
|
||||||
|
GetInt32PathProperty: any;
|
||||||
|
GetStringPathProperty: any;
|
||||||
|
RegisterForPathPropertyChange: any;
|
||||||
|
SetBoolPathProperty: any;
|
||||||
|
SetDoublePathProperty: any;
|
||||||
|
SetFloatPathProperty: any;
|
||||||
|
SetInt32PathProperty: any;
|
||||||
|
SetStringPathProperty: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface VRNotifications {
|
||||||
|
HideCustomNotification: any;
|
||||||
|
RegisterForNotificationEvent: Unregisterable;
|
||||||
|
ShowCustomNotification: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface VROverlay {
|
||||||
|
HideDashboard: any;
|
||||||
|
|
||||||
|
IsDashboardVisible(): Promise<boolean>;
|
||||||
|
|
||||||
|
RegisterForButtonPress: Unregisterable;
|
||||||
|
RegisterForCursorMovement: Unregisterable;
|
||||||
|
RegisterForThumbnailChanged: Unregisterable;
|
||||||
|
RegisterForVisibilityChanged: Unregisterable;
|
||||||
|
ShowDashboard: any;
|
||||||
|
|
||||||
|
SwitchToDashboardOverlay(param0: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EHMDActivityLevel {
|
||||||
|
Unknown = -1,
|
||||||
|
Idle,
|
||||||
|
UserInteraction,
|
||||||
|
UserInteraction_Timeout,
|
||||||
|
Standby,
|
||||||
|
Idle_Timeout,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EKeyboardFlags {
|
||||||
|
Minimal = 1 << 0,
|
||||||
|
Modal = 1 << 1,
|
||||||
|
ShowArrowKeys = 1 << 2,
|
||||||
|
HideDoneKey = 1 << 3,
|
||||||
|
}
|
||||||
172
src/globals/steam-client/Overlay.ts
Normal file
172
src/globals/steam-client/Overlay.ts
Normal file
@@ -0,0 +1,172 @@
|
|||||||
|
import type { EBrowserType, ESteamRealm, EUIComposition, EUIMode, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
export interface Overlay {
|
||||||
|
/**
|
||||||
|
* Destroys the gamepad UI desktop configurator window if open.
|
||||||
|
*/
|
||||||
|
DestroyGamePadUIDesktopConfiguratorWindow(): void;
|
||||||
|
|
||||||
|
GetOverlayBrowserInfo(): Promise<OverlayBrowserInfo[]>;
|
||||||
|
|
||||||
|
// steam://gamewebcallback
|
||||||
|
HandleGameWebCallback(url: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param protocol Something like {@link OverlayBrowserProtocols.strScheme}
|
||||||
|
*/
|
||||||
|
HandleProtocolForOverlayBrowser(appId: number, protocol: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when an overlay is activated from an app.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForActivateOverlayRequests(callback: (request: ActivateOverlayRequest) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when a microtransaction authorization is requested.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForMicroTxnAuth(
|
||||||
|
callback: (appId: number, microTxnId: string, realm: ESteamRealm, microTxnUrl: string) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when a microtransaction authorization is dismissed by the user in Steam's authorization page.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForMicroTxnAuthDismiss(callback: (appId: number, microTxnId: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForNotificationPositionChanged(
|
||||||
|
callback: (appId: number, position: ENotificationPosition, horizontalInset: number, verticalInset: number) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when an overlay is activated or closed.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForOverlayActivated(
|
||||||
|
callback: (overlayProcessPid: number, appId: number, active: boolean, param3: boolean) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when the overlay browser protocols change.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForOverlayBrowserProtocols(
|
||||||
|
callback: (browseProtocols: OverlayBrowserProtocols) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers **the** callback function to be called when the overlay browser information changes.
|
||||||
|
* @param callback The callback function to be called when the overlay browser information changes.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
* @remarks Do Not Use, this will break the overlay unless you know what you are doing.
|
||||||
|
*/
|
||||||
|
RegisterOverlayBrowserInfoChanged(callback: () => void): Unregisterable;
|
||||||
|
|
||||||
|
SetOverlayState(appId: string, state: EUIComposition): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
type OverlayRequestDialog_t =
|
||||||
|
| 'achievements'
|
||||||
|
| 'asyncnotificationsrequested'
|
||||||
|
| 'chat'
|
||||||
|
| 'community'
|
||||||
|
| 'friendadd'
|
||||||
|
| 'friendremove'
|
||||||
|
| 'friendrequestaccept'
|
||||||
|
| 'friendrequestignore'
|
||||||
|
| 'friendremove'
|
||||||
|
| 'jointrade'
|
||||||
|
| 'leaderboards'
|
||||||
|
| 'lobbyinvite'
|
||||||
|
| 'lobbyinviteconnectstring'
|
||||||
|
| 'officialgamegroup'
|
||||||
|
| 'requestplaytime'
|
||||||
|
| 'remoteplaytogether'
|
||||||
|
| 'remoteplaytogetherinvite'
|
||||||
|
| 'settings'
|
||||||
|
| 'stats'
|
||||||
|
| 'steamid'
|
||||||
|
| 'store';
|
||||||
|
|
||||||
|
// EPosition
|
||||||
|
export enum ENotificationPosition {
|
||||||
|
TopLeft,
|
||||||
|
TopRight,
|
||||||
|
BottomLeft,
|
||||||
|
BottomRight,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ActivateOverlayRequest {
|
||||||
|
/**
|
||||||
|
* The app ID that just had an overlay request.
|
||||||
|
*/
|
||||||
|
appid: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `true` if webpage, and so {@link strDialog} will start with `https://`.
|
||||||
|
*/
|
||||||
|
bWebPage: boolean;
|
||||||
|
|
||||||
|
eFlag: EOverlayToStoreFlag;
|
||||||
|
|
||||||
|
eWebPageMode: EActivateGameOverlayToWebPageMode;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Steam64 ID.
|
||||||
|
*/
|
||||||
|
steamidTarget: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Game invites string for `Friends.InviteUserToGame`.
|
||||||
|
*/
|
||||||
|
strConnectString: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Web page URL if starts with `https://`, so cast the type to `string` if it is.
|
||||||
|
*/
|
||||||
|
strDialog: OverlayRequestDialog_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* App ID of the requesting game.
|
||||||
|
*/
|
||||||
|
unRequestingAppID: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface OverlayBrowserInfo {
|
||||||
|
appID: number;
|
||||||
|
eBrowserType: EBrowserType;
|
||||||
|
eUIMode: EUIMode;
|
||||||
|
flDisplayScale?: number;
|
||||||
|
gameID: string;
|
||||||
|
nBrowserID: number;
|
||||||
|
nScreenHeight: number;
|
||||||
|
nScreenWidth: number;
|
||||||
|
/**
|
||||||
|
* The PID of the overlay process.
|
||||||
|
*/
|
||||||
|
unPID: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface OverlayBrowserProtocols {
|
||||||
|
unAppID: number;
|
||||||
|
strScheme: string;
|
||||||
|
bAdded: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EActivateGameOverlayToWebPageMode {
|
||||||
|
Default,
|
||||||
|
Modal,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EOverlayToStoreFlag {
|
||||||
|
None,
|
||||||
|
AddToCart,
|
||||||
|
AddToCartAndShow,
|
||||||
|
}
|
||||||
129
src/globals/steam-client/Parental.ts
Normal file
129
src/globals/steam-client/Parental.ts
Normal file
@@ -0,0 +1,129 @@
|
|||||||
|
import { EResult, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for managing parental control settings.
|
||||||
|
*/
|
||||||
|
export interface Parental {
|
||||||
|
/**
|
||||||
|
* Locks the parental control settings.
|
||||||
|
*/
|
||||||
|
LockParentalLock(): void;
|
||||||
|
|
||||||
|
RegisterForParentalPlaytimeWarnings(callback: (time: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be invoked when parental settings change.
|
||||||
|
* @param callback The callback function to be invoked when parental settings change.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForParentalSettingsChanges(callback: (settings: ParentalSettings) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unlocks the parental lock with the provided PIN.
|
||||||
|
* @param pin The 4-digit PIN to unlock the parental lock.
|
||||||
|
* @returns a number representing the result of the unlock operation.
|
||||||
|
*/
|
||||||
|
UnlockParentalLock(pin: string, param1: boolean): Promise<EResult>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ParentalSettings {
|
||||||
|
ever_enabled: boolean;
|
||||||
|
locked: boolean;
|
||||||
|
/**
|
||||||
|
* If deserialized, returns {@link ParentalSettingsProtoMsg}.
|
||||||
|
*/
|
||||||
|
settings: ArrayBuffer;
|
||||||
|
strPlaintextPassword: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents the parental settings and restrictions.
|
||||||
|
* @todo This whole thing is unconfirmed as I do not have access to parental
|
||||||
|
* stuff and things
|
||||||
|
*/
|
||||||
|
export interface ParentalSettingsProtoMsg {
|
||||||
|
steamid?: number;
|
||||||
|
applist_base_id?: number;
|
||||||
|
applist_base_description?: string;
|
||||||
|
/**
|
||||||
|
* Base list.
|
||||||
|
*/
|
||||||
|
applist_base: ParentalApp[];
|
||||||
|
/**
|
||||||
|
* Custom list of allowed applications.
|
||||||
|
*/
|
||||||
|
applist_custom: ParentalApp[];
|
||||||
|
/**
|
||||||
|
* @todo enum ?
|
||||||
|
*/
|
||||||
|
passwordhashtype?: number;
|
||||||
|
salt?: number;
|
||||||
|
passwordhash?: number;
|
||||||
|
/**
|
||||||
|
* Indicates whether parental settings are enabled.
|
||||||
|
*/
|
||||||
|
is_enabled?: boolean;
|
||||||
|
/**
|
||||||
|
* Bitmask representing enabled features.
|
||||||
|
* - Bit 0: Unknown (@todo Please provide more details if known)
|
||||||
|
* - Bit 1: Online content & features - Steam Store
|
||||||
|
* - Bit 2: Online content & features - Community-generated content
|
||||||
|
* - Bit 3: Online content & features - My online profile, screenshots, and achievements
|
||||||
|
* - Bit 4: Online content & features - Friends, chat, and groups
|
||||||
|
* - Bit 5-11: Unknown (@todo Please provide more details if known)
|
||||||
|
* - Bit 12: Library content - 0: Only games I choose, 1: All games
|
||||||
|
* @todo {@link EParentalFeature} ?
|
||||||
|
*/
|
||||||
|
enabled_features?: number;
|
||||||
|
/**
|
||||||
|
* Email for recovery (if applicable).
|
||||||
|
*/
|
||||||
|
recovery_email?: string;
|
||||||
|
is_site_license_lock?: boolean;
|
||||||
|
temporary_enabled_features?: number;
|
||||||
|
rtime_temporary_feature_expiration?: number;
|
||||||
|
playtime_restrictions?: ParentalPlaytimeRestrictions;
|
||||||
|
temporary_playtime_restrictions?: ParentalTemporaryPlaytimeRestrictions;
|
||||||
|
excluded_store_content_descriptors: number[];
|
||||||
|
excluded_community_content_descriptors: number[];
|
||||||
|
utility_appids: number[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ParentalApp {
|
||||||
|
appid: number;
|
||||||
|
is_allowed: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ParentalPlaytimeDay {
|
||||||
|
allowed_time_windows?: number;
|
||||||
|
allowed_daily_minutes?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ParentalPlaytimeRestrictions {
|
||||||
|
apply_playtime_restrictions?: boolean;
|
||||||
|
playtime_days: ParentalPlaytimeDay[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ParentalTemporaryPlaytimeRestrictions {
|
||||||
|
restrictions?: ParentalPlaytimeDay;
|
||||||
|
rtime_expires?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EParentalFeature {
|
||||||
|
Invalid,
|
||||||
|
Store,
|
||||||
|
Community,
|
||||||
|
Profile,
|
||||||
|
Friends,
|
||||||
|
News,
|
||||||
|
Trading,
|
||||||
|
Settings,
|
||||||
|
Console,
|
||||||
|
Browser,
|
||||||
|
ParentalSetup,
|
||||||
|
Library,
|
||||||
|
Test,
|
||||||
|
SiteLicense,
|
||||||
|
KioskMode,
|
||||||
|
Max,
|
||||||
|
}
|
||||||
342
src/globals/steam-client/RemotePlay.ts
Normal file
342
src/globals/steam-client/RemotePlay.ts
Normal file
@@ -0,0 +1,342 @@
|
|||||||
|
import {EControllerType} from "./Input";
|
||||||
|
import { EParentalFeature } from "./Parental";
|
||||||
|
import { EResult, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
export interface RemotePlay {
|
||||||
|
/**
|
||||||
|
* @param param1 TODO: Something about restrictions countries ? maybe it's games
|
||||||
|
*/
|
||||||
|
BCanAcceptInviteForGame(gameId: string, param1: string): Promise<boolean>;
|
||||||
|
BCanCreateInviteForGame(gameId: string, param1: boolean): Promise<boolean>;
|
||||||
|
|
||||||
|
BRemotePlayTogetherGuestOnPhoneOrTablet(steam64Id: string, guestId: number): Promise<boolean>;
|
||||||
|
|
||||||
|
BRemotePlayTogetherGuestSupported(): Promise<boolean>;
|
||||||
|
|
||||||
|
// TODO: both calls have 1 arg, but it requires 2
|
||||||
|
CancelInviteAndSession(steam64Id: string, param1: number): Promise<EResult>;
|
||||||
|
|
||||||
|
CancelInviteAndSessionWithGuestID(steam64Id: string, guestId: number): Promise<EResult>;
|
||||||
|
|
||||||
|
CancelRemoteClientPairing(): void;
|
||||||
|
|
||||||
|
CloseGroup(): Promise<number>;
|
||||||
|
|
||||||
|
CreateGroup(param0: string): Promise<EResult>;
|
||||||
|
|
||||||
|
CreateInviteAndSession(steam64Id: string, param1: string): Promise<EResult>;
|
||||||
|
|
||||||
|
CreateInviteAndSessionWithGuestID(steam64Id: string, guestId: number, param2: string): Promise<EResult>;
|
||||||
|
|
||||||
|
GetClientID(): Promise<string>;
|
||||||
|
|
||||||
|
// TODO: -1 no preference? no idea where the settings are anyway lol
|
||||||
|
GetClientStreamingBitrate(): Promise<number>;
|
||||||
|
GetClientStreamingQuality(): Promise<number>;
|
||||||
|
GetControllerType(controllerIndex: number): Promise<EControllerType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns an integer from 0 to 100.
|
||||||
|
*/
|
||||||
|
GetGameSystemVolume(): Promise<number>;
|
||||||
|
|
||||||
|
GetPerUserInputSettings(steam64Id: string): Promise<RemotePlayInputSettings>;
|
||||||
|
|
||||||
|
GetPerUserInputSettingsWithGuestID(steam64Id: string, guestId: number): Promise<RemotePlayInputSettings>;
|
||||||
|
|
||||||
|
IdentifyController(nControllerIndex: number): void;
|
||||||
|
|
||||||
|
InstallAudioDriver(): void;
|
||||||
|
InstallInputDriver(): void;
|
||||||
|
MoveControllerToSlot(controllerIndex: number, slot: number): void;
|
||||||
|
RegisterForAdditionalParentalBlocks(callback: (blocks: EParentalFeature[]) => void): Unregisterable;
|
||||||
|
RegisterForAudioDriverPrompt(callback: () => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo no mentions of it in Steam code
|
||||||
|
*/
|
||||||
|
RegisterForBitrateOverride: Unregisterable;
|
||||||
|
RegisterForClearControllers(callback: () => void): Unregisterable;
|
||||||
|
RegisterForControllerIndexSet(
|
||||||
|
callback: (steamid: string, slot: number, guestid: number) => void
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForDevicesChanges(callback: (devices: RemotePlayDevice[]) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForGroupCreated(callback: (steamId: string, appId: string) => void): Unregisterable;
|
||||||
|
RegisterForGroupDisbanded(callback: () => void): Unregisterable;
|
||||||
|
RegisterForInputDriverPrompt(callback: () => void): Unregisterable;
|
||||||
|
RegisterForInputDriverRestartNotice(callback: () => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForInputUsed(
|
||||||
|
callback: (steam64Id: string, type: EClientUsedInputType, guestId: number) => void,
|
||||||
|
): Unregisterable; // only fires on host
|
||||||
|
|
||||||
|
RegisterForInviteResult(
|
||||||
|
callback: (
|
||||||
|
steamId: string,
|
||||||
|
param1: any,
|
||||||
|
result: ERemoteClientLaunch,
|
||||||
|
) => void
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForNetworkUtilizationUpdate(
|
||||||
|
callback: (steam64Id: string, guestId: number, networkUtilization: number, networkDuration: number) => void,
|
||||||
|
): Unregisterable; // only fires on host
|
||||||
|
|
||||||
|
RegisterForPlaceholderStateChanged(callback: (isShowingPlaceholder: boolean) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForPlayerInputSettingsChanged(
|
||||||
|
callback: (steamId: string, settings: RemotePlayInputSettings, guestId: number) => void
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForQualityOverride(callback: (hostStreamingQualityOverride: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForRemoteClientLaunchFailed(callback: (state: ERemoteClientLaunch) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForRemoteClientStarted(callback: (steam64Id: string, appId: string) => void): Unregisterable; // only fires on client
|
||||||
|
|
||||||
|
RegisterForRemoteClientStopped(callback: (steam64Id: string, appId: string) => void): Unregisterable; // only fires on client
|
||||||
|
|
||||||
|
RegisterForRemoteDeviceAuthorizationCancelled(callback: () => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForRemoteDeviceAuthorizationRequested(callback: (device: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForRemoteDevicePairingPINChanged(callback: (device: string, pin: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForRestrictedSessionChanges(callback: (restrictedSession: boolean) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForSessionStopped(callback: (steam64Id: string, guestId: number, avatarHash: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForSessionStarted(callback: (steam64Id: string, gameId: string, guestId: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForSessionStopped(callback: (steam64Id: string, guestId: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForSettingsChanges(callback: (remotePlaySettings: RemotePlaySettings) => void): Unregisterable;
|
||||||
|
|
||||||
|
SetClientStreamingBitrate(bitrate: number): void;
|
||||||
|
|
||||||
|
SetClientStreamingQuality(quality: number): void;
|
||||||
|
|
||||||
|
SetGameSystemVolume(volume: number): void;
|
||||||
|
|
||||||
|
SetPerUserControllerInputEnabled(steam64Id: string, enabled: boolean): void;
|
||||||
|
|
||||||
|
SetPerUserControllerInputEnabledWithGuestID(steam64Id: string, guestId: number, enabled: boolean): void;
|
||||||
|
|
||||||
|
SetPerUserKeyboardInputEnabled(steam64Id: string, enabled: boolean): void;
|
||||||
|
|
||||||
|
SetPerUserKeyboardInputEnabledWithGuestID(steam64Id: string, guestId: number, enabled: boolean): void;
|
||||||
|
|
||||||
|
SetPerUserMouseInputEnabled(steam64Id: string, enabled: boolean): void;
|
||||||
|
|
||||||
|
SetPerUserMouseInputEnabledWithGuestID(steam64Id: string, guestId: number, enabled: boolean): void;
|
||||||
|
|
||||||
|
SetRemoteDeviceAuthorized(param0: boolean, param1: string): void;
|
||||||
|
|
||||||
|
SetRemoteDevicePIN(pin: string): void;
|
||||||
|
|
||||||
|
SetRemotePlayEnabled(enabled: boolean): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param base64 Serialized base64 message from {@link StreamingClientConfig}.
|
||||||
|
*/
|
||||||
|
SetStreamingClientConfig(base64: string, sessionId: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enables advanced client options.
|
||||||
|
*/
|
||||||
|
SetStreamingClientConfigEnabled(value: boolean): void;
|
||||||
|
|
||||||
|
SetStreamingDesktopToRemotePlayTogetherEnabled(enabled: boolean): void;
|
||||||
|
|
||||||
|
SetStreamingP2PScope(scope: EStreamP2PScope): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param base64 Serialized base64 message from {@link StreamingServerConfig}.
|
||||||
|
*/
|
||||||
|
SetStreamingServerConfig(base64: string, sessionId: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enables advanced host options.
|
||||||
|
*/
|
||||||
|
SetStreamingServerConfigEnabled(value: boolean): void;
|
||||||
|
|
||||||
|
StopStreamingClient(): void;
|
||||||
|
|
||||||
|
StopStreamingSession(id: number): void;
|
||||||
|
StopStreamingSessionAndSuspendDevice(id: number): void;
|
||||||
|
|
||||||
|
UnlockH264(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unpairs all devices.
|
||||||
|
*/
|
||||||
|
UnpairRemoteDevices(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EClientUsedInputType {
|
||||||
|
Keyboard,
|
||||||
|
Mouse,
|
||||||
|
Controller,
|
||||||
|
Max,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RemotePlayDevice {
|
||||||
|
clientId: string;
|
||||||
|
clientName: string;
|
||||||
|
status: string; // "Connected", "Paired",
|
||||||
|
formFactor: number;
|
||||||
|
unStreamingSessionID: number;
|
||||||
|
bCanSteamVR: boolean;
|
||||||
|
bCanSuspend: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface RemotePlayInputSettings {
|
||||||
|
bKeyboardEnabled: true;
|
||||||
|
bMouseEnabled: true;
|
||||||
|
bControllerEnabled: true;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RemotePlaySettings {
|
||||||
|
bAV1DecodeAvailable: boolean;
|
||||||
|
bHEVCDecodeAvailable: boolean;
|
||||||
|
bRemotePlayDisabledBySystemPolicy: boolean;
|
||||||
|
bRemotePlaySupported: boolean;
|
||||||
|
bRemotePlayEnabled: boolean;
|
||||||
|
eRemotePlayP2PScope: EStreamP2PScope;
|
||||||
|
bRemotePlayServerConfigAvailable: boolean;
|
||||||
|
bRemotePlayServerConfigEnabled: boolean;
|
||||||
|
bRemotePlayClientConfigEnabled: boolean;
|
||||||
|
unStreamingSessionID: number;
|
||||||
|
strStreamingClientName: string;
|
||||||
|
/**
|
||||||
|
* If deserialized, returns {@link StreamingClientConfig}.
|
||||||
|
*/
|
||||||
|
RemotePlayClientConfig: StreamingClientConfig;
|
||||||
|
/**
|
||||||
|
* If deserialized, returns {@link StreamingServerConfig}.
|
||||||
|
*/
|
||||||
|
RemotePlayServerConfig: ArrayBuffer;
|
||||||
|
nDefaultAudioChannels: number;
|
||||||
|
nAutomaticResolutionX: number;
|
||||||
|
nAutomaticResolutionY: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StreamingClientConfig {
|
||||||
|
quality?: EStreamQualityPreference;
|
||||||
|
desired_resolution_x?: number;
|
||||||
|
desired_resolution_y?: number;
|
||||||
|
desired_framerate_numerator?: number;
|
||||||
|
desired_framerate_denominator?: number;
|
||||||
|
desired_bitrate_kbps?: number;
|
||||||
|
enable_hardware_decoding?: boolean;
|
||||||
|
enable_performance_overlay?: boolean;
|
||||||
|
enable_video_streaming?: boolean;
|
||||||
|
enable_audio_streaming?: boolean;
|
||||||
|
enable_input_streaming?: boolean;
|
||||||
|
audio_channels?: number;
|
||||||
|
enable_video_hevc?: boolean;
|
||||||
|
enable_performance_icons?: boolean;
|
||||||
|
enable_microphone_streaming?: boolean;
|
||||||
|
controller_overlay_hotkey?: string;
|
||||||
|
enable_touch_controller_OBSOLETE?: boolean;
|
||||||
|
p2p_scope?: EStreamP2PScope;
|
||||||
|
enable_audio_uncompressed?: boolean;
|
||||||
|
display_limit?: StreamVideoLimit;
|
||||||
|
quality_limit?: StreamVideoLimit;
|
||||||
|
runtime_limit?: StreamVideoLimit;
|
||||||
|
decoder_limit: StreamVideoLimit[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StreamingServerConfig {
|
||||||
|
change_desktop_resolution?: boolean;
|
||||||
|
dynamically_adjust_resolution_OBSOLETE?: boolean;
|
||||||
|
enable_capture_nvfbc?: boolean;
|
||||||
|
enable_hardware_encoding_nvidia_OBSOLETE?: boolean;
|
||||||
|
enable_hardware_encoding_amd_OBSOLETE?: boolean;
|
||||||
|
enable_hardware_encoding_intel_OBSOLETE?: boolean;
|
||||||
|
software_encoding_threads?: number;
|
||||||
|
enable_traffic_priority?: boolean;
|
||||||
|
host_play_audio?: EStreamHostPlayAudioPreference;
|
||||||
|
enable_hardware_encoding?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StreamVideoLimit {
|
||||||
|
codec?: EStreamVideoCodec;
|
||||||
|
mode?: StreamVideoMode;
|
||||||
|
bitrate_kbps?: number;
|
||||||
|
burst_bitrate_kbps?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StreamVideoMode {
|
||||||
|
width?: number;
|
||||||
|
height?: number;
|
||||||
|
refresh_rate?: number;
|
||||||
|
refresh_rate_numerator?: number;
|
||||||
|
refresh_rate_denominator?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum ERemoteClientLaunch {
|
||||||
|
OK = 1,
|
||||||
|
Fail,
|
||||||
|
RequiresUI,
|
||||||
|
RequiresLaunchOption,
|
||||||
|
RequiresEULA,
|
||||||
|
Timeout,
|
||||||
|
StreamTimeout,
|
||||||
|
StreamClientFail,
|
||||||
|
OtherGameRunning,
|
||||||
|
DownloadStarted,
|
||||||
|
DownloadNoSpace,
|
||||||
|
DownloadFiltered,
|
||||||
|
DownloadRequiresUI,
|
||||||
|
AccessDenied,
|
||||||
|
NetworkError,
|
||||||
|
Progress,
|
||||||
|
ParentalUnlockFailed,
|
||||||
|
ScreenLocked,
|
||||||
|
Unsupported,
|
||||||
|
DisabledLocal,
|
||||||
|
DisabledRemote,
|
||||||
|
Broadcasting,
|
||||||
|
Busy,
|
||||||
|
DriversNotInstalled,
|
||||||
|
TransportUnavailable,
|
||||||
|
Canceled,
|
||||||
|
Invisible,
|
||||||
|
RestrictedCountry,
|
||||||
|
Unauthorized,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EStreamVideoCodec {
|
||||||
|
None,
|
||||||
|
Raw,
|
||||||
|
VP8,
|
||||||
|
VP9,
|
||||||
|
H264,
|
||||||
|
HEVC,
|
||||||
|
ORBX1,
|
||||||
|
ORBX2,
|
||||||
|
AV1,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EStreamHostPlayAudioPreference {
|
||||||
|
Default,
|
||||||
|
Always,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EStreamQualityPreference {
|
||||||
|
Automatic = -1,
|
||||||
|
Fast = 1,
|
||||||
|
Balanced,
|
||||||
|
Beautiful,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EStreamP2PScope {
|
||||||
|
Automatic,
|
||||||
|
Disabled,
|
||||||
|
OnlyMe,
|
||||||
|
Friends,
|
||||||
|
Everyone,
|
||||||
|
}
|
||||||
149
src/globals/steam-client/Screenshots.ts
Normal file
149
src/globals/steam-client/Screenshots.ts
Normal file
@@ -0,0 +1,149 @@
|
|||||||
|
/**
|
||||||
|
* Interface for managing screenshots.
|
||||||
|
*/
|
||||||
|
export interface Screenshots {
|
||||||
|
/**
|
||||||
|
* Deletes a local screenshot.
|
||||||
|
* @param appId The ID of the application.
|
||||||
|
* @param screenshotIndex The index of the local screenshot.
|
||||||
|
* @returns a boolean value indicating whether the deletion was successful.
|
||||||
|
*/
|
||||||
|
DeleteLocalScreenshot(appId: string, screenshotIndex: number): Promise<boolean>;
|
||||||
|
|
||||||
|
DeleteLocalScreenshots(screenshots: ScreenshotToDelete[]): Promise<ScreenshotDeletionResponse>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves all local screenshots for all applications.
|
||||||
|
* @returns an array of Screenshot objects.
|
||||||
|
*/
|
||||||
|
GetAllAppsLocalScreenshots(): Promise<Screenshot[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the count of all local screenshots for all applications.
|
||||||
|
* @returns the count of local screenshots.
|
||||||
|
*/
|
||||||
|
GetAllAppsLocalScreenshotsCount(): Promise<number>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves a range of local screenshots for all applications.
|
||||||
|
* @param start The starting index of the screenshot range.
|
||||||
|
* @param end The ending index of the screenshot range.
|
||||||
|
* @returns an array of Screenshot objects within the specified range.
|
||||||
|
*/
|
||||||
|
GetAllAppsLocalScreenshotsRange(start: number, end: number): Promise<Screenshot[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves all local screenshots.
|
||||||
|
* @returns an array of Screenshot objects.
|
||||||
|
*/
|
||||||
|
GetAllLocalScreenshots(): Promise<Screenshot[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the game associated with a specific local screenshot index.
|
||||||
|
* @param screenshotIndex The index of the local screenshot.
|
||||||
|
* @returns the ID of the game associated with the screenshot.
|
||||||
|
*/
|
||||||
|
GetGameWithLocalScreenshots(screenshotIndex: number): Promise<number>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the last taken local screenshot.
|
||||||
|
* @returns the last taken local screenshot.
|
||||||
|
*/
|
||||||
|
GetLastScreenshotTaken(): Promise<Screenshot>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves a specific local screenshot for an application.
|
||||||
|
* @param appId The ID of the application.
|
||||||
|
* @param screenshotIndex The index of the local screenshot.
|
||||||
|
* @returns the requested local screenshot.
|
||||||
|
*/
|
||||||
|
GetLocalScreenshotByHandle(appId: string, screenshotIndex: number): Promise<Screenshot>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the count of local screenshots for a specific application.
|
||||||
|
* @param appId The ID of the application.
|
||||||
|
* @returns the count of local screenshots for the application.
|
||||||
|
*/
|
||||||
|
GetLocalScreenshotCount(appId: number): Promise<number>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the path of a screenshot.
|
||||||
|
* @param appId The ID of the application.
|
||||||
|
* @param hHandle The handle of the screenshot.
|
||||||
|
* @returns the screenshot path or the screenshot directory if no such handle.
|
||||||
|
*/
|
||||||
|
GetLocalScreenshotPath(appId: number, hHandle: number): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the number of games with local screenshots.
|
||||||
|
* @returns the number of games with local screenshots.
|
||||||
|
*/
|
||||||
|
GetNumGamesWithLocalScreenshots(): Promise<number>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets total screenshot usage in the specified library folder.
|
||||||
|
* @param path Library folder path.
|
||||||
|
* @returns the number of taken space in bytes.
|
||||||
|
*/
|
||||||
|
GetTotalDiskSpaceUsage(path: string): Promise<number>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens a local screenshot in the system image viewer.
|
||||||
|
* If the screenshot index is invalid, this function opens the screenshots directory for the specified application ID.
|
||||||
|
* @param appId The ID of the application.
|
||||||
|
* @param screenshotIndex The index of the local screenshot.
|
||||||
|
*/
|
||||||
|
ShowScreenshotInSystemViewer(appId: string, screenshotIndex: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the folder containing local screenshots for a specific application.
|
||||||
|
* @param appId The ID of the application.
|
||||||
|
*/
|
||||||
|
ShowScreenshotsOnDisk(appId: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Uploads a local screenshot.
|
||||||
|
* @param appId The ID of the application.
|
||||||
|
* @param localScreenshot_hHandle The handle of the local screenshot.
|
||||||
|
* @param filePrivacyState The privacy state of the screenshot file.
|
||||||
|
* @returns a boolean value indicating whether the upload was successful.
|
||||||
|
*/
|
||||||
|
UploadLocalScreenshot(
|
||||||
|
appId: string,
|
||||||
|
localScreenshot_hHandle: number,
|
||||||
|
filePrivacyState: EUCMFilePrivacyState,
|
||||||
|
): Promise<boolean>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Screenshot {
|
||||||
|
nAppID: number;
|
||||||
|
strGameID: string;
|
||||||
|
hHandle: number;
|
||||||
|
nWidth: number;
|
||||||
|
nHeight: number;
|
||||||
|
nCreated: number; // timestamp
|
||||||
|
ePrivacy: EUCMFilePrivacyState;
|
||||||
|
strCaption: string;
|
||||||
|
bSpoilers: boolean;
|
||||||
|
strUrl: string;
|
||||||
|
bUploaded: boolean;
|
||||||
|
ugcHandle: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ScreenshotToDelete {
|
||||||
|
gameID: string;
|
||||||
|
rgHandles: number[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ScreenshotDeletionResponse {
|
||||||
|
bSuccess: boolean;
|
||||||
|
rgFailedRequestIndices: number[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EUCMFilePrivacyState {
|
||||||
|
Invalid = -1,
|
||||||
|
Private = 1 << 1,
|
||||||
|
FriendsOnly = 1 << 2,
|
||||||
|
Public = 1 << 3,
|
||||||
|
Unlisted = 1 << 4,
|
||||||
|
}
|
||||||
372
src/globals/steam-client/ServerBrowser.ts
Normal file
372
src/globals/steam-client/ServerBrowser.ts
Normal file
@@ -0,0 +1,372 @@
|
|||||||
|
import { OperationResponse, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents functionality for the server browser.
|
||||||
|
*/
|
||||||
|
export interface ServerBrowser {
|
||||||
|
/**
|
||||||
|
* Adds a favorite server.
|
||||||
|
* @param server The server to add.
|
||||||
|
* @returns an empty string if successful, `Invalid/missing IPv4?` if failed.
|
||||||
|
*/
|
||||||
|
AddFavoriteServer(server: GameServer): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds a favorite server by IP.
|
||||||
|
* @param ip The IP to add to favorite servers.
|
||||||
|
* @returns an empty string if successful, localization string if failed.
|
||||||
|
*/
|
||||||
|
AddFavoriteServersByIP(ip: string): Promise<string>;
|
||||||
|
|
||||||
|
CancelServerQuery(dialogId: number, queryServer: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Connects to a server from a given dialog.
|
||||||
|
* @param dialogId The dialog ID to use.
|
||||||
|
* @param password Server password, empty if none.
|
||||||
|
* @returns a connection status.
|
||||||
|
*/
|
||||||
|
ConnectToServer(dialogId: number, password: string): Promise<EJoinServerError>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a server info dialog for the server your friend is currently playing on.
|
||||||
|
* @param pid 0
|
||||||
|
* @param steamId A Steam64 ID of a friend.
|
||||||
|
*/
|
||||||
|
CreateFriendGameInfoDialog(pid: number, steamId: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a server info dialog.
|
||||||
|
* @param ip The server IP.
|
||||||
|
* @param port The server port.
|
||||||
|
* @param queryPort
|
||||||
|
* @returns the created dialog ID.
|
||||||
|
*/
|
||||||
|
CreateServerGameInfoDialog(ip: string, port: number, queryPort: number): Promise<number>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the server list.
|
||||||
|
* @param appId The game ID, 0 for every game.
|
||||||
|
* @param queryType The tab to use.
|
||||||
|
* @param filters Server filters.
|
||||||
|
* @param serverCallback What to do with the found server?
|
||||||
|
* @param requestCompletedCallback The callback function to be called when the request is completed.
|
||||||
|
* @returns the current server list request ID.
|
||||||
|
* @throws Throws if the query type is unknown.
|
||||||
|
* @throws Throws if the filter list isn't key/value pairs, i.e. of an even length.
|
||||||
|
* @remarks Stops at 10000 if there are more servers to be found.
|
||||||
|
* @example
|
||||||
|
* Filter examples, may be combined:
|
||||||
|
* ```
|
||||||
|
* [ 'gamedir', 'cstrike' ] // Doesn't work?
|
||||||
|
* [ 'hasplayers', '1' ] // Only works with "1"?
|
||||||
|
* [ 'notfull', '1' ] // Doesn't work?
|
||||||
|
* [ 'map', 'cs_office' ] // Has to be an exact match!
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
The enum in question:
|
||||||
|
|
||||||
|
(t =
|
||||||
|
'lan' == this.id
|
||||||
|
? this.all_servers.length > 0
|
||||||
|
? '#ServerBrowser_NoServersMatch'
|
||||||
|
: '#ServerBrowser_NoLanServers'
|
||||||
|
: 'internet' == this.id
|
||||||
|
? this.all_servers.length > 0
|
||||||
|
? '#ServerBrowser_NoInternetGamesMatch'
|
||||||
|
: e == l.zS.k_EServerFailedToRespond
|
||||||
|
? '#ServerBrowser_MasterServerNotResponsive'
|
||||||
|
: e == l.zS.k_ENoServersListedOnMasterServer
|
||||||
|
? '#ServerBrowser_MasterServerHasNoServersListed'
|
||||||
|
: '#ServerBrowser_NoInternetGamesResponded'
|
||||||
|
: 'favorites' == this.id
|
||||||
|
? this.all_servers.length > 0
|
||||||
|
? '#ServerBrowser_NoServersMatch'
|
||||||
|
: '#ServerBrowser_NoFavoriteServers'
|
||||||
|
: 'history' == this.id
|
||||||
|
? this.all_servers.length > 0
|
||||||
|
? '#ServerBrowser_NoHistoryServersMatch'
|
||||||
|
: '#ServerBrowser_NoServersPlayed'
|
||||||
|
: 'friends' == this.id
|
||||||
|
? this.all_servers.length > 0
|
||||||
|
? '#ServerBrowser_NoServersMatch'
|
||||||
|
: '#ServerBrowser_NoFriendsServers'
|
||||||
|
: 'BUGBUG'),
|
||||||
|
*/
|
||||||
|
CreateServerListRequest(
|
||||||
|
appId: number,
|
||||||
|
queryType: ServerBrowserTab_t,
|
||||||
|
filters: string[],
|
||||||
|
serverCallback: (server: GameServer) => void,
|
||||||
|
requestCompletedCallback: (response: number) => void,
|
||||||
|
): Promise<number | OperationResponse>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Destroys the game info dialog functions (but not the window).
|
||||||
|
* @param dialogId The dialog ID to use.
|
||||||
|
* @remarks ServerBrowser.CancelServerQuery may throw if it tries to ping the server.
|
||||||
|
*/
|
||||||
|
DestroyGameInfoDialog(dialogId: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stops retrieving the server list.
|
||||||
|
* @param activeServerListRequestId The active server request ID to use.
|
||||||
|
*/
|
||||||
|
DestroyServerListRequest(activeServerListRequestId: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets a list of games that support the server browser feature.
|
||||||
|
* @returns a list of games.
|
||||||
|
*/
|
||||||
|
GetMultiplayerGames(): Promise<ServerBrowserGame[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the server browser preferences.
|
||||||
|
* @returns server browser preferences.
|
||||||
|
*/
|
||||||
|
GetServerListPreferences(): Promise<ServerBrowserPreferences>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pings the server of a specified dialog ID.
|
||||||
|
* @param dialogId The dialog ID to use.
|
||||||
|
*/
|
||||||
|
PingServer(dialogId: number): Promise<number | OperationResponse>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when a server gets added to favorite servers.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForFavorites(callback: (list: ServerBrowserFavoritesAndHistory) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when idk
|
||||||
|
* @param dialogId The dialog ID to use.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForFriendGamePlayed(
|
||||||
|
dialogId: number,
|
||||||
|
callback: (server: ServerBrowserFriendServer) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when a server info dialog opens.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForGameInfoDialogs(callback: (dialogs: ServerBrowserDialog[]) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when player details get requested.
|
||||||
|
* @param dialogId The dialog ID to use.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForPlayerDetails(
|
||||||
|
dialogId: number,
|
||||||
|
callback: (player: PlayerDetails) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when a server gets pinged.
|
||||||
|
* @param dialogId The dialog ID to use.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForServerInfo(dialogId: number, callback: (server: GameServer) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes a server from favorite servers.
|
||||||
|
* @param server The server to remove.
|
||||||
|
*/
|
||||||
|
RemoveFavoriteServer(server: GameServer): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes a server from history of played servers.
|
||||||
|
* @param server The server to remove.
|
||||||
|
*/
|
||||||
|
RemoveHistoryServer(server: GameServer): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Requests player details for a specific dialog.
|
||||||
|
* @param dialogId The dialog ID to use.
|
||||||
|
*/
|
||||||
|
RequestPlayerDetails(dialogId: number): Promise<number | OperationResponse>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the server browser preferences.
|
||||||
|
* @param prefs Server list preferences.
|
||||||
|
*/
|
||||||
|
SetServerListPreferences(prefs: ServerBrowserPreferences): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
export type ServerBrowserTab_t = 'internet' | 'favorites' | 'history' | 'lan' | 'friends';
|
||||||
|
|
||||||
|
export interface ServerBrowserGame {
|
||||||
|
/** The ID of the game. */
|
||||||
|
appid: number;
|
||||||
|
/** The ID of the game. */
|
||||||
|
gameid: string;
|
||||||
|
/** The game folder. */
|
||||||
|
gamedir: string;
|
||||||
|
/** The game's name. */
|
||||||
|
name: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ServerBrowserPreferences {
|
||||||
|
GameList: string;
|
||||||
|
filters: ServerBrowserTabFilters;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ServerBrowserTabFilters = {
|
||||||
|
[tab in ServerBrowserTab_t]: ServerBrowserGameFilter;
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface ServerBrowserGameFilter {
|
||||||
|
/** Has users playing */
|
||||||
|
NoEmpty: boolean;
|
||||||
|
/** Server not full */
|
||||||
|
NoFull: boolean;
|
||||||
|
/** Is not password protected */
|
||||||
|
NoPassword: boolean;
|
||||||
|
/** Anti-cheat */
|
||||||
|
Secure: EServerBrowserGameFilterAntiCheat;
|
||||||
|
/** The ID of the game */
|
||||||
|
appid: number;
|
||||||
|
/** The game folder */
|
||||||
|
game: string;
|
||||||
|
/** Map filter */
|
||||||
|
map: string;
|
||||||
|
/** Latency */
|
||||||
|
ping: EServerBrowserGameFilterPing;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EServerBrowserGameFilterAntiCheat {
|
||||||
|
All,
|
||||||
|
Secure,
|
||||||
|
NotSecure,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EServerBrowserGameFilterPing {
|
||||||
|
All,
|
||||||
|
LessThan50 = 50,
|
||||||
|
LessThan100 = 100,
|
||||||
|
LessThan150 = 150,
|
||||||
|
LessThan250 = 250,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ServerBrowserFavoritesAndHistory {
|
||||||
|
favorites: GameServer[];
|
||||||
|
history: GameServer[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ServerBrowserFriendServer {
|
||||||
|
/** The ID of the game. */
|
||||||
|
appid: number;
|
||||||
|
/** Non-Steam server? */
|
||||||
|
bNonSteamServer: boolean;
|
||||||
|
gameText: string;
|
||||||
|
/** The ID of the game. */
|
||||||
|
gameid: string;
|
||||||
|
steamIDLobby: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ServerBrowserDialog {
|
||||||
|
dialogID: number;
|
||||||
|
ip: number;
|
||||||
|
port: number;
|
||||||
|
queryPort: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface GameServer {
|
||||||
|
/** The ID of the game. */
|
||||||
|
appid: number;
|
||||||
|
/** Do not refresh if had unsuccessful response? */
|
||||||
|
bDoNotRefresh?: boolean;
|
||||||
|
/** Found the server? */
|
||||||
|
bHadSuccessfulResponse: boolean;
|
||||||
|
/** Has password? */
|
||||||
|
bPassword: boolean;
|
||||||
|
/** Is VAC secured? */
|
||||||
|
bSecure: boolean;
|
||||||
|
/** How many bot players there currently are. */
|
||||||
|
botPlayers: number;
|
||||||
|
/** The server's game name/description. */
|
||||||
|
gameDesc: string;
|
||||||
|
/** The game folder. */
|
||||||
|
gameDir: string;
|
||||||
|
/** Server tags, separated by a comma. */
|
||||||
|
gameTags: string;
|
||||||
|
/** The server IP. */
|
||||||
|
ip: string;
|
||||||
|
/** Last time played as a UNIX timestamp. */
|
||||||
|
lastPlayed: number;
|
||||||
|
/** Current server map. */
|
||||||
|
map: string;
|
||||||
|
/** Max players on the server. */
|
||||||
|
maxPlayers: number;
|
||||||
|
/** The server name. */
|
||||||
|
name: string;
|
||||||
|
/** The latency to the server. */
|
||||||
|
ping: number;
|
||||||
|
/** How many players there currently are. */
|
||||||
|
players: number;
|
||||||
|
/** The server port. */
|
||||||
|
port: number;
|
||||||
|
queryPort: number;
|
||||||
|
/** The server's game version it is running on. */
|
||||||
|
serverVersion: number;
|
||||||
|
/** Game server account ID. */
|
||||||
|
steamID: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EJoinServerError {
|
||||||
|
PingFailed = -3,
|
||||||
|
Connecting,
|
||||||
|
Pinging,
|
||||||
|
None,
|
||||||
|
VACBanned,
|
||||||
|
ServerFull,
|
||||||
|
ModNotInstalled,
|
||||||
|
AppNotFound,
|
||||||
|
NotInitialized,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PlayerDetails {
|
||||||
|
/**
|
||||||
|
* `true` is the server refresh is successful.
|
||||||
|
*/
|
||||||
|
bSuccess: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `true` when the server refresh is done.
|
||||||
|
*/
|
||||||
|
bRefreshComplete: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Player name.
|
||||||
|
*
|
||||||
|
* @note Defined when {@link bRefreshComplete} is `true`.
|
||||||
|
*/
|
||||||
|
playerName?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Player score.
|
||||||
|
*
|
||||||
|
* @note Defined when {@link bRefreshComplete} is `true`.
|
||||||
|
*/
|
||||||
|
score?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Time played on the server in seconds
|
||||||
|
*
|
||||||
|
* @note Defined when {@link bRefreshComplete} is `true`.
|
||||||
|
*/
|
||||||
|
timePlayed?: number;
|
||||||
|
}
|
||||||
|
|
||||||
663
src/globals/steam-client/Settings.ts
Normal file
663
src/globals/steam-client/Settings.ts
Normal file
@@ -0,0 +1,663 @@
|
|||||||
|
import {CompatibilityTool as CompatibilityTool} from "./App";
|
||||||
|
import { JsPbMessage, OperationResponse, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
export interface Settings {
|
||||||
|
AddClientBeta(name: string, password: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears HTTP cache located in `<STEAMPATH>/appcache/httpcache`.
|
||||||
|
*/
|
||||||
|
ClearAllHTTPCaches(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears download cache and logs you out.
|
||||||
|
*/
|
||||||
|
ClearDownloadCache(): void;
|
||||||
|
|
||||||
|
GetAccountSettings(): Promise<AccountSettings>;
|
||||||
|
|
||||||
|
GetAppUsesP2PVoice(appId: number): Promise<boolean>;
|
||||||
|
|
||||||
|
GetAvailableLanguages(): Promise<Language[]>;
|
||||||
|
|
||||||
|
GetAvailableTimeZones(): Promise<TimeZone[]>;
|
||||||
|
|
||||||
|
// Returns the current language "english"
|
||||||
|
GetCurrentLanguage(): Promise<string>;
|
||||||
|
|
||||||
|
GetGlobalCompatTools(): Promise<CompatibilityTool[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns a ProtoBuf message. If deserialized, returns {@link MsgMonitorInfo}.
|
||||||
|
*/
|
||||||
|
GetMonitorInfo(): Promise<ArrayBuffer>;
|
||||||
|
|
||||||
|
GetOOBETestMode(): Promise<boolean>;
|
||||||
|
|
||||||
|
GetRegisteredSteamDeck(): Promise<RegisteredSteamDeck>;
|
||||||
|
|
||||||
|
// Returns the current timezone
|
||||||
|
GetTimeZone(): Promise<string>;
|
||||||
|
|
||||||
|
GetWindowed(): Promise<boolean>;
|
||||||
|
|
||||||
|
IgnoreSteamDeckRewards(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the Windows microphones dialog.
|
||||||
|
*/
|
||||||
|
OpenWindowsMicSettings(): void;
|
||||||
|
|
||||||
|
RegisterForMicVolumeUpdates: Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If `data` is deserialized, returns {@link MsgClientSettings}.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForSettingsArrayChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForSettingsChanges(callback: (settings: SteamSettings) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForTimeZoneChange(callback: (timezoneId: string) => void): Unregisterable; // When timezone is changed from settings, callback will return new timezoneId
|
||||||
|
ReinitMicSettings(): void;
|
||||||
|
|
||||||
|
RenderHotkey(event: KeyCaptureEvent): Promise<string>;
|
||||||
|
|
||||||
|
RequestDeviceAuthInfo(): void;
|
||||||
|
|
||||||
|
SelectClientBeta(nBetaID: number): void;
|
||||||
|
|
||||||
|
// Get from available languages
|
||||||
|
SetCurrentLanguage(strShortName: string): void;
|
||||||
|
|
||||||
|
SetEnableSoftProcessKill(value: boolean): void; // Default value is false, this is Valve internal menu
|
||||||
|
|
||||||
|
SetHostname(hostname: string): void;
|
||||||
|
|
||||||
|
SetMicTestMode(value: boolean): void;
|
||||||
|
|
||||||
|
SetOOBETestMode(value: boolean): void;
|
||||||
|
|
||||||
|
SetPreferredMonitor(monitor: string): void;
|
||||||
|
|
||||||
|
SetRegisteredSteamDeck(steam64Id: string, serialNumber: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the "Don't save account credentials on this computer" option.
|
||||||
|
* @param value Whether to save account credentials.
|
||||||
|
*/
|
||||||
|
SetSaveAccountCredentials(value: boolean): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param base64 Serialized base64 message from `CMsgClientSettings`.
|
||||||
|
* @returns a boolean indicating whether the operation was successful.
|
||||||
|
*/
|
||||||
|
SetSetting(base64: string): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* You can get valid timezoneIds from {@link GetAvailableTimeZones}.
|
||||||
|
*/
|
||||||
|
SetTimeZone(timezoneId: string): void;
|
||||||
|
|
||||||
|
SetUseNintendoButtonLayout(controllerIndex: number, value: boolean): void;
|
||||||
|
|
||||||
|
SetUseUniversalFaceButtonGlyphs(nControllerIndex: number, value: boolean): void;
|
||||||
|
|
||||||
|
SetWindowed(value: boolean): void;
|
||||||
|
|
||||||
|
SpecifyGlobalCompatTool(strToolName: string): void;
|
||||||
|
|
||||||
|
ToggleSteamInstall(): Promise<OperationResponse>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AccountSettings {
|
||||||
|
strEmail: string;
|
||||||
|
bEmailValidated: boolean;
|
||||||
|
bHasAnyVACBans: boolean;
|
||||||
|
bHasTwoFactor: boolean;
|
||||||
|
eSteamGuardState: ESteamGuardState;
|
||||||
|
rtSteamGuardEnableTime: number;
|
||||||
|
bSaveAccountCredentials: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo unconfirmed, taken from localization strings
|
||||||
|
*/
|
||||||
|
export enum ESteamGuardState {
|
||||||
|
EmailUnverified,
|
||||||
|
Protected,
|
||||||
|
Disabled,
|
||||||
|
Offline,
|
||||||
|
NotEnabled,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface KeyCaptureEvent {
|
||||||
|
alt_key: boolean;
|
||||||
|
ctrl_key: boolean;
|
||||||
|
display_name: string;
|
||||||
|
meta_key: boolean;
|
||||||
|
shift_key: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Language {
|
||||||
|
language: ELanguage;
|
||||||
|
strShortName: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum ELanguage {
|
||||||
|
None = -1,
|
||||||
|
English,
|
||||||
|
German,
|
||||||
|
French,
|
||||||
|
Italian,
|
||||||
|
Korean,
|
||||||
|
Spanish,
|
||||||
|
SimplifiedChinese,
|
||||||
|
TraditionalChinese,
|
||||||
|
Russian,
|
||||||
|
Thai,
|
||||||
|
Japanese,
|
||||||
|
Portuguese,
|
||||||
|
Polish,
|
||||||
|
Danish,
|
||||||
|
Dutch,
|
||||||
|
Finnish,
|
||||||
|
Norwegian,
|
||||||
|
Swedish,
|
||||||
|
Hungarian,
|
||||||
|
Czech,
|
||||||
|
Romanian,
|
||||||
|
Turkish,
|
||||||
|
Brazilian,
|
||||||
|
Bulgarian,
|
||||||
|
Greek,
|
||||||
|
Arabic,
|
||||||
|
Ukrainian,
|
||||||
|
LatamSpanish,
|
||||||
|
Vietnamese,
|
||||||
|
SteamChina_SChinese,
|
||||||
|
Max,
|
||||||
|
}
|
||||||
|
export interface RegisteredSteamDeck {
|
||||||
|
bRegistered: boolean;
|
||||||
|
bIgnoreRegistrationPrompt: boolean;
|
||||||
|
strSteamID: string;
|
||||||
|
strSerialNumber: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TimeZone {
|
||||||
|
utcOffset: number;
|
||||||
|
timezoneID: string;
|
||||||
|
timezoneLocalizationToken: string;
|
||||||
|
regionsLocalizationToken: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Region {
|
||||||
|
nRegionID: number;
|
||||||
|
strRegionName: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Hour {
|
||||||
|
nHour: number;
|
||||||
|
strDisplay: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AvailableClientBeta {
|
||||||
|
nBetaID: number;
|
||||||
|
strName: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SteamSettings {
|
||||||
|
bIsInClientBeta: boolean;
|
||||||
|
bIsSteamSideload: boolean;
|
||||||
|
eClientBetaState: EClientBetaState;
|
||||||
|
strSelectedBetaName: string;
|
||||||
|
nAvailableBetas: number;
|
||||||
|
bChangeBetaEnabled: boolean;
|
||||||
|
nSelectedBetaID: number;
|
||||||
|
vecAvailableClientBetas: AvailableClientBeta[];
|
||||||
|
bIsValveEmail: boolean;
|
||||||
|
bIsInDesktopUIBeta: boolean;
|
||||||
|
bEnableSoftProcessKill: boolean;
|
||||||
|
vecValidDownloadRegions: Region[];
|
||||||
|
vecValidAutoUpdateRestrictHours: Hour[];
|
||||||
|
bCompatEnabled: boolean;
|
||||||
|
bCompatEnabledForOtherTitles: boolean;
|
||||||
|
strCompatTool: string;
|
||||||
|
strDisplayName: string;
|
||||||
|
bDisplayIsExternal: boolean;
|
||||||
|
flAutoDisplayScaleFactor: number;
|
||||||
|
flCurrentDisplayScaleFactor: number;
|
||||||
|
bDisplayIsUsingAutoScale: boolean;
|
||||||
|
flMinDisplayScaleFactor: number;
|
||||||
|
flMaxDisplayScaleFactor: number;
|
||||||
|
flCurrentUnderscanLevel: number;
|
||||||
|
bUnderscanEnabled: boolean;
|
||||||
|
vecNightModeScheduledHours: Hour[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EClientBetaState {
|
||||||
|
None,
|
||||||
|
NoneChosen,
|
||||||
|
NoneChosenNonAdmin,
|
||||||
|
InBeta,
|
||||||
|
InBetaNonAdmin,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CMsgMonitorInfo
|
||||||
|
*/
|
||||||
|
export interface MsgMonitorInfo extends JsPbMessage {
|
||||||
|
monitors(): Monitor[];
|
||||||
|
|
||||||
|
selected_display_name(): string;
|
||||||
|
|
||||||
|
add_monitors(param0: any, param1: any): any;
|
||||||
|
|
||||||
|
set_monitors(param0: any): any;
|
||||||
|
|
||||||
|
set_selected_display_name(param0: any): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo Doesn't work on Linux ?
|
||||||
|
*/
|
||||||
|
export interface Monitor {
|
||||||
|
monitor_device_name: string;
|
||||||
|
monitor_display_name: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CMsgClientSettings
|
||||||
|
*/
|
||||||
|
export interface MsgClientSettings extends JsPbMessage {
|
||||||
|
always_show_user_chooser(): boolean;
|
||||||
|
|
||||||
|
always_use_gamepadui_overlay(): boolean;
|
||||||
|
|
||||||
|
auto_scale_factor(): number;
|
||||||
|
|
||||||
|
bigpicture_windowed(): boolean;
|
||||||
|
|
||||||
|
broadcast_bitrate(): number;
|
||||||
|
|
||||||
|
broadcast_chat_corner(): number;
|
||||||
|
|
||||||
|
broadcast_encoding_option(): EBroadcastEncoderSetting;
|
||||||
|
|
||||||
|
broadcast_output_height(): number;
|
||||||
|
|
||||||
|
broadcast_output_width(): number;
|
||||||
|
|
||||||
|
broadcast_permissions(): EBroadcastPermission;
|
||||||
|
|
||||||
|
broadcast_record_all_audio(): boolean;
|
||||||
|
|
||||||
|
broadcast_record_all_video(): boolean;
|
||||||
|
|
||||||
|
broadcast_record_microphone(): boolean;
|
||||||
|
|
||||||
|
broadcast_show_live_reminder(): boolean;
|
||||||
|
|
||||||
|
broadcast_show_upload_stats(): boolean;
|
||||||
|
|
||||||
|
cef_remote_debugging_enabled(): boolean;
|
||||||
|
|
||||||
|
cloud_enabled(): boolean;
|
||||||
|
|
||||||
|
controller_combine_nintendo_joycons(): boolean;
|
||||||
|
controller_enable_chord(): boolean;
|
||||||
|
|
||||||
|
controller_generic_support(): boolean;
|
||||||
|
|
||||||
|
controller_guide_button_focus_steam(): boolean;
|
||||||
|
|
||||||
|
controller_poll_rate(): boolean;
|
||||||
|
controller_power_off_timeout(): number;
|
||||||
|
|
||||||
|
controller_ps_support(): number;
|
||||||
|
|
||||||
|
controller_switch_support(): boolean;
|
||||||
|
|
||||||
|
controller_xbox_driver(): boolean;
|
||||||
|
|
||||||
|
controller_xbox_support(): boolean;
|
||||||
|
|
||||||
|
default_ping_rate(): number;
|
||||||
|
|
||||||
|
disable_all_toasts(): boolean;
|
||||||
|
|
||||||
|
disable_toasts_in_game(): boolean;
|
||||||
|
|
||||||
|
display_name(): string;
|
||||||
|
|
||||||
|
download_peer_content(): number;
|
||||||
|
|
||||||
|
download_rate_bits_per_s(): boolean;
|
||||||
|
|
||||||
|
download_region(): number;
|
||||||
|
|
||||||
|
download_throttle_rate(): number;
|
||||||
|
|
||||||
|
download_throttle_while_streaming(): boolean;
|
||||||
|
|
||||||
|
download_while_app_running(): boolean;
|
||||||
|
|
||||||
|
enable_avif_screenshots(): boolean;
|
||||||
|
|
||||||
|
enable_dpi_scaling(): boolean;
|
||||||
|
|
||||||
|
enable_gpu_accelerated_webviews(): boolean;
|
||||||
|
|
||||||
|
enable_hardware_video_decoding(): boolean;
|
||||||
|
|
||||||
|
enable_marketing_messages(): boolean;
|
||||||
|
|
||||||
|
enable_overlay(): boolean;
|
||||||
|
|
||||||
|
enable_screenshot_notification(): boolean;
|
||||||
|
|
||||||
|
enable_screenshot_sound(): boolean;
|
||||||
|
|
||||||
|
enable_shader_background_processing(): boolean;
|
||||||
|
|
||||||
|
enable_shader_precache(): boolean;
|
||||||
|
|
||||||
|
enable_ui_sounds(): boolean;
|
||||||
|
|
||||||
|
force_deck_perf_tab(): boolean;
|
||||||
|
|
||||||
|
force_fake_mandatory_update(): boolean;
|
||||||
|
|
||||||
|
force_oobe(): boolean;
|
||||||
|
|
||||||
|
g_background_audio(): EGRAudio;
|
||||||
|
|
||||||
|
g_background_a_m(): number;
|
||||||
|
|
||||||
|
g_background_a_s(): boolean;
|
||||||
|
|
||||||
|
g_background_path(): string;
|
||||||
|
|
||||||
|
g_background_max_keep(): string;
|
||||||
|
|
||||||
|
g_background_mode(): EGRMode;
|
||||||
|
|
||||||
|
g_background_time_resolution(): number;
|
||||||
|
|
||||||
|
g_background_mk(): CMsgHotkey;
|
||||||
|
|
||||||
|
g_background_tg(): CMsgHotkey;
|
||||||
|
|
||||||
|
g_max_fps(): number;
|
||||||
|
|
||||||
|
gamerecording_automatic_gain_control(): boolean;
|
||||||
|
gamerecording_export_codec(): EExportCodec;
|
||||||
|
gamerecording_export_directory(): number;
|
||||||
|
gamerecording_export_limit_bitrate(): number;
|
||||||
|
gamerecording_export_limit_frame_rate(): number;
|
||||||
|
gamerecording_export_limit_height(): number;
|
||||||
|
gamerecording_export_limit_size_mb(): number;
|
||||||
|
gamerecording_export_limit_width(): number;
|
||||||
|
gamerecording_export_limit_type(): EGRExportLimitType;
|
||||||
|
gamerecording_force_mic_mono(): boolean;
|
||||||
|
gamerecording_hotkey_ic(): CMsgHotkey;
|
||||||
|
gamerecording_ic_seconds(): number;
|
||||||
|
gamerecording_video_bitrate(): string;
|
||||||
|
gamerecording_video_maxheight(): number;
|
||||||
|
|
||||||
|
game_notes_enable_spellcheck(): boolean;
|
||||||
|
|
||||||
|
gamescope_allow_tearing(): boolean;
|
||||||
|
|
||||||
|
gamescope_app_target_framerate(): number;
|
||||||
|
|
||||||
|
gamescope_composite_debug(): boolean;
|
||||||
|
|
||||||
|
gamescope_disable_framelimit(): boolean;
|
||||||
|
|
||||||
|
gamescope_disable_mura_correction(): boolean;
|
||||||
|
|
||||||
|
gamescope_display_refresh_rate(): number;
|
||||||
|
|
||||||
|
gamescope_enable_app_target_framerate(): boolean;
|
||||||
|
|
||||||
|
gamescope_force_composite(): boolean;
|
||||||
|
|
||||||
|
gamescope_hdr_visualization(): EHDRVisualization;
|
||||||
|
|
||||||
|
gamescope_include_steamui_in_screenshots(): boolean;
|
||||||
|
|
||||||
|
gamescope_use_game_refresh_rate_in_steam(): boolean;
|
||||||
|
|
||||||
|
gamestream_enable_video_h265(): boolean;
|
||||||
|
gamestream_hardware_video_encode(): boolean;
|
||||||
|
|
||||||
|
hdr_compat_testing(): boolean;
|
||||||
|
|
||||||
|
in_client_beta(): boolean;
|
||||||
|
|
||||||
|
is_external_display(): boolean;
|
||||||
|
|
||||||
|
is_steam_sideloaded(): boolean;
|
||||||
|
|
||||||
|
jumplist_flags(): number;
|
||||||
|
|
||||||
|
library_disable_community_content(): boolean;
|
||||||
|
|
||||||
|
library_display_icon_in_game_list(): boolean;
|
||||||
|
|
||||||
|
library_display_size(): number;
|
||||||
|
|
||||||
|
library_low_bandwidth_mode(): boolean;
|
||||||
|
|
||||||
|
library_low_perf_mode(): boolean;
|
||||||
|
|
||||||
|
library_whats_new_show_only_product_updates(): boolean;
|
||||||
|
|
||||||
|
max_scale_factor(): number;
|
||||||
|
|
||||||
|
min_scale_factor(): number;
|
||||||
|
|
||||||
|
music_download_high_quality(): boolean;
|
||||||
|
|
||||||
|
music_pause_on_app_start(): boolean;
|
||||||
|
|
||||||
|
music_pause_on_voice_chat(): boolean;
|
||||||
|
|
||||||
|
music_playlist_notification(): boolean;
|
||||||
|
|
||||||
|
music_volume(): number;
|
||||||
|
|
||||||
|
needs_steam_service_repair(): boolean;
|
||||||
|
|
||||||
|
no_save_personal_info(): boolean;
|
||||||
|
|
||||||
|
oobe_test_mode_enabled(): boolean;
|
||||||
|
|
||||||
|
os_version_unsupported(): boolean;
|
||||||
|
|
||||||
|
overlay_fps_counter_corner(): number;
|
||||||
|
|
||||||
|
overlay_fps_counter_high_contrast(): boolean;
|
||||||
|
|
||||||
|
overlay_key(): CMsgHotkey;
|
||||||
|
|
||||||
|
overlay_restore_browser_tabs(): boolean;
|
||||||
|
|
||||||
|
overlay_scale_interface(): boolean;
|
||||||
|
|
||||||
|
overlay_tabs(): string;
|
||||||
|
|
||||||
|
overlay_toolbar_list_view(): boolean;
|
||||||
|
|
||||||
|
override_browser_composer_mode(): number;
|
||||||
|
|
||||||
|
play_sound_on_toast(): boolean;
|
||||||
|
|
||||||
|
preferred_monitor(): string;
|
||||||
|
|
||||||
|
ready_to_play_includes_streaming(): boolean;
|
||||||
|
|
||||||
|
restrict_auto_updates(): boolean;
|
||||||
|
|
||||||
|
restrict_auto_updates_end(): number;
|
||||||
|
|
||||||
|
restrict_auto_updates_start(): number;
|
||||||
|
|
||||||
|
run_at_startup(): boolean;
|
||||||
|
|
||||||
|
save_uncompressed_screenshots(): boolean;
|
||||||
|
|
||||||
|
screenshot_items_per_row(): number;
|
||||||
|
|
||||||
|
screenshot_key(): CMsgHotkey;
|
||||||
|
|
||||||
|
screenshots_path(): string;
|
||||||
|
|
||||||
|
server_ping_rate(): number;
|
||||||
|
|
||||||
|
setting_validation_bool(): boolean;
|
||||||
|
|
||||||
|
setting_validation_enum(): EHDRVisualization;
|
||||||
|
|
||||||
|
setting_validation_int32(): number;
|
||||||
|
|
||||||
|
setting_validation_uint32(): number;
|
||||||
|
|
||||||
|
setting_validation_uint64(): number;
|
||||||
|
|
||||||
|
setting_validation_float(): number;
|
||||||
|
|
||||||
|
setting_validation_string(): string;
|
||||||
|
|
||||||
|
shader_precached_size(): string;
|
||||||
|
|
||||||
|
show_copy_count_in_library(): boolean;
|
||||||
|
|
||||||
|
show_family_sharing_notifications(): boolean;
|
||||||
|
|
||||||
|
show_screenshot_manager(): boolean;
|
||||||
|
|
||||||
|
show_steam_deck_info(): boolean;
|
||||||
|
|
||||||
|
show_store_content_on_home(): boolean;
|
||||||
|
|
||||||
|
show_timestamps_in_console(): boolean;
|
||||||
|
|
||||||
|
skip_steamvr_install_dialog(): boolean;
|
||||||
|
|
||||||
|
small_mode(): boolean;
|
||||||
|
|
||||||
|
smooth_scroll_webviews(): boolean;
|
||||||
|
|
||||||
|
start_in_big_picture_mode(): boolean;
|
||||||
|
|
||||||
|
start_page(): string;
|
||||||
|
|
||||||
|
startup_movie_id(): string;
|
||||||
|
|
||||||
|
startup_movie_local_path(): string;
|
||||||
|
|
||||||
|
startup_movie_shuffle(): boolean;
|
||||||
|
|
||||||
|
startup_movie_used_for_resume(): boolean;
|
||||||
|
|
||||||
|
steam_cef_gpu_blocklist_disabled(): boolean;
|
||||||
|
|
||||||
|
steam_input_configurator_error_msg_enable(): boolean;
|
||||||
|
|
||||||
|
steam_networking_share_ip(): number;
|
||||||
|
|
||||||
|
steam_os_underscan_enabled(): boolean;
|
||||||
|
|
||||||
|
steam_os_underscan_level(): number;
|
||||||
|
|
||||||
|
steamos_cec_enabled(): boolean;
|
||||||
|
|
||||||
|
steamos_cec_wake_on_resume(): boolean;
|
||||||
|
|
||||||
|
steamos_magnifier_scale(): number;
|
||||||
|
|
||||||
|
steamos_status_led_brightness(): number;
|
||||||
|
|
||||||
|
steamos_tdp_limit(): number;
|
||||||
|
|
||||||
|
steamos_tdp_limit_enabled(): boolean;
|
||||||
|
|
||||||
|
steamos_wifi_debug(): boolean;
|
||||||
|
|
||||||
|
steamos_wifi_force_wpa_supplicant(): boolean;
|
||||||
|
|
||||||
|
system_bluetooth_enabled(): boolean;
|
||||||
|
|
||||||
|
turn_off_controller_on_exit(): boolean;
|
||||||
|
|
||||||
|
voice_mic_device_name(): string;
|
||||||
|
|
||||||
|
voice_mic_input_gain(): number;
|
||||||
|
|
||||||
|
voice_push_to_talk_key(): CMsgHotkey;
|
||||||
|
|
||||||
|
voice_push_to_talk_setting(): number;
|
||||||
|
|
||||||
|
voice_speaker_output_gain(): number;
|
||||||
|
|
||||||
|
web_browser_home(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CMsgHotkey extends JsPbMessage {
|
||||||
|
key_code(): number;
|
||||||
|
alt_key(): boolean;
|
||||||
|
shift_key(): boolean;
|
||||||
|
ctrl_key(): boolean;
|
||||||
|
meta_key(): boolean;
|
||||||
|
display_name(): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EBroadcastEncoderSetting {
|
||||||
|
BestQuality,
|
||||||
|
BestPerformance,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EBroadcastPermission {
|
||||||
|
Disabled,
|
||||||
|
FriendsApprove,
|
||||||
|
FriendsAllowed,
|
||||||
|
Public,
|
||||||
|
Subscribers,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EExportCodec {
|
||||||
|
Default,
|
||||||
|
H264,
|
||||||
|
H265,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EGRAudio {
|
||||||
|
Game,
|
||||||
|
System,
|
||||||
|
Select,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EGRExportLimitType {
|
||||||
|
Native,
|
||||||
|
FileSize,
|
||||||
|
Advanced,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EGRMode {
|
||||||
|
Never,
|
||||||
|
Always,
|
||||||
|
Manual,
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EHDRVisualization {
|
||||||
|
None,
|
||||||
|
Heatmap,
|
||||||
|
Analysis,
|
||||||
|
HeatmapExtended,
|
||||||
|
HeatmapClassic,
|
||||||
|
}
|
||||||
43
src/globals/steam-client/SharedConnection.ts
Normal file
43
src/globals/steam-client/SharedConnection.ts
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
import { ESteamRealm, Unregisterable } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `hSharedConnection` is the number from {@link AllocateSharedConnection}.
|
||||||
|
*/
|
||||||
|
export interface SharedConnection {
|
||||||
|
AllocateSharedConnection(): Promise<number>;
|
||||||
|
|
||||||
|
// if no such number, sends this warning:
|
||||||
|
// src\clientdll\clientsharedconnection.cpp (154) : m_mapSharedConnections.HasElement( hSharedConnection )
|
||||||
|
Close(hSharedConnection: number): void;
|
||||||
|
|
||||||
|
RegisterOnBinaryMessageReceived(hSharedConnection: number, callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterOnLogonInfoChanged(hSharedConnection: number, callback: (info: LogonInfo) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterOnMessageReceived(hSharedConnection: number, callback: (param0: any) => void): Unregisterable;
|
||||||
|
|
||||||
|
SendMsg: any;
|
||||||
|
SendMsgAndAwaitBinaryResponse: any;
|
||||||
|
|
||||||
|
SendMsgAndAwaitResponse(hSharedConnection: number, msg: string): Promise<any>;
|
||||||
|
|
||||||
|
SubscribeToClientServiceMethod(hSharedConnection: number, param1: any): any;
|
||||||
|
|
||||||
|
SubscribeToEMsg(hSharedConnection: number, param1: any): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LogonInfo {
|
||||||
|
/** `true` if logged on. */
|
||||||
|
bLoggedOn: boolean;
|
||||||
|
eUniverse: ESteamRealm;
|
||||||
|
/** Account username. Empty if not logged on. */
|
||||||
|
strAccountName: string;
|
||||||
|
/** URL for community content. */
|
||||||
|
strCommunityImagesURL: string;
|
||||||
|
/** Account nickname. Empty if not logged on. */
|
||||||
|
strPersonaName: string;
|
||||||
|
/** Steam64 ID. */
|
||||||
|
strSteamid: string;
|
||||||
|
/** Country code. */
|
||||||
|
strUserCountry: string;
|
||||||
|
}
|
||||||
10
src/globals/steam-client/Stats.ts
Normal file
10
src/globals/steam-client/Stats.ts
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
export interface Stats {
|
||||||
|
// param0 - AppDetailsReviewSection, Showcases, LibraryReviewSpotlight
|
||||||
|
// param1 -
|
||||||
|
// AppDetailsReviewSection: PositiveClicked, NegativeClicked, NeutralClicked, PositiveReviewPosted, NegativeReviewPosted, EditClicked, ReviewCanceled
|
||||||
|
// LibraryReviewSpotlight: ReviseClicked, PositiveClicked, ReviseCloseClicked, NegativeClicked, PositiveRevisePosted, NegativeRevisePosted, ReviseCanceled, ReviewCanceled, CloseClicked
|
||||||
|
// Showcases: Delete, Save-Modify, Save-New
|
||||||
|
RecordActivationEvent(param0: string, param1: string): void;
|
||||||
|
|
||||||
|
RecordDisplayEvent(param0: boolean, param1: string, param2: string): void;
|
||||||
|
}
|
||||||
3
src/globals/steam-client/SteamChina.ts
Normal file
3
src/globals/steam-client/SteamChina.ts
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
export interface SteamChina {
|
||||||
|
GetCustomLauncherAppID(): Promise<number>;
|
||||||
|
}
|
||||||
24
src/globals/steam-client/Storage.ts
Normal file
24
src/globals/steam-client/Storage.ts
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
import { OperationResponse } from "./shared";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SteamClient.MachineStorage affects the "STEAMPATH/config/config.vdf" file.
|
||||||
|
* SteamClient.RoamingStorage affects the "STEAMPATH/userdata/STEAMID3/7/remote/sharedconfig.vdf" file.
|
||||||
|
* SteamClient.Storage affects the "STEAMPATH/userdata/STEAMID3/config/localconfig.vdf" file.
|
||||||
|
*/
|
||||||
|
export interface Storage {
|
||||||
|
DeleteKey(key: string): Promise<OperationResponse | undefined>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @remarks Use {@link SetObject} to set.
|
||||||
|
*/
|
||||||
|
GetJSON(key: string): Promise<OperationResponse | string>;
|
||||||
|
|
||||||
|
GetString(key: string): Promise<OperationResponse | string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @remarks Use {@link SetObject} to get.
|
||||||
|
*/
|
||||||
|
SetObject(key: string, value: object): Promise<OperationResponse | undefined>;
|
||||||
|
|
||||||
|
SetString(key: string, value: string): Promise<OperationResponse | undefined>;
|
||||||
|
}
|
||||||
59
src/globals/steam-client/Streaming.ts
Normal file
59
src/globals/steam-client/Streaming.ts
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
import { EResult, Unregisterable } from "./shared";
|
||||||
|
import {LaunchOption} from "./App";
|
||||||
|
|
||||||
|
export interface Streaming {
|
||||||
|
AcceptStreamingEULA(appId: number, id: string, version: number): void;
|
||||||
|
|
||||||
|
CancelStreamGame(): void; // existing stream
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when the streaming client finishes.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForStreamingClientFinished(callback: (code: EResult, result: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when there is progress in the launch of the streaming client.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForStreamingClientLaunchProgress(
|
||||||
|
callback: (actionType: string, taskDetails: string, done: number, total: number) => void,
|
||||||
|
): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when the streaming client is started (e.g., when clicking the stream button).
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForStreamingClientStarted(callback: (appId: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when the streaming launch is complete.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForStreamingLaunchComplete(callback: (code: EResult, result: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForStreamingShowEula(callback: (appId: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForStreamingShowIntro(callback: (appId: number, param: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when the streaming client receives launch options from the host.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
* @returns an object that can be used to unregister the callback.
|
||||||
|
*/
|
||||||
|
RegisterForStreamingShowLaunchOptions(
|
||||||
|
callback: (appId: number, launchOptions: LaunchOption[]) => void,
|
||||||
|
): Unregisterable; // Callback when streaming client receives launch options from host
|
||||||
|
|
||||||
|
StreamingContinueStreamGame(): void; // existing game running on another streaming capable device
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Chooses the launch option for the streamed app by its index
|
||||||
|
* and restarts the stream.
|
||||||
|
*/
|
||||||
|
StreamingSetLaunchOption(index: number): void;
|
||||||
|
}
|
||||||
90
src/globals/steam-client/UI.ts
Normal file
90
src/globals/steam-client/UI.ts
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
import { EUIMode, Unregisterable } from "./shared";
|
||||||
|
import {EOSType} from "./system";
|
||||||
|
|
||||||
|
export interface UI {
|
||||||
|
EnsureMainWindowCreated(): void;
|
||||||
|
|
||||||
|
ExitBigPictureMode(): void;
|
||||||
|
|
||||||
|
GetDesiredSteamUIWindows(): Promise<SteamWindow[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets information about whether your OS will be unsupported in the future or not.
|
||||||
|
*/
|
||||||
|
GetOSEndOfLifeInfo(): Promise<OSEndOfLifeInfo>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the current UI mode.
|
||||||
|
* @returns the current UI mode.
|
||||||
|
*/
|
||||||
|
GetUIMode(): Promise<EUIMode>;
|
||||||
|
|
||||||
|
NotifyAppInitialized(): void;
|
||||||
|
|
||||||
|
RegisterDesiredSteamUIWindowsChanged(callback: () => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a callback function to be called when a convar's value gets changed.
|
||||||
|
*
|
||||||
|
* Hard crashes if such a convar does not exist or if you can't set it.
|
||||||
|
*
|
||||||
|
* @param convar The ConVar to watch.
|
||||||
|
* @param callback The callback function to be called.
|
||||||
|
*/
|
||||||
|
RegisterForClientConVar(convar: string, callback: (value: string) => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo param{0,1} are enums
|
||||||
|
*/
|
||||||
|
RegisterForErrorCondition(callback: (param0: number, param1: number) => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForKioskModeResetSignal(callback: () => void): Unregisterable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo This fires multiple times.
|
||||||
|
*/
|
||||||
|
RegisterForStartupFinished(callback: () => void): Unregisterable;
|
||||||
|
|
||||||
|
RegisterForUIModeChanged(callback: (mode: EUIMode) => void): Unregisterable;
|
||||||
|
|
||||||
|
ResetErrorCondition(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the UI mode to the specified value.
|
||||||
|
* @param mode The UI mode to set.
|
||||||
|
*/
|
||||||
|
SetUIMode(mode: EUIMode): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum EWindowType {
|
||||||
|
MainGamepadUI,
|
||||||
|
OverlayGamepadUI,
|
||||||
|
Keyboard,
|
||||||
|
ControllerConfigurator,
|
||||||
|
VR,
|
||||||
|
MainDesktopUI,
|
||||||
|
DesktopLogin,
|
||||||
|
OverlayDesktopUI,
|
||||||
|
SteamChinaReviewLauncher,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface OSEndOfLifeInfo {
|
||||||
|
bOSWillBeUnsupported: boolean;
|
||||||
|
osType: EOSType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The following might have more correct information:
|
||||||
|
* https://github.com/SteamDatabase/SteamTracking/blob/master/Protobufs/webuimessages_sharedjscontext.proto
|
||||||
|
*/
|
||||||
|
export interface SteamWindow {
|
||||||
|
appid: number;
|
||||||
|
hwndParent: number;
|
||||||
|
nBrowserID: number;
|
||||||
|
strAppName: string;
|
||||||
|
unID: number;
|
||||||
|
unPID: number;
|
||||||
|
windowType: EWindowType;
|
||||||
|
x: number;
|
||||||
|
y: number;
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user