Skip to content

Commit

Permalink
deploy: 001ae0e
Browse files Browse the repository at this point in the history
  • Loading branch information
x87 committed Aug 13, 2023
1 parent 11a66b7 commit 2c853eb
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 19 deletions.
12 changes: 6 additions & 6 deletions docs/en/definitions.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,12 +144,12 @@ <h1 id="definitions"><a class="header" href="#definitions">Definitions</a></h1>
<p>Due to the dynamic nature of JavaScript CLEO Redux needs to know an interface of each native command, i.e. a number of input arguments and returned values and their types. <a href="https://library.sannybuilder.com">Sanny Builder Library</a> serves as the source of command definitions for CLEO Redux.</p>
<p>At start CLEO validates that a definition file is present and correct and if not tries to download it from GitHub (see the table below) into your local <code>CLEO/.config</code> directory. If that did not happen, or you don't want to let CLEO make network calls, manually download the required file and place it in the <code>CLEO/.config</code> directory.</p>
<table><thead><tr><th>Game</th><th>File</th><th>Minimum Required Version</th></tr></thead><tbody>
<tr><td>GTA III, re3</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta3/gta3.json">gta3.json</a></td><td><code>0.265</code></td></tr>
<tr><td>GTA VC, reVC</td><td><a href="https://github.com/sannybuilder/library/blob/master/vc/vc.json">vc.json</a></td><td><code>0.271</code></td></tr>
<tr><td>GTA San Andreas (Classic) 1.0</td><td><a href="https://github.com/sannybuilder/library/blob/master/sa/sa.json">sa.json</a></td><td><code>0.316</code></td></tr>
<tr><td>GTA III: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta3_unreal/gta3_unreal.json">gta3_unreal.json</a></td><td><code>0.227</code></td></tr>
<tr><td>Vice City: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/vc_unreal/vc_unreal.json">vc_unreal.json</a></td><td><code>0.233</code></td></tr>
<tr><td>San Andreas: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/sa_unreal/sa_unreal.json">sa_unreal.json</a></td><td><code>0.262</code></td></tr>
<tr><td>GTA III, re3</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta3/gta3.json">gta3.json</a></td><td><code>0.267</code></td></tr>
<tr><td>GTA VC, reVC</td><td><a href="https://github.com/sannybuilder/library/blob/master/vc/vc.json">vc.json</a></td><td><code>0.273</code></td></tr>
<tr><td>GTA San Andreas (Classic) 1.0</td><td><a href="https://github.com/sannybuilder/library/blob/master/sa/sa.json">sa.json</a></td><td><code>0.318</code></td></tr>
<tr><td>GTA III: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta3_unreal/gta3_unreal.json">gta3_unreal.json</a></td><td><code>0.228</code></td></tr>
<tr><td>Vice City: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/vc_unreal/vc_unreal.json">vc_unreal.json</a></td><td><code>0.234</code></td></tr>
<tr><td>San Andreas: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/sa_unreal/sa_unreal.json">sa_unreal.json</a></td><td><code>0.263</code></td></tr>
<tr><td>GTA IV</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta_iv/gta_iv.json">gta_iv.json</a></td><td><code>0.78</code></td></tr>
<tr><td>Unknown (32-bit)</td><td><a href="https://github.com/sannybuilder/library/blob/master/unknown_x86/unknown_x86.json">unknown_x86.json</a></td><td><code>0.225</code></td></tr>
<tr><td>Unknown (64-bit)</td><td><a href="https://github.com/sannybuilder/library/blob/master/unknown_x64/unknown_x64.json">unknown_x64.json</a></td><td><code>0.228</code></td></tr>
Expand Down
20 changes: 12 additions & 8 deletions docs/en/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -487,12 +487,12 @@ <h2 id="writing-a-compiled-script"><a class="header" href="#writing-a-compiled-s
<p>Due to the dynamic nature of JavaScript CLEO Redux needs to know an interface of each native command, i.e. a number of input arguments and returned values and their types. <a href="https://library.sannybuilder.com">Sanny Builder Library</a> serves as the source of command definitions for CLEO Redux.</p>
<p>At start CLEO validates that a definition file is present and correct and if not tries to download it from GitHub (see the table below) into your local <code>CLEO/.config</code> directory. If that did not happen, or you don't want to let CLEO make network calls, manually download the required file and place it in the <code>CLEO/.config</code> directory.</p>
<table><thead><tr><th>Game</th><th>File</th><th>Minimum Required Version</th></tr></thead><tbody>
<tr><td>GTA III, re3</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta3/gta3.json">gta3.json</a></td><td><code>0.265</code></td></tr>
<tr><td>GTA VC, reVC</td><td><a href="https://github.com/sannybuilder/library/blob/master/vc/vc.json">vc.json</a></td><td><code>0.271</code></td></tr>
<tr><td>GTA San Andreas (Classic) 1.0</td><td><a href="https://github.com/sannybuilder/library/blob/master/sa/sa.json">sa.json</a></td><td><code>0.316</code></td></tr>
<tr><td>GTA III: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta3_unreal/gta3_unreal.json">gta3_unreal.json</a></td><td><code>0.227</code></td></tr>
<tr><td>Vice City: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/vc_unreal/vc_unreal.json">vc_unreal.json</a></td><td><code>0.233</code></td></tr>
<tr><td>San Andreas: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/sa_unreal/sa_unreal.json">sa_unreal.json</a></td><td><code>0.262</code></td></tr>
<tr><td>GTA III, re3</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta3/gta3.json">gta3.json</a></td><td><code>0.267</code></td></tr>
<tr><td>GTA VC, reVC</td><td><a href="https://github.com/sannybuilder/library/blob/master/vc/vc.json">vc.json</a></td><td><code>0.273</code></td></tr>
<tr><td>GTA San Andreas (Classic) 1.0</td><td><a href="https://github.com/sannybuilder/library/blob/master/sa/sa.json">sa.json</a></td><td><code>0.318</code></td></tr>
<tr><td>GTA III: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta3_unreal/gta3_unreal.json">gta3_unreal.json</a></td><td><code>0.228</code></td></tr>
<tr><td>Vice City: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/vc_unreal/vc_unreal.json">vc_unreal.json</a></td><td><code>0.234</code></td></tr>
<tr><td>San Andreas: The Definitive Edition</td><td><a href="https://github.com/sannybuilder/library/blob/master/sa_unreal/sa_unreal.json">sa_unreal.json</a></td><td><code>0.263</code></td></tr>
<tr><td>GTA IV</td><td><a href="https://github.com/sannybuilder/library/blob/master/gta_iv/gta_iv.json">gta_iv.json</a></td><td><code>0.78</code></td></tr>
<tr><td>Unknown (32-bit)</td><td><a href="https://github.com/sannybuilder/library/blob/master/unknown_x86/unknown_x86.json">unknown_x86.json</a></td><td><code>0.225</code></td></tr>
<tr><td>Unknown (64-bit)</td><td><a href="https://github.com/sannybuilder/library/blob/master/unknown_x64/unknown_x64.json">unknown_x64.json</a></td><td><code>0.228</code></td></tr>
Expand Down Expand Up @@ -1548,9 +1548,11 @@ <h3 id="calling-foreign-functions"><a class="header" href="#calling-foreign-func
</code></pre>
<p>The second parameter (<code>0x7001234</code>) is the object address. The <code>pop</code> parameter is always <code>0</code> (the method uses the <a href="https://en.wikipedia.org/wiki/X86_calling_conventions#thiscall">thiscall</a> convention).</p>
<p>To call the method and get the result out of it, use <code>Memory.CallMethodReturn</code>.</p>
<p>Note that all arguments are read as 32-bit signed integers. If you need to provide an argument of the float type, use <code>Memory.FromFloat</code>, e.g.</p>
<blockquote>
<p>Input arguments are treated as 32-bit signed integers. If you need to provide a floating-point number, use <code>Memory.FromFloat</code>, e.g.</p>
<pre><code class="language-js">Memory.CallFunction(0x1234567, 1, 1, Memory.FromFloat(123.456));
</code></pre>
</blockquote>
<p>CLEO Redux supports calling foreign functions with up to 16 parameters.</p>
<blockquote>
<p>The usage of any of the call methods requires the <code>mem</code> <a href="./permissions.html">permission</a>.</p>
Expand Down Expand Up @@ -1743,10 +1745,12 @@ <h3 id="calling-foreign-functions-1"><a class="header" href="#calling-foreign-fu
</code></pre>
<p>where <code>0xEFFB30</code> is the function offset relative to IMAGE BASE (think of it a randomized start address of the game memory), <code>true</code> is the <code>ib</code> flag (see below), <code>1</code> is the number of input arguments, and <code>13</code> are the only argument passed into the function.</p>
<p>The <code>ib</code> parameter in <code>Memory.CallFunction</code> has the same meaning as in memory read/write commands. When set to <code>true</code> CLEO adds the current known address of the image base to the value provided as the first argument to calculate the absolute memory address of the function. When set to <code>false</code> no changes to the first argument are made.</p>
<blockquote>
<p>To pass floating-point values to the function, convert the value to integer using <code>Memory.FromFloat</code>:</p>
<pre><code class="language-js">Memory.CallFunction(0x1234567, true, 1, Memory.FromFloat(123.456));
</code></pre>
<p>The returned value of the function called with <code>Memory.CallFunction</code> is ignored. To read the result use <code>Memory.CallFunctionReturn</code> that has the same parameters. Use <code>Memory.CallFunctionReturnFloat</code> to call a function that returns a floating-point value.</p>
</blockquote>
<p>A returned value of the function called with <code>Memory.CallFunction</code> is ignored. To read the result use <code>Memory.CallFunctionReturn</code> that has the same parameters. Use <code>Memory.CallFunctionReturnFloat</code> to call a function that returns a floating-point value.</p>
<p>CLEO Redux supports calling foreign functions with up to 16 parameters.</p>
<blockquote>
<p>The usage of any of the call methods requires the <code>mem</code> <a href="./permissions.html">permission</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/en/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/en/searchindex.json

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion docs/en/using-memory-64.html
Original file line number Diff line number Diff line change
Expand Up @@ -271,10 +271,12 @@ <h3 id="calling-foreign-functions"><a class="header" href="#calling-foreign-func
</code></pre>
<p>where <code>0xEFFB30</code> is the function offset relative to IMAGE BASE (think of it a randomized start address of the game memory), <code>true</code> is the <code>ib</code> flag (see below), <code>1</code> is the number of input arguments, and <code>13</code> are the only argument passed into the function.</p>
<p>The <code>ib</code> parameter in <code>Memory.CallFunction</code> has the same meaning as in memory read/write commands. When set to <code>true</code> CLEO adds the current known address of the image base to the value provided as the first argument to calculate the absolute memory address of the function. When set to <code>false</code> no changes to the first argument are made.</p>
<blockquote>
<p>To pass floating-point values to the function, convert the value to integer using <code>Memory.FromFloat</code>:</p>
<pre><code class="language-js">Memory.CallFunction(0x1234567, true, 1, Memory.FromFloat(123.456));
</code></pre>
<p>The returned value of the function called with <code>Memory.CallFunction</code> is ignored. To read the result use <code>Memory.CallFunctionReturn</code> that has the same parameters. Use <code>Memory.CallFunctionReturnFloat</code> to call a function that returns a floating-point value.</p>
</blockquote>
<p>A returned value of the function called with <code>Memory.CallFunction</code> is ignored. To read the result use <code>Memory.CallFunctionReturn</code> that has the same parameters. Use <code>Memory.CallFunctionReturnFloat</code> to call a function that returns a floating-point value.</p>
<p>CLEO Redux supports calling foreign functions with up to 16 parameters.</p>
<blockquote>
<p>The usage of any of the call methods requires the <code>mem</code> <a href="./permissions.html">permission</a>.</p>
Expand Down
4 changes: 3 additions & 1 deletion docs/en/using-memory.html
Original file line number Diff line number Diff line change
Expand Up @@ -307,9 +307,11 @@ <h3 id="calling-foreign-functions"><a class="header" href="#calling-foreign-func
</code></pre>
<p>The second parameter (<code>0x7001234</code>) is the object address. The <code>pop</code> parameter is always <code>0</code> (the method uses the <a href="https://en.wikipedia.org/wiki/X86_calling_conventions#thiscall">thiscall</a> convention).</p>
<p>To call the method and get the result out of it, use <code>Memory.CallMethodReturn</code>.</p>
<p>Note that all arguments are read as 32-bit signed integers. If you need to provide an argument of the float type, use <code>Memory.FromFloat</code>, e.g.</p>
<blockquote>
<p>Input arguments are treated as 32-bit signed integers. If you need to provide a floating-point number, use <code>Memory.FromFloat</code>, e.g.</p>
<pre><code class="language-js">Memory.CallFunction(0x1234567, 1, 1, Memory.FromFloat(123.456));
</code></pre>
</blockquote>
<p>CLEO Redux supports calling foreign functions with up to 16 parameters.</p>
<blockquote>
<p>The usage of any of the call methods requires the <code>mem</code> <a href="./permissions.html">permission</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h1 class="font-weight-bold d-flex justify-content-center">
data-translate="download"
>Download</a
>
<small class="pt-1 text-muted">v1.2.0 | June 19, 2023</small>
<small class="pt-1 text-muted">v1.2.1 | August 13, 2023</small>
</div>
</div>
</div>
Expand Down

0 comments on commit 2c853eb

Please sign in to comment.