1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torch: src/factories/bk64/ConfigFactory.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Torch
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('ConfigFactory_8h_source.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">ConfigFactory.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include <cstdint></span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <filesystem></span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <string></span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <vector></span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <yaml-cpp/yaml.h></span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span>BK64 {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// Vanilla BK is exactly 16MB. Anything bigger has been through Banjo's Backpack.</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">inline</span> <span class="keywordtype">bool</span> IsRomhack(<span class="keyword">const</span> std::vector<uint8_t>& rom) {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keywordflow">return</span> rom.size() > 0x1000000;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>}</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">// When a romhack, generate a config for it based on us v1.0.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keywordtype">bool</span> TrySynthesizeRomConfig(YAML::Node& config, <span class="keyword">const</span> std::string& cartHash, <span class="keyword">const</span> std::filesystem::path& romPath,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">const</span> std::vector<uint8_t>& rom);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// Maintainer tool, creates a hashes.yml.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keywordtype">void</span> EmitAssetHashes(<span class="keyword">const</span> std::filesystem::path& romPath, <span class="keyword">const</span> std::filesystem::path& outputPath);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">// How many slots differ from the baseline hashes - a missing baseline entry counts as</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">// changed. The port-side extractor uses it to size its progress bar to the real romhack</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">// delta instead of every vanilla slot.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keywordtype">size_t</span> CountModifiedSlots(<span class="keyword">const</span> std::vector<uint8_t>& rom, <span class="keyword">const</span> std::filesystem::path& hashesYamlPath);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// Baseline SHA-1 for one slot, or empty if there's no hashes.yaml or no entry for it.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">// Loaded lazily from gAssetPath/hashes.yaml on the first call, then held for the run.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">const</span> std::string& GetBaselineAssetHash(uint32_t assetId);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">// Classification of a >16MB BK ROM.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">enum class</span> RomhackKind {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> NotRomhack, <span class="comment">// vanilla-sized ROM</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> BBRomhack, <span class="comment">// standard Banjo's Backpack build</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> CustomBuild, <span class="comment">// BK boot overlay present, but rebuilt/relocated internals</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> UnknownRom, <span class="comment">// extended ROM with no recognizable BK boot overlay</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>};</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>RomhackKind ClassifyRomhack(<span class="keyword">const</span> std::vector<uint8_t>& rom);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">// True for injected custom-code blobs and for CustomBuild ROMs.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="keywordtype">bool</span> HasCustomCodeBlob(<span class="keyword">const</span> std::vector<uint8_t>& rom);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">// Binary aGameConfig format: 'BKCF' header + typed sections</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">constexpr</span> uint32_t GAMECONFIG_MAGIC = 0x46434B42;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keyword">constexpr</span> uint16_t GAMECONFIG_VERSION = 1;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="keyword">enum class</span> ConfigSectionType : uint16_t {</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> CODE_CONSTANTS = 1,</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> SCENE_REMAP = 2,</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> RETURN_TO_LAIR = 3,</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> MUSIC = 4,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> SKYBOX = 5,</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> SCENE_DEF = 6,</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> NOTE_DOORS = 7,</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> JIGGY_PUZZLES = 8,</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> LEVEL_NAMES = 9,</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> WARP_DESTINATIONS = 10,</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> CUSTOM_CODE = 11,</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> ROM_HASH = 12,</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> CUSTOM_CODE_INFO = 13,</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>};</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="keyword">enum class</span> CustomCodeKind : uint16_t {</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> NONE = 0,</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> BB_GLOBALIZATION = 1,</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> BB_INJECTED = 2,</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>};</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment">// Pre-extraction probe for callers that decide the warning policy themselves</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment">// (e.g. the extraction UI checks RomhackTable for ported hashes): reports</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment">// the detected blob's kind and its SHA1 as 40 lowercase hex chars + NUL.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment">// Returns false (kind NONE, empty hash) when no blob is found.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="keywordtype">bool</span> GetCustomCodeBlobInfo(<span class="keyword">const</span> std::vector<uint8_t>& rom, CustomCodeKind& outKind, <span class="keywordtype">char</span> outSha1Hex[41]);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment">// CODE_CONSTANTS key IDs - they index into the sBBConfigs table.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="keyword">enum class</span> CodeConstantKey : uint16_t {</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> NEW_GAME_MAP = 0,</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> START_LEVEL_1,</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> START_LEVEL_2,</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> KNOW_ALL_MOVES,</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> MUMBO_COST_TERMITE,</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> MUMBO_COST_CROC,</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> MUMBO_COST_WALRUS,</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> MUMBO_COST_PUMPKIN,</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> MUMBO_COST_BEE,</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> EGGS_NORMAL_MAX,</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> RED_FEATHERS_NORMAL_MAX,</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> GOLD_FEATHERS_NORMAL_MAX,</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> EGGS_CHEATO_MAX,</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> RED_FEATHERS_CHEATO_MAX,</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> GOLD_FEATHERS_CHEATO_MAX,</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> NOTES_MAX,</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> JIGGIES_PER_WORLD,</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> HONEYCOMBS_PER_WORLD,</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> EXTRA_HC_START,</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> WARP_EXIT_BANJOS_HOUSE,</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> WARP_ENTER_LAIR,</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> SPECIAL_LEVEL,</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> HIDE_JIGGIES_LEVEL,</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> HIDE_COLLECTIBLES_LEVEL,</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> COUNT</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>};</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment">// Build the binary aGameConfig blob from a BB romhack ROM.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>std::vector<char> BuildGameConfigBlob(<span class="keyword">const</span> std::vector<uint8_t>& rom, <span class="keyword">const</span> std::string& romName);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>} <span class="comment">// namespace BK64</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a href="dir_9c074b8a3ff180fe0f5e8e7bda80dc8f.html">factories</a></li><li class="navelem"><a href="dir_d042745fb29c7ec84877aa9daeed8a91.html">bk64</a></li><li class="navelem"><b>ConfigFactory.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>
|
