github.com/hzck/speedroute@v0.0.0-20201115191102-403b7d0e443f/old-public/howto.html (about)

     1  <!DOCTYPE html>
     2  <html ng-app="speedrunRouting">
     3  	<head>
     4  		<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css" />
     5  		<link rel="stylesheet" type="text/css" href="css/vis.min.css" />
     6  		<link rel="stylesheet" type="text/css" href="css/speedroute.css" />
     7  		<script type="text/javascript" src="js/vis.min.js"></script>
     8  		<script type="text/javascript" src="js/angular.min.js"></script>
     9  		<script type="text/javascript" src="js/angular-animate.min.js"></script>
    10  		<script type="text/javascript" src="js/angular-touch.min.js"></script>
    11  		<script type="text/javascript" src="js/angular-vis.js"></script>
    12  		<script type="text/javascript" src="js/ui-bootstrap-tpls-2.0.2.min.js"></script>
    13  		<script type="text/javascript" src="js/speedroute.js"></script>
    14  	</head>
    15  	<body>
    16  		<div ng-include="'header.html'"></div>
    17  		<div class="container">
    18  			<div class="col-sm-8">
    19  				<h2>User guide</h2>
    20  				<p>This section should highlight how to use <a href="/">Speedroute</a> as a tool, and what the expected result will be. It will be divided into 3 subsections: Rewards, Nodes and Edges. These are the bulk of the algorithm, and there will be examples to explain each part.</p>
    21  				<h3>Rewards</h3>
    22  				<p>A reward can be any obtainable item, a story milestone, an upgrade or a requirement for later parts of the game. Rewards will be rewarded/obtained during the run, and can be used as requirements to reach certain nodes. Rewards can also be a subtype: a sword is a melee weapon is a weapon and a bow is a ranged weapon is a weapon - some edges might require a melee weapon and then the bow won't do, but if any weapon is required then both sword or bow will do.</p>
    23  				<uib-accordion close-others="true">
    24  				<div uib-accordion-group heading="Example rewards in Super Mario 64">
    25  					<ul>
    26  						<li>Star</li>
    27  						<li>8 red coins star from Cool Cool Mountain (CCM) (which is also a star)</li>
    28  						<li>Wing cap</li>
    29  						<li>Bob-Omb Battlefield (BOB) Cannon open</li>
    30  						<li>Downstairs key</li>
    31  						<li>Wing cap</li>
    32  					</ul>
    33  				</div>
    34  				</uib-accordion>
    35  				<h3>Nodes</h3>
    36  				<p>A node is usually a place in the game, or a game state. It can be anything from a door, the moment you kill a boss or open a treasure chest. Nodes can include rewards, so when you reach them you get the reward. Some nodes are revisitable and can be visited several times during a run, like a common room or a level select screen, while others can only be visited once. Usually when a node includes rewards it can't be revisited but that might not always be true. Some places might be farmable and give 100 gold each time.</p>
    37  				<uib-accordion close-others="true">
    38  				<div uib-accordion-group heading="Example nodes in Super Mario 64">
    39  					<ul>
    40  						<li>START</li>
    41  						<li>BOB star select screen (revisitable)</li>
    42  						<li>Getting 8 red coins star from CCM (CCM-4 star reward)</li>
    43  						<li>Save and exit spot in the middle (revisitable)</li>
    44  						<li>MIPS (MIPS star reward)</li>
    45  						<li>Big star in the end</li>
    46  					</ul>
    47  				</div>
    48  				<h3>Edges</h3>
    49  				<p>Edges are where it get's interesting. An edge is a path or a route between two nodes. There can only be one edge from node A to node B (and one from B to A), but it can instead contain sub-edges which are called weights. Each weight represents a different way of taking you from node A to node B, possibly with different reward requirements. A weight is also supposed to have a duration (but this is not always the case). As an example, lets say that the edge is defeating Flash Man in Mega Man 2. If you only have Buster it will take 55sec and if you have Metal Blade it will only take 15sec (numbers made up). If you don't have Metal Blade by then you have to take the slower weight. Note that edges will not deplete your rewards, just having it will make it accessible. </p>
    50  				<uib-accordion close-others="true">
    51  				<div uib-accordion-group heading="Example edges in Super Mario 64">
    52  					<ul>
    53  						<li>START to BOB star select screen</li>
    54  						<li>BOB star select screen to BOB-3 star
    55  							<ul>
    56  								<li>No items - 34 sec</li>
    57  								<li>Cannon opened - 27 sec</li>
    58  								<li>Wing cap unlocked - 15 sec</li>
    59  							</ul>
    60  						</li>
    61  						<li>Save and exit spot to Tick Tock Clock</li>
    62  					</ul>
    63  				</div>
    64  			</div>
    65  		</div>
    66  	</body>
    67  </html>