splitguides 0.10.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- splitguides/__init__.py +1 -0
- splitguides/__main__.py +15 -0
- splitguides/_version.py +2 -0
- splitguides/build_ui.py +71 -0
- splitguides/exceptions.py +4 -0
- splitguides/hotkeys.py +54 -0
- splitguides/livesplit_client.py +303 -0
- splitguides/note_parser.py +260 -0
- splitguides/server/__init__.py +1 -0
- splitguides/server/__main__.py +58 -0
- splitguides/server/split_server.py +129 -0
- splitguides/settings.py +231 -0
- splitguides/static/desktop.css +146 -0
- splitguides/static/server.css +160 -0
- splitguides/static/streamlistener.js +18 -0
- splitguides/templates/desktop.html +25 -0
- splitguides/templates/server.html +12 -0
- splitguides/ui/__init__.py +0 -0
- splitguides/ui/color.py +50 -0
- splitguides/ui/custom_elements/__init__.py +18 -0
- splitguides/ui/hotkey_manager.py +92 -0
- splitguides/ui/layouts/__init__.py +8 -0
- splitguides/ui/layouts/build/__init__.py +0 -0
- splitguides/ui/layouts/build/main_window.py +61 -0
- splitguides/ui/layouts/build/server_settings.py +349 -0
- splitguides/ui/layouts/build/settings.py +318 -0
- splitguides/ui/layouts/main_window.ui +64 -0
- splitguides/ui/layouts/server_settings.ui +394 -0
- splitguides/ui/layouts/settings.ui +382 -0
- splitguides/ui/main.pyproject +3 -0
- splitguides/ui/main_window.py +492 -0
- splitguides/ui/server_settings_ui.py +191 -0
- splitguides/ui/settings_ui.py +241 -0
- splitguides-0.10.1.dist-info/METADATA +199 -0
- splitguides-0.10.1.dist-info/RECORD +39 -0
- splitguides-0.10.1.dist-info/WHEEL +5 -0
- splitguides-0.10.1.dist-info/entry_points.txt +3 -0
- splitguides-0.10.1.dist-info/licenses/COPYING +674 -0
- splitguides-0.10.1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,241 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import json
|
|
4
|
+
import sys
|
|
5
|
+
from concurrent.futures import ThreadPoolExecutor
|
|
6
|
+
from pathlib import Path
|
|
7
|
+
|
|
8
|
+
from PySide6.QtWidgets import QDialog, QColorDialog, QFileDialog
|
|
9
|
+
from PySide6.QtCore import QRegularExpression, Slot
|
|
10
|
+
from PySide6.QtGui import (
|
|
11
|
+
QIntValidator,
|
|
12
|
+
QDoubleValidator,
|
|
13
|
+
QRegularExpressionValidator,
|
|
14
|
+
)
|
|
15
|
+
|
|
16
|
+
from ..settings import DesktopSettings
|
|
17
|
+
from .color import rgba_to_qcolor, qcolor_to_rgba
|
|
18
|
+
from .hotkey_manager import HotkeyManager
|
|
19
|
+
from .layouts import Ui_Settings
|
|
20
|
+
from ..hotkeys import Hotkey
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
class SettingsDialog(QDialog):
|
|
24
|
+
def __init__(
|
|
25
|
+
self,
|
|
26
|
+
parent,
|
|
27
|
+
settings: DesktopSettings,
|
|
28
|
+
hotkey_manager: HotkeyManager | None,
|
|
29
|
+
):
|
|
30
|
+
super().__init__(parent=parent)
|
|
31
|
+
self.ui = Ui_Settings()
|
|
32
|
+
self.ui.setupUi(self)
|
|
33
|
+
|
|
34
|
+
self.hotkey_manager = hotkey_manager
|
|
35
|
+
self.nextsplitkey = None
|
|
36
|
+
self.previoussplitkey = None
|
|
37
|
+
|
|
38
|
+
self.settings = settings
|
|
39
|
+
self.temp_html_path = self.settings.full_template_path
|
|
40
|
+
self.temp_css_path = self.settings.full_css_path
|
|
41
|
+
|
|
42
|
+
self.setup_validators()
|
|
43
|
+
self.fill_settings()
|
|
44
|
+
|
|
45
|
+
self.ui.textcolor_button.clicked.connect(self.font_color_dialog)
|
|
46
|
+
self.ui.bgcolor_button.clicked.connect(self.bg_color_dialog)
|
|
47
|
+
self.ui.htmltemplate_button.clicked.connect(self.html_template_dialog)
|
|
48
|
+
self.ui.css_button.clicked.connect(self.css_dialog)
|
|
49
|
+
|
|
50
|
+
if sys.platform == "win32":
|
|
51
|
+
self.ui.nextsplitkey_button.clicked.connect(self.get_increase_hotkey)
|
|
52
|
+
self.ui.previoussplitkey_button.clicked.connect(self.get_decrease_hotkey)
|
|
53
|
+
else:
|
|
54
|
+
self.ui.nextsplitkey_button.setDisabled(True)
|
|
55
|
+
self.ui.previoussplitkey_button.setDisabled(True)
|
|
56
|
+
|
|
57
|
+
self.pool = ThreadPoolExecutor(max_workers=1)
|
|
58
|
+
|
|
59
|
+
def setup_validators(self):
|
|
60
|
+
color_re = QRegularExpression(r"#([A-Fa-f0-9]{8}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})")
|
|
61
|
+
color_validator = QRegularExpressionValidator(color_re, None)
|
|
62
|
+
self.ui.port_edit.setValidator(QIntValidator(1024, 65535, None))
|
|
63
|
+
# 255 splits seems like a lot
|
|
64
|
+
self.ui.previous_edit.setValidator(QIntValidator(0, 255, None))
|
|
65
|
+
self.ui.advance_edit.setValidator(QIntValidator(0, 255, None))
|
|
66
|
+
# I don't know why you'd set a font size of 10k but sure why not
|
|
67
|
+
self.ui.fontsize_edit.setValidator(QDoubleValidator(0.0, 10000.0, 2, None))
|
|
68
|
+
self.ui.textcolor_edit.setValidator(color_validator)
|
|
69
|
+
self.ui.bgcolor_edit.setValidator(color_validator)
|
|
70
|
+
|
|
71
|
+
def fill_settings(self):
|
|
72
|
+
self.ui.hostname_edit.setText(self.settings.hostname)
|
|
73
|
+
self.ui.port_edit.setText(str(self.settings.port))
|
|
74
|
+
self.ui.previous_edit.setText(str(self.settings.previous_splits))
|
|
75
|
+
self.ui.advance_edit.setText(str(self.settings.next_splits))
|
|
76
|
+
self.ui.separator_edit.setText(self.settings.split_separator)
|
|
77
|
+
self.ui.fontsize_edit.setText(str(self.settings.font_size))
|
|
78
|
+
self.ui.textcolor_edit.setText(self.settings.font_color)
|
|
79
|
+
self.ui.bgcolor_edit.setText(self.settings.background_color)
|
|
80
|
+
self.ui.htmltemplate_edit.setText(str(self.settings.html_template_file))
|
|
81
|
+
self.ui.css_edit.setText(str(self.settings.css_file))
|
|
82
|
+
|
|
83
|
+
if self.settings.increase_offset_hotkey:
|
|
84
|
+
self.ui.nextsplitkey_edit.setText(self.settings.increase_offset_hotkey.name)
|
|
85
|
+
if self.settings.decrease_offset_hotkey:
|
|
86
|
+
self.ui.previoussplitkey_edit.setText(
|
|
87
|
+
self.settings.decrease_offset_hotkey.name
|
|
88
|
+
)
|
|
89
|
+
self.nextsplitkey = self.settings.increase_offset_hotkey
|
|
90
|
+
self.previoussplitkey = self.settings.decrease_offset_hotkey
|
|
91
|
+
|
|
92
|
+
def store_settings(self):
|
|
93
|
+
self.settings.hostname = self.ui.hostname_edit.text()
|
|
94
|
+
self.settings.port = int(self.ui.port_edit.text())
|
|
95
|
+
self.settings.previous_splits = int(self.ui.previous_edit.text())
|
|
96
|
+
self.settings.next_splits = int(self.ui.advance_edit.text())
|
|
97
|
+
self.settings.split_separator = self.ui.separator_edit.text()
|
|
98
|
+
self.settings.font_size = float(self.ui.fontsize_edit.text())
|
|
99
|
+
self.settings.font_color = self.ui.textcolor_edit.text()
|
|
100
|
+
self.settings.background_color = self.ui.bgcolor_edit.text()
|
|
101
|
+
|
|
102
|
+
self.settings.increase_offset_hotkey = self.nextsplitkey
|
|
103
|
+
self.settings.decrease_offset_hotkey = self.previoussplitkey
|
|
104
|
+
|
|
105
|
+
# Paths get stored in temporary variables
|
|
106
|
+
self.settings.html_template_folder = Path(self.temp_html_path).parent
|
|
107
|
+
self.settings.html_template_file = Path(self.temp_html_path).name
|
|
108
|
+
|
|
109
|
+
self.settings.css_folder = Path(self.temp_css_path).parent
|
|
110
|
+
self.settings.css_file = Path(self.temp_css_path).name
|
|
111
|
+
|
|
112
|
+
def font_color_dialog(self):
|
|
113
|
+
"""
|
|
114
|
+
Pop up a color dialog for the text color.
|
|
115
|
+
"""
|
|
116
|
+
color = QColorDialog.getColor(
|
|
117
|
+
rgba_to_qcolor(self.ui.textcolor_edit.text()),
|
|
118
|
+
parent=self,
|
|
119
|
+
title="Text Color",
|
|
120
|
+
options=QColorDialog.ColorDialogOption.ShowAlphaChannel,
|
|
121
|
+
)
|
|
122
|
+
if color.isValid():
|
|
123
|
+
self.ui.textcolor_edit.setText(qcolor_to_rgba(color))
|
|
124
|
+
|
|
125
|
+
def bg_color_dialog(self):
|
|
126
|
+
"""
|
|
127
|
+
Pop up a color dialog for the background color.
|
|
128
|
+
"""
|
|
129
|
+
color = QColorDialog.getColor(
|
|
130
|
+
rgba_to_qcolor(self.ui.bgcolor_edit.text()),
|
|
131
|
+
parent=self,
|
|
132
|
+
title="Background Color",
|
|
133
|
+
options=QColorDialog.ColorDialogOption.ShowAlphaChannel,
|
|
134
|
+
)
|
|
135
|
+
if color.isValid():
|
|
136
|
+
self.ui.bgcolor_edit.setText(qcolor_to_rgba(color))
|
|
137
|
+
|
|
138
|
+
def html_template_dialog(self):
|
|
139
|
+
htmlfile, _ = QFileDialog.getOpenFileName(
|
|
140
|
+
self,
|
|
141
|
+
"Select Template File",
|
|
142
|
+
str(self.settings.html_template_folder),
|
|
143
|
+
"html templates (*.html);;All Files (*.*)",
|
|
144
|
+
)
|
|
145
|
+
|
|
146
|
+
if htmlfile:
|
|
147
|
+
self.temp_html_path = htmlfile
|
|
148
|
+
self.ui.htmltemplate_edit.setText(Path(htmlfile).name)
|
|
149
|
+
|
|
150
|
+
def css_dialog(self):
|
|
151
|
+
cssfile, _ = QFileDialog.getOpenFileName(
|
|
152
|
+
self,
|
|
153
|
+
"Select Template File",
|
|
154
|
+
str(self.settings.css_folder),
|
|
155
|
+
"css files (*.css);;All Files (*.*)",
|
|
156
|
+
)
|
|
157
|
+
|
|
158
|
+
if cssfile:
|
|
159
|
+
self.temp_css_path = cssfile
|
|
160
|
+
self.ui.css_edit.setText(Path(cssfile).name)
|
|
161
|
+
|
|
162
|
+
def get_increase_hotkey(self):
|
|
163
|
+
"""Get a hotkey to use to increase the split offset"""
|
|
164
|
+
if self.hotkey_manager is not None:
|
|
165
|
+
# First set the buttons dialog and disable the interface
|
|
166
|
+
self.ui.nextsplitkey_button.setText("Listening...")
|
|
167
|
+
self.setEnabled(False)
|
|
168
|
+
|
|
169
|
+
hotkey_manager = self.hotkey_manager
|
|
170
|
+
fn = lambda: hotkey_manager.select_input(self.return_increase_hotkey)
|
|
171
|
+
self.pool.submit(fn)
|
|
172
|
+
|
|
173
|
+
@Slot(str)
|
|
174
|
+
def return_increase_hotkey(self, hotkey=None):
|
|
175
|
+
"""
|
|
176
|
+
Get the returned hotkey or cancel if no hotkey is returned
|
|
177
|
+
:param hotkey:
|
|
178
|
+
"""
|
|
179
|
+
if self.hotkey_manager is not None:
|
|
180
|
+
if hotkey:
|
|
181
|
+
hotkey = Hotkey(**json.loads(hotkey))
|
|
182
|
+
self.ui.nextsplitkey_edit.setText(hotkey.name)
|
|
183
|
+
self.nextsplitkey = hotkey
|
|
184
|
+
else:
|
|
185
|
+
self.ui.nextsplitkey_edit.setText("")
|
|
186
|
+
self.nextsplitkey = None
|
|
187
|
+
|
|
188
|
+
self.ui.nextsplitkey_button.setText("Select")
|
|
189
|
+
|
|
190
|
+
# Unbind next split key if both are equal
|
|
191
|
+
if hotkey and self.ui.previoussplitkey_edit.text() == hotkey.name:
|
|
192
|
+
self.ui.previoussplitkey_edit.setText("")
|
|
193
|
+
self.previoussplitkey = None
|
|
194
|
+
|
|
195
|
+
# Disconnect the hotkey signal from this function
|
|
196
|
+
self.hotkey_manager.hotkey_signal.disconnect(self.return_increase_hotkey)
|
|
197
|
+
|
|
198
|
+
self.setEnabled(True)
|
|
199
|
+
|
|
200
|
+
def get_decrease_hotkey(self):
|
|
201
|
+
"""Get a hotkey to use to decrease the split offset"""
|
|
202
|
+
if self.hotkey_manager is not None:
|
|
203
|
+
self.ui.previoussplitkey_button.setText("Listening...")
|
|
204
|
+
self.setEnabled(False)
|
|
205
|
+
|
|
206
|
+
hotkey_manager = self.hotkey_manager
|
|
207
|
+
fn = lambda: hotkey_manager.select_input(self.return_decrease_hotkey)
|
|
208
|
+
self.pool.submit(fn)
|
|
209
|
+
|
|
210
|
+
@Slot(str)
|
|
211
|
+
def return_decrease_hotkey(self, hotkey=None):
|
|
212
|
+
"""
|
|
213
|
+
Get the returned hotkey or cancel if no hotkey is returned
|
|
214
|
+
:param hotkey:
|
|
215
|
+
"""
|
|
216
|
+
if self.hotkey_manager is not None:
|
|
217
|
+
if hotkey:
|
|
218
|
+
hotkey = Hotkey(**json.loads(hotkey))
|
|
219
|
+
self.ui.previoussplitkey_edit.setText(hotkey.name)
|
|
220
|
+
self.previoussplitkey = hotkey
|
|
221
|
+
else:
|
|
222
|
+
self.ui.previoussplitkey_edit.setText("")
|
|
223
|
+
self.previoussplitkey = None
|
|
224
|
+
self.ui.previoussplitkey_button.setText("Select")
|
|
225
|
+
|
|
226
|
+
# Unbind next split key if both are equal
|
|
227
|
+
if hotkey and self.ui.nextsplitkey_edit.text() == hotkey.name:
|
|
228
|
+
self.ui.nextsplitkey_edit.setText("")
|
|
229
|
+
self.nextsplitkey = None
|
|
230
|
+
|
|
231
|
+
# Disconnect the hotkey signal from this function
|
|
232
|
+
self.hotkey_manager.hotkey_signal.disconnect(self.return_decrease_hotkey)
|
|
233
|
+
|
|
234
|
+
self.setEnabled(True)
|
|
235
|
+
|
|
236
|
+
def accept(self):
|
|
237
|
+
"""If the dialog is accepted save the settings"""
|
|
238
|
+
# Normal cleanup
|
|
239
|
+
super().accept()
|
|
240
|
+
# Store the settings in the settings object
|
|
241
|
+
self.store_settings()
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: splitguides
|
|
3
|
+
Version: 0.10.1
|
|
4
|
+
Summary: A tool for speedrunners to display notes that advance automatically with their splits in Livesplit.
|
|
5
|
+
Author: David C Ellis
|
|
6
|
+
License-Expression: GPL-3.0-or-later
|
|
7
|
+
Classifier: Development Status :: 4 - Beta
|
|
8
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
9
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
12
|
+
Classifier: Topic :: Games/Entertainment
|
|
13
|
+
Requires-Python: >=3.12
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
License-File: COPYING
|
|
16
|
+
Requires-Dist: pyside6~=6.9
|
|
17
|
+
Requires-Dist: jinja2~=3.1
|
|
18
|
+
Requires-Dist: bleach[css]==6.0
|
|
19
|
+
Requires-Dist: flask~=3.0
|
|
20
|
+
Requires-Dist: markdown~=3.6
|
|
21
|
+
Requires-Dist: keyboard~=0.13.5
|
|
22
|
+
Requires-Dist: ducktools-classbuilder>=0.7.4
|
|
23
|
+
Requires-Dist: waitress~=3.0
|
|
24
|
+
Dynamic: license-file
|
|
25
|
+
|
|
26
|
+
# SplitGuides #
|
|
27
|
+
|
|
28
|
+
**Speedrun notes display for Livesplit with markdown and html formatting**
|
|
29
|
+
|
|
30
|
+
SplitGuides is an application for displaying speedrun notes in sync with livesplit.
|
|
31
|
+
Requires *livesplit server* to be running.
|
|
32
|
+
|
|
33
|
+
Includes a server version for rendering notes in browsers on another device
|
|
34
|
+
(eg: tablet/phone).
|
|
35
|
+
|
|
36
|
+
## Install/Setup ##
|
|
37
|
+
|
|
38
|
+
1. Download `SplitGuides_v<VERSION>.zip` from the
|
|
39
|
+
[**releases page**](https://github.com/DavidCEllis/SplitGuides/releases)
|
|
40
|
+
Where `<VERSION>` is the version number of the release.
|
|
41
|
+
2. Extract anywhere and run *splitguides.exe*
|
|
42
|
+
|
|
43
|
+
## Usage ##
|
|
44
|
+
|
|
45
|
+
1. Connect with livesplit by starting the livesplit server component selecting
|
|
46
|
+
'Control' and 'Start TCP Server' in livesplit.
|
|
47
|
+
2. Right click in the splitguides window and select 'Open Notes' and find the text file
|
|
48
|
+
containing the notes you wish to use.
|
|
49
|
+
3. Some configuration is available from the settings dialog.
|
|
50
|
+
|
|
51
|
+
Plain text formatting works the same way as SplitNotes.
|
|
52
|
+
Notes made for that should function fine in SplitGuides.
|
|
53
|
+
|
|
54
|
+
Additionally Markdown and HTML formatted notes are supported.
|
|
55
|
+
These will be interpreted based on file extension (.md, .txt or .html).
|
|
56
|
+
Markdown and plain text formatted notes will automatically have line breaks
|
|
57
|
+
inserted in between lines.
|
|
58
|
+
|
|
59
|
+
1. Comment lines still use square brackets.
|
|
60
|
+
2. By default splits will break on newlines, multiple newlines are ignored in this case.
|
|
61
|
+
* If a split separator is given, newlines are left as in the input to the
|
|
62
|
+
markdown/html processors.
|
|
63
|
+
|
|
64
|
+
### If the notes are not advancing ###
|
|
65
|
+
|
|
66
|
+
If the text at the bottom says "Trying to connect to Livesplit." make sure that the TCP server
|
|
67
|
+
is running.
|
|
68
|
+
|
|
69
|
+
If that doesn't work, check in the Splitguides settings (from the right click menu)
|
|
70
|
+
* "Livesplit Server Hostname" should be `localhost`
|
|
71
|
+
* "Livesplit Server Port" should match the value for "Server Port" in Livesplit's own settings
|
|
72
|
+
* This is `16834` by default
|
|
73
|
+
|
|
74
|
+
## SplitGuides Server ##
|
|
75
|
+
|
|
76
|
+
Included is a separate server version which launches a (local) webhost so you can view
|
|
77
|
+
the notes on another device on your local network.
|
|
78
|
+
|
|
79
|
+
Launch **splitguides_server.exe** to start the service. A settings dialog will appear
|
|
80
|
+
so you can customise this version separately from the desktop version. After asking
|
|
81
|
+
for the notes file the server will launch serving those notes and will update
|
|
82
|
+
automatically as you split.
|
|
83
|
+
|
|
84
|
+
If the hostname and port defaults aren't usable you can edit them
|
|
85
|
+
in the settings dialog.
|
|
86
|
+
|
|
87
|
+
This version is intended for people doing runs on a single monitor so the notes can be
|
|
88
|
+
displayed on another device (a tablet or phone for example). Just connect to the host
|
|
89
|
+
and port given in a web browser.
|
|
90
|
+
|
|
91
|
+
## Configuration ##
|
|
92
|
+
|
|
93
|
+
Configuration Options:
|
|
94
|
+
|
|
95
|
+
* Livesplit server hostname and port
|
|
96
|
+
* Display previous/next splits
|
|
97
|
+
* Split separator (leave blank for empty line separator)
|
|
98
|
+
* Font Size
|
|
99
|
+
* Text and Background Colour
|
|
100
|
+
* Alternative template HTML and CSS files
|
|
101
|
+
* Jinja2 templating is used for the HTML, use the included file as a guide
|
|
102
|
+
* Allows for further customising of the appearance if desired
|
|
103
|
+
* Hotkeys to offset the notes from the splits (not available in splitnotes server)
|
|
104
|
+
* This allows for some adjustment if the notes have ended up in the wrong place
|
|
105
|
+
relative to the splits.
|
|
106
|
+
* Server hostname and port (server only)
|
|
107
|
+
* This should be your local machine name on the network and an open port to
|
|
108
|
+
connect to from the device you wish to use to display the notes.
|
|
109
|
+
|
|
110
|
+
## Example Notes ##
|
|
111
|
+
|
|
112
|
+
### Source ###
|
|
113
|
+
|
|
114
|
+
```markdown
|
|
115
|
+
# Dark Souls Remastered - SL1 NWW #
|
|
116
|
+
## Asylum ##
|
|
117
|
+
* Start Pyro + MK
|
|
118
|
+
* Keep Hilt
|
|
119
|
+
* Get Axe/Estus/Flame
|
|
120
|
+
* Asylum Skip
|
|
121
|
+
* Pick up a 200 soul
|
|
122
|
+
* Dupe the soul 99x
|
|
123
|
+
* Leave
|
|
124
|
+
|
|
125
|
+
## Laurentius ##
|
|
126
|
+
* Pick up the firebombs
|
|
127
|
+
* Grab the 200 soul
|
|
128
|
+
* Ladder glitch
|
|
129
|
+
* Buy
|
|
130
|
+
* Max wooden arrows
|
|
131
|
+
* 4 blooming moss
|
|
132
|
+
* 2 throwing knifes
|
|
133
|
+
* Max (25) homeward bones
|
|
134
|
+
* Free Laurentius
|
|
135
|
+
* Darksign
|
|
136
|
+
|
|
137
|
+
## GCS ##
|
|
138
|
+
* Dupe souls with the arrows
|
|
139
|
+
* Ascend flame to +15
|
|
140
|
+
* Buy flash sweat, combustion, fire orb
|
|
141
|
+
* Valley Run
|
|
142
|
+
* Get DCS/RTSR
|
|
143
|
+
* Upwarp
|
|
144
|
+
* Get GCS
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Result ###
|
|
148
|
+
|
|
149
|
+
On Desktop:
|
|
150
|
+
|
|
151
|
+

|
|
152
|
+
|
|
153
|
+
Via Splitnotes Server on Tablet:
|
|
154
|
+
|
|
155
|
+

|
|
156
|
+
|
|
157
|
+
## Development ##
|
|
158
|
+
|
|
159
|
+
### Building the project environment ###
|
|
160
|
+
|
|
161
|
+
Once you have forked and cloned the repository the simplest way to setup the environment is to use
|
|
162
|
+
`uv`.
|
|
163
|
+
|
|
164
|
+
With the source folder as your current working directory:
|
|
165
|
+
|
|
166
|
+
```cmd
|
|
167
|
+
uv run pytest
|
|
168
|
+
uv run splitguides
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
Without `uv` you will need to manually set up and activate the python environment.
|
|
172
|
+
|
|
173
|
+
On Windows with the `py` command included with python.org installs:
|
|
174
|
+
|
|
175
|
+
```cmd
|
|
176
|
+
py -3.13 -m venv .venv
|
|
177
|
+
.venv\Scripts\activate
|
|
178
|
+
python -m pip install -e . --group dev
|
|
179
|
+
pytest
|
|
180
|
+
splitguides
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
## Contributions ##
|
|
184
|
+
|
|
185
|
+
* Transparent background support added by [@AlexKnauth](https://github.com/AlexKnauth)
|
|
186
|
+
|
|
187
|
+
## Dependencies ##
|
|
188
|
+
* pyside6 - QT Gui Bindings
|
|
189
|
+
* jinja2 - Templating for the notes page
|
|
190
|
+
* bleach - Cleaning HTML to help protect if someone decided to make notes with a malicious script
|
|
191
|
+
* flask - Handling the server version
|
|
192
|
+
* markdown - Converting markdown to html for rendering
|
|
193
|
+
* keyboard - Global hotkeys to advance/reverse note offset to splits
|
|
194
|
+
* waitress - wsgi server for splitguides server
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
Inspired by (but otherwise unassociated with) the original splitnotes:
|
|
199
|
+
https://github.com/joeloskarsson/SplitNotes
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
splitguides/__init__.py,sha256=hC07juYOcjFHkUBikKLUAq2HScs6NzHhNKEgP66ToRs,50
|
|
2
|
+
splitguides/__main__.py,sha256=JdQTT1KVioObaN6QZCMo3Uq0LUz4raC33nc0lyktvYs,290
|
|
3
|
+
splitguides/_version.py,sha256=YnrHKzGXfP28LjSdPx-GW0IjBFg2HdMG-V3-G61jrS8,56
|
|
4
|
+
splitguides/build_ui.py,sha256=c-hY-CzsnPx_XnOGagDUJYMBz8IYODt0YSNDYUU-6Tw,2130
|
|
5
|
+
splitguides/exceptions.py,sha256=4GH41K_5NwY1R5T5tz22L-rku5GTUBGBaK6gXPiXiOo,118
|
|
6
|
+
splitguides/hotkeys.py,sha256=h9gFJfrzOojcH2ITgG0DpJXwCw42gVISXHyGkiBaJD4,1625
|
|
7
|
+
splitguides/livesplit_client.py,sha256=TNqzgRroZ1dNqSzDtG94CdQRtf5owWdOvH_ETUu-R5E,8473
|
|
8
|
+
splitguides/note_parser.py,sha256=DpPfM8XWuL_djcGtA6CA8-4GbPpBX6yh5F_EinrjO0I,7731
|
|
9
|
+
splitguides/settings.py,sha256=DvVi1VNFQdV33xNEXirmzpVVv8XOjCfP8IqgN4E8Mbw,7304
|
|
10
|
+
splitguides/server/__init__.py,sha256=UuTlM-wtesbpQV3H7AcnOc-8refSr1iGP_M_8TTUVko,84
|
|
11
|
+
splitguides/server/__main__.py,sha256=7KYuyytT92SAcK88-gB1HSgZeD5GIEdlqX7gpncPUjo,1696
|
|
12
|
+
splitguides/server/split_server.py,sha256=87qRU33PdyWOYr3kdYqAH9-yVv-pyqx-yV5aSvqmC8g,4060
|
|
13
|
+
splitguides/static/desktop.css,sha256=Dq5uT_QVz5wR9OJLLwEhfoGqHZifb_3gt-Ug7S4Sevk,3786
|
|
14
|
+
splitguides/static/server.css,sha256=OhhN8DAHeJ4KJPt9WwXHqvAY6N6Twcg7dn7UHNBbs_8,4036
|
|
15
|
+
splitguides/static/streamlistener.js,sha256=x5Kb6e2qLEQCUYK9TG8Xnep4jgJniAp2rloAraxW4dg,420
|
|
16
|
+
splitguides/templates/desktop.html,sha256=7V93jeASAB0L7rZXk2ig_ZKejWI-ofm_Kti_6ZmjgWA,469
|
|
17
|
+
splitguides/templates/server.html,sha256=8sYPMh08lNA78VHNge4pG3iM5fLGpPT-RKELsimx0eM,358
|
|
18
|
+
splitguides/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
19
|
+
splitguides/ui/color.py,sha256=uJPxu2posZfr55hhMo9i-KsbVqP3Eirm2kLj8it9Dhg,1242
|
|
20
|
+
splitguides/ui/hotkey_manager.py,sha256=JbjqMf006xidtwX8mg-knfBa0eJnNudlMd4eRegWHro,2986
|
|
21
|
+
splitguides/ui/main.pyproject,sha256=Xld0rbeGntRX8-9Wl8JfygvF4Y-SvNgl3n79e-Gx30s,134
|
|
22
|
+
splitguides/ui/main_window.py,sha256=cjo6io1L4JcseOt7EF2D3lEDi3v30WdaKynMeZq8CUc,18225
|
|
23
|
+
splitguides/ui/server_settings_ui.py,sha256=p99Dt5QJFQO0jcKoudRC1STA9DpFRYGVU14MQdF5krA,7777
|
|
24
|
+
splitguides/ui/settings_ui.py,sha256=fHSGDzQDHBFL_lzR2k6ZgklmY1Y_88D7uXe9zsgidMY,9734
|
|
25
|
+
splitguides/ui/custom_elements/__init__.py,sha256=v_B3qBX95D2rDSc8eJO1BiAXPEc_q00-k1uWipnlHqE,692
|
|
26
|
+
splitguides/ui/layouts/__init__.py,sha256=w_eetRYpyf5h-5M35gD_hqdyMsDw2DhzARy7HHUio-I,290
|
|
27
|
+
splitguides/ui/layouts/main_window.ui,sha256=XqY7eAG-k6loVN3m-Br37RRs_aegzZjL8UXOxcD8n3w,1503
|
|
28
|
+
splitguides/ui/layouts/server_settings.ui,sha256=QhGWnQ74tr3SbFlRYWFZl1RJEr9Obl224dmYZR-xuWo,11558
|
|
29
|
+
splitguides/ui/layouts/settings.ui,sha256=wVbkBzSWY2I7IEpBaGO7Arjm0GuKn3lGivJ1gQV6tzU,10899
|
|
30
|
+
splitguides/ui/layouts/build/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
31
|
+
splitguides/ui/layouts/build/main_window.py,sha256=9NDDTTSrUTfH8yac09cDF_5INqz03ryeRoZGQtXJyx4,2465
|
|
32
|
+
splitguides/ui/layouts/build/server_settings.py,sha256=0qzr2LGjodLQ_ntSPOyfEBWvi_OvE-5YBlJoxbn1zi4,17042
|
|
33
|
+
splitguides/ui/layouts/build/settings.py,sha256=9GTjvSYuhRJu2FyIOyC-awdMQtG96nVxm9D002OBJyE,14753
|
|
34
|
+
splitguides-0.10.1.dist-info/licenses/COPYING,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
|
|
35
|
+
splitguides-0.10.1.dist-info/METADATA,sha256=_0LGKJ92-zWCBcR11nB7Rt1yuKdSFCE5bzt-h1X7JYY,6465
|
|
36
|
+
splitguides-0.10.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
37
|
+
splitguides-0.10.1.dist-info/entry_points.txt,sha256=0GRY9_La9mnGsmLGdtpG63hpkpfBDFQIdFjpSaMWSvw,114
|
|
38
|
+
splitguides-0.10.1.dist-info/top_level.txt,sha256=18UiD1wrq93wizPvGtuYIsbAsziKeBjoEGZpVxcfxgY,12
|
|
39
|
+
splitguides-0.10.1.dist-info/RECORD,,
|