Skip to content

Commit 20df81f

Browse files
authored
Update README.md
1 parent 39db018 commit 20df81f

File tree

1 file changed

+30
-170
lines changed

1 file changed

+30
-170
lines changed

README.md

Lines changed: 30 additions & 170 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
![Youtube Banner](https://github.com/user-attachments/assets/78aa432b-e86e-4945-9b57-931a7ae5c5cb)
2-
3-
42
![image](https://github.com/user-attachments/assets/4f4ee062-14df-49df-968a-d196746ef80f)
5-
![image](https://github.com/user-attachments/assets/5fbf8e30-e468-424e-bad4-b6a4b656feb4)
63

4+
*Quick Links*
75
> [Reddit Link](https://reddit.com/r/DeskThing)
86
97
> 📃[Trello Board](https://trello.com/b/6v0paxqV/deskthing)
@@ -16,6 +14,11 @@
1614
1715
> 💬 [Car Thing Hax Community Discord](https://discord.carth.ing/)
1816
17+
---
18+
# ‼️DeskThing is completely free to use but [donations](https://deskthing.app/support) are greatly appreciated ☕
19+
20+
---
21+
1922
# The DeskThing ✔️
2023

2124
*Let's begin, shall we?*
@@ -26,10 +29,11 @@ Cheers!
2629

2730
*Dammit Jeff posted a video covering the DeskThing! Check it out [here](https://youtu.be/vQVuGeoqyUc?si=80bZQEFqH__qxppf&t=416)*
2831

29-
**⚠️DO NOT PULL MAIN BRANCH ⚠️**
32+
**⚠️DO NOT PULL MAIN BRANCH TO INSTALL ⚠️**
3033

3134
Instead, go to [The Official Website](https://deskthing.app/) and download the installer for your OS
32-
For a video walkthrough of v0.6.0, go to [this video](https://youtu.be/nC65O1nP-pk?si=dxUEF6wyzLI2Z72U)
35+
For a video walkthrough of v0.6.0, go to [this video]([https://youtu.be/nC65O1nP-pk?si=dxUEF6wyzLI2Z72U](https://www.youtube.com/watch?v=iW2biAnq0n8))
36+
3337

3438
---
3539
> All instructions are up-to-date as late of v0.9.0-beta. Later versions may differ in functionality and setup
@@ -42,81 +46,42 @@ The DeskThing is a simple CarThing Chromium-based website that can communicate w
4246

4347
Note: Not all of these are updated and are pending a revision. This is new as of v0.7.0
4448

49+
## Features
4550
- ### All In One Package 📦
46-
- [X] Download apps directly from the Desktop App GUI
51+
- [X] Download apps directly from the Desktop App
4752
- [X] Manage and update the Car Thing's display
4853
- [X] Probably more - just check it out already
54+
4955
- ### Configurable Controls ⚙️
5056
- [X] Make any button do any function!
5157
- [X] Control audio with the top buttons, front buttons, back buttons, really whatever you want!
5258
- [X] Modify them from the Desktop UI
5359
- [X] Add more directly from apps! (Basically, you can do anything)
60+
<img width="1369" height="874" alt="image" src="https://github.com/user-attachments/assets/5afb8396-d536-43ed-9a58-2bf9ae4ddc37" />
61+
*The deskthing mappings page - will be updated in v0.12*
62+
63+
## App Highlights (View the rest on the [deskthing website](https://deskthing.app/apps) or in the app store in deskthing)
64+
<img width="1108" height="687" alt="image" src="https://github.com/user-attachments/assets/66e7e296-e2fe-4306-af1a-7cf59c88f9f3" />
65+
66+
5467
- ### Spotify Integration 🎧
5568
- [X] Show currently listening (Album, Artist, Song name, album art)
5669
- [X] Control Spotify (Skip, pause, play, rewind, shuffle, repeat)
5770
- [X] Supports Podcasts too!
5871
- [X] Set Audio Output Source
59-
- Spotify app [installation instructions here](/DeskThing/server/apps/spotify#spotify-app-install)
60-
- ### Desktop Now Playing (Only Windows) 🎧
72+
<img width="4032" height="3024" alt="image" src="https://github.com/user-attachments/assets/26126fda-3b18-48c2-b223-bfbb80a655bb" />
73+
*[LyrThing](https://github.com/espeon/LyrThing/) community app showing spotify lyrics by Espeon*
74+
75+
- ### Local Audio Control 🎧
6176
- [X] Show currently listening (Album, Artist, Song name, album art)
62-
- [X] Control the current media (Skip, pause, play, rewind, shuffle, repeat)
63-
- *no setup instructions yet. Drag-n-drop the .zip from /releases/apps/ into the GUI*
64-
- ### Discord Integration 💬
65-
- [X] Show current call status (Participants, who's talking, their mute status)
66-
- [X] Control Discord (Mute/Unmute Deafen/Undeafen Disconnect)
67-
- [ ] ~~Control Individual User Volume~~
68-
- [ ] ~~See message preview~~
69-
- Discord app [installation instructions here](/DeskThing/server/apps/discord#discord-app-install)
70-
- ### Weather Integration 🌧️
71-
- [X] Show local weather
72-
- [X] Temperature
73-
- [X] AQI, UV Index, Wind Speed + Direction, Visibility
74-
- [X] 12 Hour forecast
75-
- Weather app [installation instructions here](/DeskThing/server/apps/weather#weather-app-install)
76-
- ### ~~Audible Integration📗~~ *to be migrated*
77-
- [ ] ~~Currently Listening To~~
78-
- [ ] ~~Audio Controls (Skip, Rewind, Fast Forward)~~
79-
- [ ] ~~Audio Status (%through)~~
80-
- [X] Audiobook Library
81-
- [X] Audiobook stats (Progress, Length of book, time left, ASIN)
82-
- Audible app [installation instructions here](/DeskThing/server/apps/audible#audible-app-install)
83-
- ### ~~Launchpad Integration 🎵~~ *to be migrated*
84-
- [X] Control different views on your launchpad!
85-
- [X] Show your system resource usage on your novation launchpad
86-
- [X] Add timers from your launchpad
87-
- [ ] ~~Show weather from launchpad~~
88-
- [ ] ~~Show time on launchpad~~
89-
- [ ] ~~Trigger macros from launchpad~~
90-
- [ ] Launchpad app [installation instructions here](/DeskThing/server/apps/launchpad#launchpad-app-install)
91-
- ### ~~Trello Integration 📃~~ *to be migrated*
92-
- [X] See all organizations
93-
- [X] See all boards
94-
- [X] See all lists
95-
- [X] See all cards
96-
- [X] See all tags
97-
- [X] Set different lists as your favorites
98-
- Trello app [installation instructions here](/DeskThing/server/apps/trello#trello-app-install)
99-
<details>
100-
<summary>
101-
<h3>Planned Apps</h3>
102-
</summary>
77+
- [X] Control Any Playing Media (Skip, pause, play, rewind, shuffle, repeat)
10378

104-
<img src="readme_images/bar.svg" style="width: 100%;" alt="Click to see the source">
79+
- ### Custom Apps
80+
<img width="615" height="478" alt="image" src="https://github.com/user-attachments/assets/20d32ba4-6c10-472c-ae2f-7365e10735c1" />
10581

106-
- Macropad / Streamdeck
107-
- GUI Companion
108-
- Dashboard/Settings for config changes
109-
- General audio control
110-
- Advanced Spotify Stats
111-
- Home Assistant
112-
- Pomodoro Timer
113-
- Google Calendar
114-
- More details in the [Trello Board](https://trello.com/b/6v0paxqV/deskthing)
82+
*Gif uploaded via the Image Viewer app*
11583
</details>
11684

117-
> *This is under constant development, so features will come as soon as I can make them. Suggestions welcome!*
118-
</details>
119-
12085
---
12186

12287
<details>
@@ -128,96 +93,16 @@ Note: Not all of these are updated and are pending a revision. This is new as of
12893

12994
### Detailed Setup Instructions
13095

131-
‼️ There is now a youtube tutorial walking through this process ‼️
132-
133-
[Setting up to v0.6.0 that shows how to flash](https://youtu.be/nC65O1nP-pk?si=umjOsybdfmQud6I0)
134-
135-
[Upgrading to v0.8.0 from 0.6.0](https://www.youtube.com/watch?v=Exu7KMcbN4k)
136-
137-
[Alternative flashing tutorial](https://youtu.be/Y0paq_qhG5M?si=YcpNOJzzQu8MJJTb)
138-
139-
*Step-by-step instructions*
140-
141-
1. **Flash Your CarThing:**
142-
- Follow the instructions in the [superbird-tool repository](https://github.com/Car-Thing-Hax-Community/superbird-tool) to flash your CarThing device with the necessary image.
143-
> If you need help, refer to the [detailed instructions](#flashing) at the end of this page
144-
145-
2. **Get the installer**
146-
*should be under [releases](https://github.com/ItsRiprod/DeskThing/releases)*
147-
148-
- Run the 'deskthing-0.*.*-*-setup.*' installer on your computer
149-
150-
3. **Check for your device:**
151-
- Under the 'Devices' tab, ensure your device shows up. If it does not, join the Discord server and report the issue, this can be buggy on some machines.
152-
> A few things to try if it isn't working is to 1: Use task manager to kill all instances of ADB 2: Run DeskThing as administrator 3: Unplug and plug in your Car thing 4: Install ADB and manually check with `adb devices`
153-
- If the device shows up, go to the 'Client Downloads' tab and click the latest version. It should show up at the top (Staged: Deskthing CLient)
154-
- Go back to the 'Devices' tab and click 'Push Staged Webapp' It should take a second, and then your Car Thing should restart.
155-
4. **Load Apps**
156-
- Congrats! You're basically done. Now go to 'Apps' and then 'Webapps' and download any apps you want. Ensure you check dependencies before doing so as this could cause errors.
96+
Updating this ReadMe with the updated flashing / installation instructions was tedious and led to confusion
15797

158-
> Any Issues? Contact me [through the Deskthing discord server](https://deskthing.app/discord) or via DMs to @riprod
98+
So now, it is contained inside an easy youtube video
15999

160-
⚠️Note for MacOS⚠️
161-
162-
First, when you install the DeskThing installer, you'll need to run
163-
```
164-
sudo xattr -r -d com.apple.quarantine DeskThing.app
165-
```
166-
to fix the app. Otherwise it'll say it's corrupted or something
167-
168-
Because ADB on the car thing and MacOS is funky, you need to run this on the DeskThing's ADB
169-
```
170-
chmod +x /Applications/DeskThing.app/Contents/Resources/mac/adb
171-
```
172-
173-
Finally, the image linked above won't always work for MacOS. So instead, use the following image (it is a discord download for now) as it fixes ADB for MacOS
174-
175-
**Go to Releases -> MACOS LISTEN UP to find the updated link**
176-
*Discord will cycle the url for the link so this one will expire after a given amount of time*
177-
[The new location is on thingify.tools. Use v8.9.2](thingify.tools)
178-
179-
Thanks! Have a good day
100+
https://www.youtube.com/watch?v=iW2biAnq0n8
180101

181102
</details>
182103

183104
---
184105

185-
<details>
186-
<summary>
187-
<h2>📸Flashing</h2>
188-
</summary>
189-
190-
<img src="readme_images/bar.svg" style="width: 100%;" alt="Click to see the source">
191-
192-
[Alternative flashing tutorial for Windows](https://youtu.be/Y0paq_qhG5M?si=YcpNOJzzQu8MJJTb)
193-
194-
**_It is HIGHLY recommended to use the new ifixit tutorial_**
195-
https://www.ifixit.com/Guide/How+to+Install+Custom+Firmware+onto+Car+Thing/178814
196-
197-
Links:
198-
- ~~[image dumps](https://mega.nz/folder/NxNXQCaT#-n1zkoXsJuw-5rQ-ZYzRJw/folder/Ak9FVKxJ)~~
199-
- [New Image Dumps](https://thingify.tools/firmware/P3QZbZIDWnp5m_azQFQqP)
200-
- [superbird-tool](https://github.com/Car-Thing-Hax-Community/superbird-tool)
201-
202-
Process:
203-
- Go to superbird-tool and install it based off your operating system. Come back once you can run `python superbird_tool.py --find_device` and see your Car Thing
204-
- Unplug the Car Thing
205-
- Hold buttons 1 and 4 (the four large top buttons are mapped from left to right) and plug it in.
206-
- Wait a few seconds. If the screen does not turn on, that means you are in boot mode. You can release the buttons
207-
- Run `python superbird_tool.py --burn_mode` to enter burn mode
208-
> Note: This step may say it fails to enter burn mode. This is okay, continue on as if it worked. There is information in the discord as to why this is.
209-
- Download 8.9.2-thinglabs.zip files from Thingify Tools (linked above) and in that same folder (unzip them)
210-
- (Windows only) Download [zadig](https://zadig.akeo.ie/) and install the WinUSB driver for **GX-CHIP** (select it and click "Install Driver")
211-
> Alternatively use **libusbK** if it does not work
212-
> you may have to click "Show All devices" to see it
213-
- Run `python superbird_tool.py --restore_device /path/to/extracted/firmware/folder` (This may take a while)
214-
- After the firmware is flashed, the Car Thing should be ready with ADB enabled. To check, run `adb shell ls -l /usr/share/qt-superbird-app/` and you should see webapp as one of the folders.
215-
- Ensure that `adb devices` works and registers `whateveryouridis device` as one of the options
216-
- Continue setup from [here](#detailed-setup-instructions)
217-
218-
</details>
219-
220-
---
221106

222107
## 📗 Additional Resources
223108

@@ -231,31 +116,6 @@ Process:
231116

232117
> Questions? DM me on discord @riprod
233118
234-
⚠️ *While bricking the Car Thing is extremely difficult - I don't think anyone has done it yet - the possibility is still there. I do not take any responsibility for damages done to the device. Try to use common sense* ⚠️
235-
236-
237-
# Developing Apps
238-
Interested in developing an app? Well here's a great place to start! Make sure you join the DeskThing discord server so I, or anyone else, can help you out!
239-
240-
Start with
241-
```sh
242-
npm create deskthing@latest
243-
```
244-
And follow the prompts to set up the app environment. From there, you can reference:
245-
246-
### [App References](https://github.com/ItsRiprod/deskthing-apps)
247-
These are apps that make the deskthing "firmware" functional! When you use spotify on your deskthing, it's using the spotify app (linked here). What you interact with is driven by the "src/App.tsx"
248-
249-
### [The app-side connector](https://github.com/ItsRiprod/deskthing-app-client)
250-
This is what allows deskthing apps to "function". When you hit the pause button on the spotify app, it makes a request to the deskthing-client which routes your request (through the deskthing-app-client package, source code linked here). This deskthing-app-client request doesn't return a response, instead it listens for events through the deskthing-app-client using the "on" method.
251-
252-
### [The server-side connector](https://github.com/ItsRiprod/deskthing-app-server)
253-
This is what allows the deskthing-server to make custom requests. When the deskthing-server gets a request to pause the current spotify song, it forwards that action through the deskthing-app-server back to the spotify apps "server/index.ts" which can be handled in your app using the deskthing-app-server "on" method to respond to custom requests from the deskthing-client.
254-
255-
### [The client that goes on the Car Thing](https://github.com/ItsRiprod/deskthing-client)
256-
257-
Good luck!
258-
259119
<details>
260120
<summary>
261121
<h2>Action Shots</h2>

0 commit comments

Comments
 (0)