Skip to content

Commit 726330d

Browse files
committed
Update the readme
1 parent 84ab7d4 commit 726330d

File tree

3 files changed

+41
-2
lines changed

3 files changed

+41
-2
lines changed

README.MD

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,44 @@
11
# Resolume Timecode Monitor
22

3-
This project allows multiple people to view the time remaining on the chosen clip.
3+
View the time left for a playing clip on multiple devices.
44

5-
More information coming soon.
5+
![browser demo](demo.png)
6+
_This screenshot is from firefox on linux, but you can even view this on your phone._
7+
8+
![server demo](demo2.jpg)
9+
_This is the server end of things, doesn't need to be run on the same device as Resolume_
10+
11+
## How to use
12+
13+
1. Open _resolume-timecode.exe_ and make sure that all the information in there is set correctly.
14+
2. Click _Start Server_
15+
3. Open your web browser to `http://localhost:8080` (or the IP of the device that's running this app plus `:8080`).
16+
4. Start playing a clip in Resolume.
17+
5. Profit.
18+
19+
## Motivation
20+
21+
When using Resolume for events where longer clips were being played, I found it annoying that the only way to find out
22+
the remaining time was to ask the guy in front of the laptop. So I decided to fix that.
23+
24+
## How it works
25+
26+
Resolume outputs the position of the clip head through OSC, by calculating how much time it took between the one message
27+
and the previous one, it's possible to calculate how long the clip is, and therefore how much time is left.
28+
Due to certain inconsistencies in the way this information is outputted, it's not as simple as it sounds.
29+
30+
For the exact algorithm, check [main.js](https://github.com/chabad360/resolume-timecode/blob/master/main.js).
31+
32+
## Known Issues
33+
34+
- Playing a clip backwards just doesn't work. This is because of the way certain math is done, there is a relatively simple fix
35+
I just haven't gotten to implementing it yet.
36+
- If a clip loops, the counter will stop. This is because I haven't yet figured out a good way to determine that a clip has looped,
37+
without causing other issues.
38+
- Uses 60mb of RAM. Sorry, can't do much about that, at least it's better than a electron app.
39+
40+
## Building
41+
42+
Because this is based on [fyne](https://fyne.io) it requires the use of _cgo_, so make sure you have some CC installed on your system.
43+
44+
Just clone the repo and run `go build github.com/chabad360/resolume-timecode`.

demo.png

105 KB
Loading

demo2.jpg

22.7 KB
Loading

0 commit comments

Comments
 (0)