GitHub - GhbSmwc/CustomLayer3Menu: A layer 3 menu system for SMW

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 82 Commits
CustomLayer3Menu_Defines		CustomLayer3Menu_Defines
GPS blocks		GPS blocks
LM_stuff		LM_stuff
Patch		Patch
Uberasm_tool_files		Uberasm_tool_files
.gitattributes		.gitattributes
Freeram_for_AddressTracker.txt		Freeram_for_AddressTracker.txt
Readme.html		Readme.html

Repository files navigation

<html>
	<head>
		<style>
			html {
			background-color: black;
			color: white;
			font-family: sans-serif;
			}
			
			span.NoLineBreak {
				white-space: nowrap;
			}
			
			table, th, td {
			border: 1px solid white;
			border-collapse: collapse;
			}
			
			abbr{cursor: help;}
			img.img-hor {
				-moz-transform: scaleX(-1);
				-o-transform: scaleX(-1);
				-webkit-transform: scaleX(-1);
				transform: scaleX(-1);
				filter: FlipH;
				-ms-filter: "FlipH";
			}
		</style>
	</head>
	<h1 style="text-align: center;">Custom layer 3 UI</h1>
	<p>This ASM package lets you have custom layer 3 user interface. This involves drawing the UI on layer 3 stripe image and utilizing RAMs so that the system knows what the player is selecting.</p>
	<p>Features included:</p>
	<ul>
		<li>A vertical menu whose code can be customize when selected (you can have up to )</li>
		<li>A digit passcode</li>
		<li>A String input (can be used as a passcode)</li>
	</ul>
	<h2>Table of Contents</h2>
	<ul>
		<li><a href="#TOC_Installation" id="TOC_back_Installation">Installation</a></li>
		<li><a href="#TOC_Usage" id="TOC_back_Usage">Usage</a></li>
		<li><a href="#TOC_Notes" id="TOC_back_Notes">Notes</a></li>
	</ul>
	<hr>
	<h2><a href="#TOC_back_Installation" id="TOC_Installation">^</a>Installation</h2>
	<ol>
		<li>LM stuff</li>
		<ol>
			<li>Install the LM-related data into your game. These are in <kbd>LM_stuff</kbd> folder. The names should be obvious.</li>
			<li>Now save.</li>
		</ol>
		<li>ASM stuff</li>
		<ol>
			<li>Defines</li>
			<ol>
				<li>The first thing you want to do is make necessary changes to the defines file in <kbd>CustomLayer3Menu_Defines/Defines.asm</kbd>. After you are done, have the FOLDER containing these files
				copied and pasted in:
					<ul>
						<li>The main directory of GPS (folder should be in the same directory as <kbd>gps.exe</kbd>)</li>
						<li>The main directory of uberasm tool (folder should be in the same directory as <kbd>UberASMTool.exe</kbd>)</li>
					</ul>
				If you wish to make changes after insertion, make sure you repeat this step so that all the tools will have up-to-date info
				</li>
			</ol>
			<li>Patch</li>
				<ol>
					<li>Obviously this ASM pack requires a patch, so patch <kbd>Patch/UIControlTransferPatch.asm</kbd> into your game. This patch disables controls from influencing Mario, fixes a minor Y position
					bug and modifies the <kbd>FreezePlayer</kbd> not to temporary disable HDMA outside the bowser fight when setting RAM <kbd>$71</kbd> to <kbd>#$0B</kbd>.</li>
				</ol>
			<li>Custom blocks (Gopher Popcorn Stew)</li>
			<ol>
				<li>Have the text file in <kbd>CustomLayer3Menu/GPS blocks/BlockList.txt</kbd> and paste it in GPS's list file.</li>
				<li>Paste several ASM files in the subdirectory (subfolder) of <kbd>CustomLayer3Menu/GPS blocks/</kbd>. Folder names should be obvious where to put.</li>
				<li>Run GPS to install the blocks into your game.</li>
			</ol>
			<li>Uberasm tool</li>
			<ol>
				<li>Same as the custom block above, insert accordingly.</li>
				<li>However, you need to copy this for the list file:
<table><tr><td><pre>; Level list. Valid values: 000-1FF.
level:
;105		LevelRandomizePasscode.asm
105		LevelWarpMenu.asm</pre></td></tr></table>
<table><tr><td><pre>; Game mode list. Valid values: 00-FF.
gamemode:
; Insert files here
14		GM14.asm</pre></td></tr></table>
				</li>
				<li>Then insert into your game by running <kbd>UberASMTool.exe</kbd></li>
			</ol>
		</ol>
	</ol>
<hr>
<h2><a href="#TOC_back_Usage" id="TOC_Usage">^</a>Usage</h2>
	<ol>
		<li>
			In any level that uses this layer 3 mechanic on Lunar Magic, you must have the &ldquo;Change Layer 3 Settings&rdquo; set as follows:
			<ul>
				<li>Blank layer 3</li>
				<li>[check] Force Layer 3 tiles with priority above other layers and sprites</li>
				<li>[check] Enable advanced bypass settings for Layer 3</li>
				<li>[uncheck] CGADSUB for Layer 3</li>
				<li>[uncheck] Move layer 3 to subscreen</li>
				<li>Vertical scroll: None</li>
				<li>Vertical scroll: None</li>
				<li>Inintal Y position/offset: 0</li>
				<li>Inintal X position/offset: 0</li>
			</ul>
			This is so that the menu appears on-screen and not behind other layers and sprites.
		</li>
		<li>Place any custom blocks in the level that the player can use.</li>
	</ol>
	
	<h2><a href="#TOC_back_Notes" id="TOC_Notes">^</a>Notes</h2>
	<ul>
		<li>At the time of writing this, Uberasm tool will run the gamemode 14 first (which runs the code from <kbd>Uberasm_tool_files/gamemode/GM14.asm</kbd>, calls the code from <kbd>Uberasm_tool_files/library/CustomLayer3Menu.asm</kbd>), then the level codes.</li>
		<li>The more tiles to update in a single frame, the more likely a vblank overflow can occur, which causes black bars to flicker at the top of the screen. So make sure the menu display isn't too large. I tried to spread out the tile write across multiple frames
		to reduce the number of tiles to write in one frame.</li>
	</ul>