Skip to content

Commit 3e2d80b

Browse files
Add full browser compatibility README section
1 parent fdcd904 commit 3e2d80b

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,6 @@ Launching and using SwiftSplit is fairly simple, with only three broad steps.
3030
### Connecting to [LiveSplit One](https://one.livesplit.org/)
3131
4. Copy the LiveSplit server URL displayed in SwiftSplit
3232
5. Click "Connect to Server" in LiveSplit One and paste that URL
33-
- Note: SwiftSplit does not work with Safari. Safari doesn't let LiveSplit One connect to the SwiftSplit server, so
34-
LiveSplit will just stall at "Connecting…". The connection has been tested to work in Firefox and Chrome though, so
35-
you can use one of those. If you need to transfer your splits you can download them using the "export" button in
36-
the splits list screen.
3733
- Note: navigating away from the timer screen may make the server button say it isn't connected any more. This is a
3834
bug. You can check that it's still connected with the "LiveSplit clients" field in SwiftSplit, which should read
3935
"1". If that field reads "0", you need to connect. If it reads "2" or higher then you will need to save your splits
@@ -44,10 +40,22 @@ Launching and using SwiftSplit is fairly simple, with only three broad steps.
4440
7. Load the corresponding route JSON in SwiftSplit by either clicking "Load Route" or dragging the `.json` file onto the
4541
"Route" box in SwiftSplit.
4642

43+
## Browser Compatibility
44+
45+
### Safari - Not compatible
46+
Safari doesn't like the way SwiftSplit communicates with LiveSplit One, so LiveSplit stalls when trying to connect.
47+
48+
### Firefox - Mostly compatible
49+
If you only have one display, Firefox will slow down the LiveSplit One tab, causing it to record incorrect times.
50+
If you keep the LiveSplit window open on a second display this isn't an issue.
51+
52+
### Chrome - Compatible
53+
Chrome doesn't seem to have the same optimization as Firefox, which in this case is a good thing. If you're using
54+
Firefox and your splits are coming out wrong, try with Chrome and see if that fixes it.
55+
4756
## Pre-made splits
48-
Pre-made splits and route JSON files for Any% can be found [here](https://github.com/thecodewarrior/SwiftSplit/tree/master/example).
49-
The listed `.lss` files can be imported directly into LiveSplit One and the corresponding `.json` files can be loaded
50-
into SwiftSplit.
57+
Pre-made splits and route JSON files for Any% and the B-sides can be found [here](https://github.com/thecodewarrior/SwiftSplit/tree/master/example).
58+
The `.lss` files can be imported directly into LiveSplit One and the corresponding `.json` files can be loaded into SwiftSplit.
5159

5260
# Route JSON
5361
Routes are configured using a JSON file and use "events" generated by SwiftSplit. They consist of a reset event and a

0 commit comments

Comments
 (0)