From f604480c1f5a60de2d5a8c9cc443df42e18d0418 Mon Sep 17 00:00:00 2001
From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com>
Date: Sun, 29 Dec 2024 11:21:14 -0600
Subject: [PATCH 1/9] Update stonesense.rst
---
docs/plugins/stonesense.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst
index a098627dcd..92334e6cdc 100644
--- a/docs/plugins/stonesense.rst
+++ b/docs/plugins/stonesense.rst
@@ -56,6 +56,16 @@ views, fog, and rotation. Here's the important section:
:literal:
:end-before: VALID ACTIONS:
+
+Streaming stonesense
+--------------------
+If you wish to stream stonesense thru OBS then you may find that opening
+stonesense causes your main DF window to flicker between DF and stonesense.
+While it is unknown exactly what causes this, a fix does exist. Simply make
+sure that both DF and stonesense are using ``Window Capture``s and NOT
+``Game Capture``s. This will stop the flickering from happening and enable
+you to stream stonesense for all to enjoy.
+
Known Issues
------------
If Stonesense gives an error saying that it can't load
From 164fe2ce7d9c14ab6a863ff91fa737c8288f9748 Mon Sep 17 00:00:00 2001
From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com>
Date: Sun, 29 Dec 2024 11:24:06 -0600
Subject: [PATCH 2/9] Update stonesense.rst
---
docs/plugins/stonesense.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst
index 92334e6cdc..4ce294b5cc 100644
--- a/docs/plugins/stonesense.rst
+++ b/docs/plugins/stonesense.rst
@@ -62,7 +62,7 @@ Streaming stonesense
If you wish to stream stonesense thru OBS then you may find that opening
stonesense causes your main DF window to flicker between DF and stonesense.
While it is unknown exactly what causes this, a fix does exist. Simply make
-sure that both DF and stonesense are using ``Window Capture``s and NOT
+sure that both DF and stonesense are using ``Window Capture``s and NOT
``Game Capture``s. This will stop the flickering from happening and enable
you to stream stonesense for all to enjoy.
From 731e068285949ee33376ba45a28c7de74f285473 Mon Sep 17 00:00:00 2001
From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com>
Date: Sun, 29 Dec 2024 11:25:11 -0600
Subject: [PATCH 3/9] Update stonesense.rst
---
docs/plugins/stonesense.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst
index 4ce294b5cc..a584ced4eb 100644
--- a/docs/plugins/stonesense.rst
+++ b/docs/plugins/stonesense.rst
@@ -64,7 +64,7 @@ stonesense causes your main DF window to flicker between DF and stonesense.
While it is unknown exactly what causes this, a fix does exist. Simply make
sure that both DF and stonesense are using ``Window Capture``s and NOT
``Game Capture``s. This will stop the flickering from happening and enable
-you to stream stonesense for all to enjoy.
+you to stream stonesense for all to enjoy.
Known Issues
------------
From 355eb057d4b6e551e1912a89a9a94b3c08f232a4 Mon Sep 17 00:00:00 2001
From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com>
Date: Sun, 29 Dec 2024 11:42:06 -0600
Subject: [PATCH 4/9] Update stonesense.rst
---
docs/plugins/stonesense.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst
index a584ced4eb..f7a4071eec 100644
--- a/docs/plugins/stonesense.rst
+++ b/docs/plugins/stonesense.rst
@@ -62,8 +62,8 @@ Streaming stonesense
If you wish to stream stonesense thru OBS then you may find that opening
stonesense causes your main DF window to flicker between DF and stonesense.
While it is unknown exactly what causes this, a fix does exist. Simply make
-sure that both DF and stonesense are using ``Window Capture``s and NOT
-``Game Capture``s. This will stop the flickering from happening and enable
+sure that both DF and stonesense are using ``Window Capture`` and NOT
+``Game Capture``. This will stop the flickering from happening and enable
you to stream stonesense for all to enjoy.
Known Issues
From 1149e54cfb3ab0ba4e12966cd8a54b13366a716e Mon Sep 17 00:00:00 2001
From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com>
Date: Sun, 29 Dec 2024 14:24:55 -0600
Subject: [PATCH 5/9] Update stonesense.rst
---
docs/plugins/stonesense.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst
index f7a4071eec..bf9efd1e27 100644
--- a/docs/plugins/stonesense.rst
+++ b/docs/plugins/stonesense.rst
@@ -59,7 +59,7 @@ views, fog, and rotation. Here's the important section:
Streaming stonesense
--------------------
-If you wish to stream stonesense thru OBS then you may find that opening
+If you wish to stream stonesense thru the broadcasting software `OBS _` then you may find that opening
stonesense causes your main DF window to flicker between DF and stonesense.
While it is unknown exactly what causes this, a fix does exist. Simply make
sure that both DF and stonesense are using ``Window Capture`` and NOT
From f14dafe53a257bd339ca46efe9d4a82cd34cdb3e Mon Sep 17 00:00:00 2001
From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com>
Date: Sun, 29 Dec 2024 14:27:18 -0600
Subject: [PATCH 6/9] Fixxed typo in obs link
---
docs/plugins/stonesense.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst
index bf9efd1e27..2776e532ca 100644
--- a/docs/plugins/stonesense.rst
+++ b/docs/plugins/stonesense.rst
@@ -59,7 +59,7 @@ views, fog, and rotation. Here's the important section:
Streaming stonesense
--------------------
-If you wish to stream stonesense thru the broadcasting software `OBS _` then you may find that opening
+If you wish to stream stonesense thru the broadcasting software `OBS `_ then you may find that opening
stonesense causes your main DF window to flicker between DF and stonesense.
While it is unknown exactly what causes this, a fix does exist. Simply make
sure that both DF and stonesense are using ``Window Capture`` and NOT
From 93ae995859f4a9b02823ed15d431ef8332582bc1 Mon Sep 17 00:00:00 2001
From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com>
Date: Sun, 29 Dec 2024 14:33:10 -0600
Subject: [PATCH 7/9] Update stonesense.rst
---
docs/plugins/stonesense.rst | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst
index 2776e532ca..6bc916e278 100644
--- a/docs/plugins/stonesense.rst
+++ b/docs/plugins/stonesense.rst
@@ -59,12 +59,13 @@ views, fog, and rotation. Here's the important section:
Streaming stonesense
--------------------
-If you wish to stream stonesense thru the broadcasting software `OBS `_ then you may find that opening
-stonesense causes your main DF window to flicker between DF and stonesense.
-While it is unknown exactly what causes this, a fix does exist. Simply make
-sure that both DF and stonesense are using ``Window Capture`` and NOT
-``Game Capture``. This will stop the flickering from happening and enable
-you to stream stonesense for all to enjoy.
+If you wish to stream stonesense thru a broadcasting software such as `OBS `_
+then you may find that opening stonesense causes your main DF window to flicker
+between DF and stonesense. While it is unknown exactly what causes this, a fix
+does exist. Simply make sure that both DF and stonesense are using ``Window Capture``
+and NOT ``Game Capture``. This will stop the flickering from happening and enable
+you to stream stonesense for all to enjoy. This has been tested in OBS on Windows 10 but
+should work on all operating systems the OBS supports and `Streamlabs `_
Known Issues
------------
From 18f1d26085eaa49b9ffa1dcf480709ea40f4c9e8 Mon Sep 17 00:00:00 2001
From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com>
Date: Sun, 29 Dec 2024 14:47:38 -0600
Subject: [PATCH 8/9] Update stonesense.rst
---
docs/plugins/stonesense.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst
index 6bc916e278..ec7ffe2614 100644
--- a/docs/plugins/stonesense.rst
+++ b/docs/plugins/stonesense.rst
@@ -65,7 +65,7 @@ between DF and stonesense. While it is unknown exactly what causes this, a fix
does exist. Simply make sure that both DF and stonesense are using ``Window Capture``
and NOT ``Game Capture``. This will stop the flickering from happening and enable
you to stream stonesense for all to enjoy. This has been tested in OBS on Windows 10 but
-should work on all operating systems the OBS supports and `Streamlabs `_
+should work on all operating systems the OBS supports and `Streamlabs `_.
Known Issues
------------
From e7e31a5b15023a5262275ceede325e8af3b5f833 Mon Sep 17 00:00:00 2001
From: Squid Coder <92821989+realSquidCoder@users.noreply.github.com>
Date: Wed, 1 Jan 2025 11:16:10 -0600
Subject: [PATCH 9/9] Made the section clarify that it only affects the windows
os
---
docs/plugins/stonesense.rst | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/docs/plugins/stonesense.rst b/docs/plugins/stonesense.rst
index ec7ffe2614..ba8ba8478b 100644
--- a/docs/plugins/stonesense.rst
+++ b/docs/plugins/stonesense.rst
@@ -57,15 +57,16 @@ views, fog, and rotation. Here's the important section:
:end-before: VALID ACTIONS:
-Streaming stonesense
---------------------
+Streaming stonesense on Windows
+-------------------------------
If you wish to stream stonesense thru a broadcasting software such as `OBS `_
then you may find that opening stonesense causes your main DF window to flicker
between DF and stonesense. While it is unknown exactly what causes this, a fix
does exist. Simply make sure that both DF and stonesense are using ``Window Capture``
and NOT ``Game Capture``. This will stop the flickering from happening and enable
you to stream stonesense for all to enjoy. This has been tested in OBS on Windows 10 but
-should work on all operating systems the OBS supports and `Streamlabs `_.
+should work on Windows 11 and in `Streamlabs `_. Linux, having no
+``Game Capture`` option should be unaffected by this issue.
Known Issues
------------