update

TODO.txt

@@ -1,6 +1,15 @@
 Big stuff
 ----------
 
+trigger points to update timers:
+	at exact X,Y
+	when X is crossed
+	when Y is crossed
+	when X and Y are both crossed
+
+keep track of velocity via link's coordinates on SA-1
+
+
 last frame of crystal fade = bad savestate
 
 submenu for flags for important OW overlays (LJ, HC, Pyramid)

build.bat

@@ -1,4 +1,4 @@
-set version="14.3.1"
+set version="14.3.2"
 
 cd target
 

docs/_layouts/practicehack.html

@@ -20,7 +20,7 @@
 				<ul>
 					<li><a href="updates" target="_blank">Change log</a></li>
 					<li><a href="https://spannerisms.github.io/" target="_blank">Blog</a></li>
-
+					<li><a href="https://discord.gg/FZsX6HPZw5" target="_blank">SMT Rando</a></li>
 				</ul>
 			</div>
 		</nav>

docs/index.html

@@ -16,7 +16,7 @@ <h4 class="listheader">Compatible systems:</h4>
 <ul>
 	<li>SD2SNES</li>
 	<li>SNES Classic (with RetroArch)</li>
-	<li>Mesen-s</li>
+	<li>Mesen-S</li>
 	<li>higan/bsnes v115+</li>
 	<li>bsnes+</li>
 	<li>snes9x 1.6+</li>
@@ -51,15 +51,15 @@ <h4 class="listheader">List of shame:</h4>
 <section class="features">
 
 <h2>Hack features</h2>
-<p>The practice hack comes loaded with a full suite of HUD changes, features, and wedges to facilitate RTA practice and glitch hunting. The most common commonly used features include:</p>
+<p>The practice hack comes loaded with a full suite of HUD changes, features, and wedges to facilitate RTA practice and glitch hunting. The most commonly used features include:</p>
 <ul>
 	<li>Presets to load a specific section of the run with the appropriate equipment.</li>
 	<li>Built-in save states for practicing anything repeatedly.</li>
 	<li>Timers for comparing strategies and execution against yourself and others.</li>
 	<li>Input display for displaying your inputs on your display.</li>
 </ul>
 
-<p>Configuration settings will persist across practice hack versions if newly downloaded hacks are given the same name on your SD card.</p>
+<p>Configuration settings will persist across practice hack versions if newly downloaded hacks are given the same file name as previous versions on whatever system you use.</p>
 
 <h3>Practice Hack Menu</h3>
 <p>The practice hack menu can be accessed by having the <span class="snesButton snesR">R</span> and <span class="snesButton snesStart">Start</span> buttons held down together on the same frame. This menu and other shortcuts can be activated during most gameplay modes, but will be prohibited during some modules (such as the file select menu). When disallowed, shortcut bindings will play a beep and resume normal action.</p>
@@ -229,6 +229,14 @@ <h2>Trouble shooting</h2>
 	<li>If something in the menu goes out of range, you will be warned with "BAD VAL". Press X to clear it.</li>
 </ul>
 
+<h2>Caveats</h2>
+<p>It's impossible to modify anything this much without sacrificing some behavior. This section details known caveats that should be taken into consideration by the user.</p>
+
+<h3>Overlay corruption and the SA-1</h3>
+<p>The memory layout of the SA-1 puts important hardware registers and on-board memory in an area potentially affected by overlay corruption. To prevent corruption to the SA-1, the star tile holes routine will be intercepted if it is about to write too far. This will have some effect on the timing of longer corruptions.</p>
+<p>When cut short, the practice hack will continue reading without writing to see how far the writes would have gone. If they reach too far (<code>$4200</code>), then a blue screen of death will be displayed to explain the intentional lock.</p>
+<p>In addition to the writing, this type of corruption may also read too far. This does not have the potential to corrupt the SA-1, but it does throw the behavior out of sync from vanilla. Normally, corruption that reaches this far should terminate at the address <code>$4307</code>; however, the values read from SA-1 registers and memory prevent that precise target from being hit. To guarantee that corruption resolves, a large block of memory from <code>$3680</code> to <code>$37FF</code> has been filled with the necessary terminator value. This solution necessarily means that far-reaching corruption will end much sooner than it normally would, making timings unreliable.</p>
+
 </section>
 
 <section id="featurelist">
@@ -774,8 +782,8 @@ <h3 id="menuHUD">HUD extras</h3>
 		</dl>
 	</dd>
 
-	<dt>Line [1–3]<sup class="badge lag-badge">EX</sup></dt>
-	<dd>3 larger sentry lines of info displayed on the HUD.
+	<dt>Line [1–4]<sup class="badge lag-badge">EX</sup></dt>
+	<dd>4 larger sentry lines of info displayed on the HUD.
 		<dl class="subDefinition">
 			<dt>Room flags</dt>
 			<dd>Boss heart, key, chest, and door flags for current room.</dd>
@@ -795,8 +803,8 @@ <h3 id="menuHUD">HUD extras</h3>
 			<dd>Custom ancilla property for the 5 slots preceding the current search index ($03C4). This set of slots is indicated by a blue magnifying glass.</dd>
 		</dl>
 	</dd>
-	<dt>Ancilla prop [1–3]</dt>
-	<dd>Custom property 1–3 for ancilla sets corresponding to line sentries 1–3
+	<dt>Ancilla prop [1–4]</dt>
+	<dd>Custom property 1–4 for ancilla sets corresponding to line sentries 1–4
 		<dl class="subDefinition">
 			<dt>ID</dt>
 			<dd>Ancilla ID from $03C4,X (includes coloring for 00 and replacable particles).</dd>
@@ -820,6 +828,8 @@ <h3 id="menuHUD">HUD extras</h3>
 			<dd>Timer for wall arrows before disappearing; address: $7E03B1,X</dd>
 		</dl>
 	</dd>
+	<dt>Hide lines<sup class="badge sa1-badge">SA1</sup></dt>
+	<dd>Removes the line sentries from the HUD without the need to disable them.</dd>
 	<dt>HUD lag<sup class="badge sa1-badge">SA1</sup></dt>
 	<dd>Animated spinning icon that indicates there is potential for HUD-related lag present.</dd>
 	<dt>State icons<sup class="badge sa1-badge">SA1</sup></dt>

docs/patcher/manifest.json

@@ -1,6 +1,6 @@
 {
     "name": "LTTPHack",
-    "version": "14.3.1",
+    "version": "14.3.2",
     "base": {
         "name": "A Link to the Past (J) 1.0",
         "crc": "3322EFFC"

docs/updates.html

@@ -5,6 +5,33 @@
 
 <h2>Latest update</h2>
 
+
+<h3><a href="https://github.com/spannerisms/lttphack/releases/tag/14.3.2">v14.3.2</a> <span class="releaseDate">2 February 2022</span></h3>
+
+<ul class="changes">
+	<li>HUD extras:
+		<ul>
+			<li>Added a fourth line sentry.</li>
+			<li>Added "Hide lines".</li>
+		</ul>
+	</li>
+	<li>Other:
+		<ul>
+			<li>Added a "Caveats" section to the documentation.</li>
+			<li>Crash the game when somaria goes bad.</li>
+			<li>Fixed input on fairy item toss.</li>
+			<li>Fixed a very minor lag bug with menu.</li>
+			<li>Added a block of sentinels to catch heavy corruption and prevent it from hanging forever.</li>
+			<li>Added ancilla index to Lite States.</li>
+			<li>Spooky edit.</li>
+		</ul>
+	</li>
+</ul>
+
+
+
+<h2>Older updates</h2>
+
 <h3><a href="https://github.com/spannerisms/lttphack/releases/tag/14.3.1">v14.3.1</a> <span class="releaseDate">2 December 2021</span></h3>
 
 <ul class="changes">
@@ -13,8 +40,6 @@ <h3><a href="https://github.com/spannerisms/lttphack/releases/tag/14.3.1">v14.3.
 	<li>Added arrow decay timer for Sirius.</li>
 </ul>
 
-<h2>Older updates</h2>
-
 <h3><a href="https://github.com/spannerisms/lttphack/releases/tag/14.3.0">v14.3.0</a> <span class="releaseDate">29 November 2021</span></h3>
 
 <ul class="changes">
@@ -33,7 +58,6 @@ <h3><a href="https://github.com/spannerisms/lttphack/releases/tag/14.3.0">v14.3.
 	<li>Moved the throne room mantle to allow sewers access when rain state is over in randomizer version.</li>
 </ul>
 
-
 <h3><a href="https://github.com/spannerisms/lttphack/releases/tag/14.2.2">v14.2.2</a> <span class="releaseDate">26 September 2021</span></h3>
 
 <ul class="changes">