Added a warning about older StreamReader versions to the manual.
All checks were successful
🚀 Pack skyscraper8 / make-zip (push) Successful in 1m33s

This commit is contained in:
feyris-tan 2025-10-12 23:29:51 +02:00
parent 3bdf478a81
commit fe66c643f8
2 changed files with 32 additions and 4 deletions

5
.gitignore vendored
View File

@ -124,3 +124,8 @@ imgui.ini
/GUIs/skyscraper8.UI.ImGui.MonoGame/obj
/.vs/skyscraper8/CopilotIndices/17.14.995.13737
/.vs/skyscraper8/config
/skyscraper8.Manual/skyscraper8.Manual.aux
/skyscraper8.Manual/skyscraper8.Manual.log
/skyscraper8.Manual/skyscraper8.Manual.out
/skyscraper8.Manual/skyscraper8.Manual.pdf
/skyscraper8.Manual/skyscraper8.Manual.synctex.gz

View File

@ -74,9 +74,12 @@ On Linux and macOS, any halfway recent shell should be fine.
.\skyscraper8.exe cscan tcp://127.0.0.1:6969
\end{verbatim}
\label{sec:gswarning}
\begin{warning}
If you're planning to work with GS, make sure to disable StreamReader.dll's internal deencapsulator. You can do this by keeping the semicolon in StreamReader.ini like this
\subsubsection{Working with GS using StreamReader}
There are a few caveats when working with StreamReader.dll to capture GS.
Some older versions of StreamReader.dll are known to interfere with the STiD135's BBFrame encapsulation feature. Version 1.2.4.101 is a prominent example of doing this. It changes the encapsulation PID and also seems to frame GSE frames differently. Therefore, please make sure to use a recent version of StreamReader.dll. Version 1.2.5.208 is known to work correctly.
Also, make sure to disable StreamReader.dll's internal deencapsulator. You can do this by keeping the semicolon in StreamReader.ini like this
\begin{verbatim}
;FrameMode=1
\end{verbatim}
@ -86,7 +89,6 @@ FrameMode=0
\end{verbatim}
Why is that? While StreamReader.dll's Deencapsulation works correctly in theory, it does not seem to check whether an encapsulated packet actually contains valid MPEG-II packets and will happily try to deencapsulate all other packets as well, causing a lot of Packets with invalid data to appear in the outputted TS.
\end{warning}
@ -173,4 +175,25 @@ The .NET assembly of skyscraper8 is not obfuscated or protected in any way. This
This document was typeset in \LaTeX{}, using the TeX Live distribution, and while I wrote it myself, I did use GPT-5 for proofreading the initial version of this document. The proofreading of this document is the only part of skyscraper8 for which an LLM was used. No part of the actual skyscraper8 codebase itself was written by an LLM.
\subsection{Personal remarks and some useless bonus information}
\subsubsection{Music!}
Like a lot of programmers, I do enjoy listening to music while working. Some programmers even put song references in their software. Like how MKVToolnix' version names are actually song names, or how BSD developer fk even put \href{https://www.fabiankeil.de/nutzloseinfos.html}{a list of albums on his website} listing what albums he listened to while making it. Although this is absolutely useless, I'd liketo do this as well. Therefore, here follows a list of musical albums I listened to while developing skyscraper8 - no claim to completeness.
\begin{itemize}
\item Bel Canto - White-Out Conditions
\item Beautiful World - In Existance
\item Kitaro - Millennia
\item Macross 82-99 - A Million Miles Away
\item Megazone 23 Vocal Collection
\item Moodswings - Moodfood
\item Opus III - Guru Mother
\item Satsuki Shibano / Yoshio Ojima - Caresse
\item SHIFT UP - Stellar Blade Original Soundtrack
\item Small Affairs - Small Affairs
\item Yoshio Ojima - Hands-Some
\item Youssou NDour - The Guide (Wommat)
\item Yu-Gi-Oh! Sound Duel Quarter Century Collection
\end{itemize}
\end{document}