Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mopsfl
mopsfl committed Jun 20, 2024
1 parent 971b356 commit 9a8eb15
Show file tree
Hide file tree
Showing 6 changed files with 96 additions and 35 deletions.
1 change: 0 additions & 1 deletion Docs.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,4 @@ jQuery(async () => {
_el.addEventListener("mouseleave", () => _copybtn.classList.add("copyhide"))
}
})

})
2 changes: 1 addition & 1 deletion dist/js/index.js
View file

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion dist/js/modules/Settings.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ class Settings {
["settings"]: {
["beautify_output"]: false,
["minify_output"]: false,
["test_slider"]: "50",
["target_lua_version"]: "5.3",
["chinese_nonsense_characters"]: true,
["ignore_bytecode"]: false,
Expand Down
117 changes: 86 additions & 31 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,17 @@
</head>

<body>
<div class="sidenavbtn-container">
<!--<div class="sidenavbtn-container">
<a href="#" data-target="slide-out" class="sidenav-trigger btn-floating transparent waves-effect waves-circle waves-light"><i class="material-icons">menu</i></a>
</div>
</div>-->
<!--Container-->
<div class="main container">
<header class="header left-align">
<img class="responsive-img headerlogo" src="/images/icons/icon-72x72.png">
<h5>GoofyLuaUglifier - API Documentation <small style="font-size: 10px; font-weight: bold;">IN WORK</small></h5>
</header>

<!--Main-->
<main class="docs">
<ul id="slide-out" class="sidenav white-text">
<li><a class="subheader white-text sidenav-headertext">
Expand All @@ -40,17 +42,17 @@ <h5>GoofyLuaUglifier</h5>
<li><a class="waves-effect white-text waves-light sidenav-hrefbutton" href="#uglifier-options">Uglifier Options</a></li>
</ul>

<!--Endpoints-->
<ul class="collapsible docs-collapsible-item no-border" id="endpoints">
<li>
<div class="collapsible-header transparent no-border">
<span class="collapsible-item"><i class="material-icons collapsible-icon">chevron_right</i><span class="collapsible-item-text">Endpoints</span></span>
<span class="collapsible-item"><i class="material-icons collapsible-icon">chevron_right</i><span class="collapsible-item-text">API Endpoints</span></span>
</div>
<div class="collapsible-body no-border">
<p class="docs-endpoint-header">Uglify:</p>
<p class="docs-endpoint-desc">Uglififes your script with the given function name / function chain.</p>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">POST</span>
<span class="docs-endpoint-path" data-copycontent="https://goofyluauglifier.mopsfl.de/v1/api/uglify/&lt;function_name/chain&gt;">/v1/api/uglify/&lt;function_name&gt;,...</span>
<span class="docs-endpoint-method green">POST</span><span class="docs-endpoint-path" data-copycontent="https://goofyluauglifier.mopsfl.de/v1/api/uglify/&lt;function_name/chain&gt;">/v1/api/uglify/&lt;function_name&gt;,...</span>
<span class="docs-endpoint-copy green copyhide">Copy</span>
</div>
<p class="divider"></p>
Expand All @@ -67,13 +69,11 @@ <h5>GoofyLuaUglifier</h5>
</div>
<div class="collapsible-body no-border">
<div class="docs-endpoint">
<span class="docs-endpoint-method green">object</span>
<span class="docs-endpoint-path">uglifier-options?: <a href="#uglifier-options">&lt;UglifierOptions&gt;</a></span>
<span class="docs-endpoint-method green">object</span><span class="docs-endpoint-path">uglifier-options?: <a href="#uglifier-options">&lt;UglifierOptions&gt;</a></span>
<span class="docs-endpoint-desc-right">The options you want to used for this uglification. (optional)</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">string</span>
<span class="docs-endpoint-path">api-key?</span>
<span class="docs-endpoint-method green">string</span><span class="docs-endpoint-path">api-key?</span>
<span class="docs-endpoint-desc-right">Your API key, required to fulfill and identify your request. (optional)</span>
</div>
</div>
Expand All @@ -86,33 +86,27 @@ <h5>GoofyLuaUglifier</h5>
</div>
<div class="collapsible-body no-border">
<div class="docs-endpoint">
<span class="docs-endpoint-method green">object</span>
<span class="docs-endpoint-path">uglifier-options: <a href="#uglifier-options">&lt;UglifierOptions&gt;</a></span>
<span class="docs-endpoint-method green">object</span><span class="docs-endpoint-path">uglifier-options: <a href="#uglifier-options">&lt;UglifierOptions&gt;</a></span>
<span class="docs-endpoint-desc-right">The options that were used for this uglification.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">string</span>
<span class="docs-endpoint-path">uglifier-function</span>
<span class="docs-endpoint-method green">string</span><span class="docs-endpoint-path">uglifier-function</span>
<span class="docs-endpoint-desc-right">The used function / function chain for this uglification.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">number</span>
<span class="docs-endpoint-path">uglifier-ms-time</span>
<span class="docs-endpoint-method green">number</span><span class="docs-endpoint-path">uglifier-ms-time</span>
<span class="docs-endpoint-desc-right">How long the uglification took on the server.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">number</span>
<span class="docs-endpoint-path">x-ratelimit-limit</span>
<span class="docs-endpoint-method green">number</span><span class="docs-endpoint-path">x-ratelimit-limit</span>
<span class="docs-endpoint-desc-right">The rate limit ceiling that is applicable for the current request.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">number</span>
<span class="docs-endpoint-path">x-ratelimit-remaining</span>
<span class="docs-endpoint-method green">number</span><span class="docs-endpoint-path">x-ratelimit-remaining</span>
<span class="docs-endpoint-desc-right">The number of requests left for the current rate-limit window.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">number</span>
<span class="docs-endpoint-path">x-ratelimit-reset</span>
<span class="docs-endpoint-method green">number</span><span class="docs-endpoint-path">x-ratelimit-reset</span>
<span class="docs-endpoint-desc-right">The time at which the rate limit resets. (UTC epoch time in seconds)</span>
</div>
</div>
Expand All @@ -130,17 +124,15 @@ <h5>GoofyLuaUglifier</h5>
<blockquote>
<p class="docs-endpoint-desc">Uglify your script with one function.</p>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">POST</span>
<span class="docs-endpoint-path" data-copycontent="https://goofyluauglifier.mopsfl.de/v1/api/uglify/bytestrings">/v1/api/uglify/bytestrings</span>
<span class="docs-endpoint-method green">POST</span><span class="docs-endpoint-path" data-copycontent="https://goofyluauglifier.mopsfl.de/v1/api/uglify/bytestrings">/v1/api/uglify/bytestrings</span>
<span class="docs-endpoint-copy green copyhide">Copy</span>
</div>
</blockquote>

<blockquote>
<p class="docs-endpoint-desc">You can also specify a function chain to uglify your script with multiple functions at once. (functions are applied by order from left to right)</p>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">POST</span>
<span class="docs-endpoint-path" data-copycontent="https://goofyluauglifier.mopsfl.de/v1/api/uglify/bytestrings,transformnums,minify">/v1/api/uglify/bytestrings,transformnums,minify</span>
<span class="docs-endpoint-method green">POST</span><span class="docs-endpoint-path" data-copycontent="https://goofyluauglifier.mopsfl.de/v1/api/uglify/bytestrings,transformnums,minify">/v1/api/uglify/bytestrings,transformnums,minify</span>
<span class="docs-endpoint-copy green copyhide">Copy</span>
</div>
</blockquote>
Expand All @@ -153,21 +145,84 @@ <h5>GoofyLuaUglifier</h5>

<p class="divider"></p>

<ul class="collapsible docs-collapsible-item no-border" id="uglifier-options">
<li>
<!--Uglifier Options-->
<ul class="collapsible docs-collapsible-item no-border" id="functions">
<li class="active">
<div class="collapsible-header transparent no-border">
<span class="collapsible-item"><i class="material-icons collapsible-icon">chevron_right</i><span class="collapsible-item-text">Functions</span></span>
<span class="collapsible-item"><i class="material-icons collapsible-icon">chevron_right</i><span class="collapsible-item-text">Uglifier Options</span></span>
</div>
<div class="collapsible-body no-border">
<div class="docs-endpoint">
<span class="docs-endpoint-method green">boolean</span><span class="docs-endpoint-path">beautify_output</span>
<span class="docs-endpoint-desc-right">Beautifies the output code after the uglification.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">boolean</span><span class="docs-endpoint-path">minify_output</span>
<span class="docs-endpoint-desc-right">Minifies the output code after the uglification.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">boolean</span><span class="docs-endpoint-path">chinese_nonsense_characters</span>
<span class="docs-endpoint-desc-right">If the <code>Nonsense Strings</code> function should use chinese characters.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">boolean</span><span class="docs-endpoint-path">ignore_bytecode</span>
<span class="docs-endpoint-desc-right">Ignore any bytecode string. (e.g. when using <code>Bytestrings</code>)</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">boolean</span><span class="docs-endpoint-path">ignore_bytestring</span>
<span class="docs-endpoint-desc-right">Ignore any encrypted byte string.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">boolean</span><span class="docs-endpoint-path">byte_encrypt_all_constants</span>
<span class="docs-endpoint-desc-right">If the <code>Bytestrings</code> function should also encrypt booleans and numbers.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">boolean</span><span class="docs-endpoint-path">rename_global_functions</span>
<span class="docs-endpoint-desc-right">If global function names should be renamed by the <code>Identifiers</code> function.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">boolean</span><span class="docs-endpoint-path">use_all_mathoperators_number_transform</span>
<span class="docs-endpoint-desc-right">Use all math operators for the number transform (<code>/</code> and <code>*</code>).</b></span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">boolean</span><span class="docs-endpoint-path">memoize_function_calls</span>
<span class="docs-endpoint-desc-right">Memoizes expensive function calls and caches them to avoid redundant computations.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">string</span><span class="docs-endpoint-path">target_lua_version</span>
<span class="docs-endpoint-desc-right">For what lua version your script should be optimized for.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">string</span><span class="docs-endpoint-path">watermark</span>
<span class="docs-endpoint-desc-right">Adds a useless watermark to your script.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">string</span><span class="docs-endpoint-path">bytecode_watermark</span>
<span class="docs-endpoint-desc-right">Adds a protected watermark to your bytecode when using <code>Constant Chunk 2</code> function.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">string</span><span class="docs-endpoint-path">table_length_number_memestrings</span>
<span class="docs-endpoint-desc-right">Adds your given strings into the <code>Table Length</code> function values.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">number</span><span class="docs-endpoint-path">table_length_number_rate</span>
<span class="docs-endpoint-desc-right">Rate of the random table values for the <code>Table Length</code> function.</span>
</div>
<div class="docs-endpoint">
<span class="docs-endpoint-method green">number</span><span class="docs-endpoint-path">number_transform_offset_length</span>
<span class="docs-endpoint-desc-right">The length of the random transform offset number when using <code>Numbers</code> or <code>Booleans</code>.</span>
</div>
</div>
<div class="collapsible-body no-border"><span>Lorem ipsum dolor sit amet.</span></div>
</li>
</ul>

<p class="divider"></p>

<ul class="collapsible docs-collapsible-item no-border" id="functions">
<!--Functions-->
<ul class="collapsible docs-collapsible-item no-border" id="uglifier-options">
<li>
<div class="collapsible-header transparent no-border">
<span class="collapsible-item"><i class="material-icons collapsible-icon">chevron_right</i><span class="collapsible-item-text">Uglifier Options</span></span>
<span class="collapsible-item"><i class="material-icons collapsible-icon">chevron_right</i><span class="collapsible-item-text">Functions</span></span>
</div>
<div class="collapsible-body no-border"><span>Lorem ipsum dolor sit amet.</span></div>
</li>
Expand Down
9 changes: 9 additions & 0 deletions docs/style.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,21 @@ blockquote {
padding-left: 5px;
padding-right: 5px;
width: auto;
min-width: 75px;
text-align: center;
border-radius: 2px;
height: auto;
display: inline-block;
}

.docs-endpoint-method {
user-select: none;
}

.docs-endpoint-path {
margin-left: 10px;
}

.docs-endpoint-copy {
float: right;
transition: opacity .2s;
Expand Down
1 change: 0 additions & 1 deletion modules/Settings.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ export default class Settings {
["settings"]: {
["beautify_output"]: false,
["minify_output"]: false,
["test_slider"]: "50",
["target_lua_version"]: "5.3",
["chinese_nonsense_characters"]: true,
["ignore_bytecode"]: false,
Expand Down

0 comments on commit 9a8eb15

Please sign in to comment.