diff --git a/application/app.py b/application/app.py index 2708ef3..35efb3f 100644 --- a/application/app.py +++ b/application/app.py @@ -1,7 +1,7 @@ import sys from PySide2.QtWidgets import QApplication -from splitnotes2.ui.main_window import MainWindow +from splitguides.ui.main_window import MainWindow if __name__ == "__main__": app = QApplication(sys.argv) diff --git a/application/app_server.py b/application/app_server.py index eac918c..dd18926 100644 --- a/application/app_server.py +++ b/application/app_server.py @@ -1,4 +1,4 @@ -from splitnotes2.server import app, get_notes, settings +from splitguides.server import app, get_notes, settings import flask.cli as cli # Stop flask from giving users an unhelpful warning. @@ -9,7 +9,7 @@ def launch(): get_notes() # Sets internal 'notes' and 'notefile' variables print( - "This server version of Splitnotes2 allows you view splitnotes via a browser window " + "This server version of SplitGuides allows you view notes via a browser window " "and should work across a local network.\n" "It is not intended to be used over the internet and as such is not based on a " "production server." diff --git a/application/setup.py b/application/setup.py index 994976c..5ecd5a2 100644 --- a/application/setup.py +++ b/application/setup.py @@ -8,8 +8,8 @@ from cx_Freeze import setup, Executable base_path = Path(__file__).resolve().parents[1] -templates = str(base_path / "src" / "splitnotes2" / "templates") -static_folder = str(base_path / "src" / "splitnotes2" / "static") +templates = str(base_path / "src" / "splitguides" / "templates") +static_folder = str(base_path / "src" / "splitguides" / "static") icon_file = str(base_path / "resources" / "logo_alpha.ico") icon_png = str(base_path / "resources" / "logo_alpha.png") @@ -34,13 +34,13 @@ } executables = [ - Executable("app.py", base=base, target_name="splitnotes2", icon=icon_file), - Executable("app_server.py", target_name="splitnotes2_server", icon=icon_file), + Executable("app.py", base=base, target_name="splitguides", icon=icon_file), + Executable("app_server.py", target_name="splitguides_server", icon=icon_file), ] setup( - name="splitnotes2", - version="0.6.0", + name="splitguides", + version="0.7.0", description="Speedrun notes tool with HTML rendering", options=options, executables=executables, diff --git a/readme.md b/readme.md index 7679333..c0163d0 100644 --- a/readme.md +++ b/readme.md @@ -1,8 +1,8 @@ -# SplitNotes 2 # +# SplitGuides # **Speedrun notes with markdown and html formatting** -SplitNotes2 is an application for displaying speedrun notes in sync with livesplit. +SplitGuides is an application for displaying speedrun notes in sync with livesplit. Requires *livesplit server* to be running. There is now a server version included to allow reading from a browser on another device. @@ -10,20 +10,20 @@ There is now a server version included to allow reading from a browser on anothe ## Install/Setup ## 1. Under the Livesplit layout editor add 'LiveSplit Server' (listed under 'control') -2. Download SplitNotes2 from the [**releases page**](https://github.com/DavidCEllis/SplitNotes-2/releases) -3. Extract anywhere and run *splitnotes2.exe* +2. Download SplitGuides from the [**releases page**](https://github.com/DavidCEllis/SplitGuides/releases) +3. Extract anywhere and run *splitguides.exe* ## Usage ## 1. Connect with livesplit by starting the livesplit server component selecting 'Control' and 'Start Server' -2. Right click in the splitnotes window and select 'Open Notes' and find the text file +2. Right click in the splitguides window and select 'Open Notes' and find the text file containing the notes you wish to use. -The formatting for notes basically follows the format used by the original SplitNotes -with some additional enhancements and exceptions. +Plain text formatting works the same way as SplitNotes. +Notes made for that should function fine in SplitGuides. -Markdown and HTML formatted notes are supported. +Additionally Markdown and HTML formatted notes are supported. These will be interpreted based on file extension (.md, .txt or .html). Markdown and plain text formatted notes will automatically have line breaks inserted in between lines. @@ -32,10 +32,10 @@ inserted in between lines. 2. By default splits will break on newlines, multiple newlines are ignored in this case. 3. The rendering is done as HTML so HTML formatting can be used. -## splitnotes2_server.exe ## +## splitguides_server.exe ## -Now included is a server version which launches a (local) webhost so you can view the splitnotes -on another device on your local network. Launch splitnotes2_server.exe to start the service. +Now included is a server version which launches a (local) webhost so you can view the notes +on another device on your local network. Launch splitguides_server.exe to start the service. If the hostname and port defaults aren't usable you can set them by editing server_hostname and server_port in settings.json. There is no dialog for editing these settings yet. @@ -77,7 +77,7 @@ and server_port in settings.json. There is no dialog for editing these settings #### Result #### -![Image of splitnotes rendering](resources/demo_notes_md.png) +![Image of splitguides rendering](resources/demo_notes_md.png) ## Configuration ## @@ -102,5 +102,3 @@ The settings page offers some customisation and connection settings including: --- Inspired by (but otherwise unassociated with) the original splitnotes: https://github.com/joeloskarsson/SplitNotes - -[*] approximately 19x larger in file size :) (Mostly Qt and PySide2) diff --git a/setup.py b/setup.py index 8da4da8..bedf08b 100644 --- a/setup.py +++ b/setup.py @@ -1,11 +1,11 @@ from setuptools import setup, find_packages -__version__ = "0.6.1" +__version__ = "0.7.0" __author__ = "DavidCEllis" setup( - name="splitnotes2", + name="splitguides", version=__version__, packages=find_packages("src"), url="", diff --git a/src/splitnotes2/__init__.py b/src/splitguides/__init__.py similarity index 100% rename from src/splitnotes2/__init__.py rename to src/splitguides/__init__.py diff --git a/src/splitnotes2/hotkeys/__init__.py b/src/splitguides/hotkeys/__init__.py similarity index 100% rename from src/splitnotes2/hotkeys/__init__.py rename to src/splitguides/hotkeys/__init__.py diff --git a/src/splitnotes2/hotkeys/keyboard_fixer.py b/src/splitguides/hotkeys/keyboard_fixer.py similarity index 100% rename from src/splitnotes2/hotkeys/keyboard_fixer.py rename to src/splitguides/hotkeys/keyboard_fixer.py diff --git a/src/splitnotes2/livesplit_client/__init__.py b/src/splitguides/livesplit_client/__init__.py similarity index 100% rename from src/splitnotes2/livesplit_client/__init__.py rename to src/splitguides/livesplit_client/__init__.py diff --git a/src/splitnotes2/livesplit_client/messaging.py b/src/splitguides/livesplit_client/messaging.py similarity index 100% rename from src/splitnotes2/livesplit_client/messaging.py rename to src/splitguides/livesplit_client/messaging.py diff --git a/src/splitnotes2/livesplit_client/networking.py b/src/splitguides/livesplit_client/networking.py similarity index 100% rename from src/splitnotes2/livesplit_client/networking.py rename to src/splitguides/livesplit_client/networking.py diff --git a/src/splitnotes2/note_parser.py b/src/splitguides/note_parser.py similarity index 99% rename from src/splitnotes2/note_parser.py rename to src/splitguides/note_parser.py index bf8521a..5605bd8 100644 --- a/src/splitnotes2/note_parser.py +++ b/src/splitguides/note_parser.py @@ -59,7 +59,7 @@ class Notes: """ - Class to handle splitnotes and formatting + Class to handle notes and formatting Processing order is: Input -> Strip Comment lines (delimited by [ ]) diff --git a/src/splitnotes2/server/__init__.py b/src/splitguides/server/__init__.py similarity index 100% rename from src/splitnotes2/server/__init__.py rename to src/splitguides/server/__init__.py diff --git a/src/splitnotes2/server/split_server.py b/src/splitguides/server/split_server.py similarity index 99% rename from src/splitnotes2/server/split_server.py rename to src/splitguides/server/split_server.py index 65a0d39..8c8e248 100644 --- a/src/splitnotes2/server/split_server.py +++ b/src/splitguides/server/split_server.py @@ -19,7 +19,7 @@ static_folder = str(Path(__file__).parent / "static") app = Flask( - "splitnotes2", + "splitguides", template_folder=settings.server_template_folder, static_folder=settings.server_static_folder, ) diff --git a/src/splitnotes2/settings.py b/src/splitguides/settings.py similarity index 100% rename from src/splitnotes2/settings.py rename to src/splitguides/settings.py diff --git a/src/splitnotes2/static/desktop.css b/src/splitguides/static/desktop.css similarity index 100% rename from src/splitnotes2/static/desktop.css rename to src/splitguides/static/desktop.css diff --git a/src/splitnotes2/static/server.css b/src/splitguides/static/server.css similarity index 100% rename from src/splitnotes2/static/server.css rename to src/splitguides/static/server.css diff --git a/src/splitnotes2/static/streamlistener.js b/src/splitguides/static/streamlistener.js similarity index 100% rename from src/splitnotes2/static/streamlistener.js rename to src/splitguides/static/streamlistener.js diff --git a/src/splitnotes2/templates/desktop.html b/src/splitguides/templates/desktop.html similarity index 93% rename from src/splitnotes2/templates/desktop.html rename to src/splitguides/templates/desktop.html index 909d97b..df7e294 100644 --- a/src/splitnotes2/templates/desktop.html +++ b/src/splitguides/templates/desktop.html @@ -2,7 +2,7 @@
-