endernon/wynnbuilder-forked-for-changes
1
0
Fork 0
forked from morphNon/wynnbuilder-idk
Code Pull requests Activity

documentation page prototype

Browse source
This commit is contained in:
ferricles 2022-05-25 12:57:20 -07:00
parent b44176804c
commit 827f9f11d5
5 changed files with 306 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
builder/index.html
View file

@ -1322,7 +1322,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="container h-75 mx-0 mx-lg-auto dark-2 border border-4 scaled-font align-self-center" style="position: fixed; z-index: 2; overflow: auto; display: none;" id="search-container"> <div class="container h-75 mx-0 mx-lg-auto dark-2 border border-4 scaled-font align-self-center" style="position: fixed; z-index: 2000; overflow: auto; display: none;" id="search-container">
<div class="row justify-content-end"> <div class="row justify-content-end">
<div class="col-auto"> <div class="col-auto">
<button type="button" class="btn-close btn-close-white" aria-label="Close" onclick="document.querySelector('#search-container').style.display = 'none';"></button> <button type="button" class="btn-close btn-close-white" aria-label="Close" onclick="document.querySelector('#search-container').style.display = 'none';"></button>

85
css/dev.css Normal file
View file

@ -0,0 +1,85 @@
/* General Styling - used for all elements on /dev/ */
.row > * {
margin-bottom: 0.75rem;
margin-left: 0.5rem;
padding-left: 0 !important; /*Override grid.scss (bs) */
}
.row {
overflow-wrap: break-word;
}
.section {
margin-top: 1rem;
margin-bottom: 1rem;
margin-left: 0.5rem;
margin-right: 0.5rem;
border-left: 3px solid white;
border-radius: 0.1rem;
/* padding-right: 0rem !important;
padding-left: 0rem !important; */
}
.section-title:hover{
font-weight: bold;
}
.section-title {
margin-bottom: 1.5rem;;
}
ul {
/*Needed to override <ul> style in sq2bs.css*/
list-style-type: circle;
}
.indent {
margin-left: 2rem;
}
/* Math */
math, number {
font-family: 'CMU Serif', 'Cambria Math', 'Times New Roman', serif;
}
number {
color: rgb(17, 234, 9);
}
.full-width {
width: 100%;
text-align: center;
}
/* Variable Sizing (specific to dev page) */
@media screen and (max-width: 600px) {
.section-title > * {
font-size: 3.5rem;
}
.page-title {
font-size: 6rem;
}
}
@media screen and (min-width: 600px) and (max-width: 1400px) {
.section-title > * {
font-size: 1.25rem;
}
.page-title {
font-size: 4rem;
}
}
@media screen and (min-width: 1400px) {
.section-title > *{
font-size: 1.5rem;
}
.page-title {
font-size: 4.5rem;
}
}

138
dev/index.html
View file

@ -1,5 +1,6 @@
<!DOCTYPE html> <!DOCTYPE html>
<html scroll-behavior="smooth"> <html scroll-behavior="smooth">
<head> <head>
<title>WynnBuilder Dev</title> <title>WynnBuilder Dev</title>
<link rel="icon" href="../media/icons/new/atlas64.png"> <link rel="icon" href="../media/icons/new/atlas64.png">
@ -13,31 +14,146 @@
<link href="https://fonts.googleapis.com/css2?family=Nunito&display=swap" rel="stylesheet"> <link href="https://fonts.googleapis.com/css2?family=Nunito&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Nunito&display=swap" rel="stylesheet"> <link href="https://fonts.googleapis.com/css2?family=Nunito&display=swap" rel="stylesheet">
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous"> <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet"
integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tarekraafat/autocomplete.js@10.2.6/dist/css/autoComplete.min.css"> <link rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/@tarekraafat/autocomplete.js@10.2.6/dist/css/autoComplete.min.css">
<link rel="stylesheet" href="../css/sq2bs.css"> <link rel="stylesheet" href="../css/sq2bs.css">
<link rel="stylesheet" href="../css/sidebar.css"> <link rel="stylesheet" href="../css/sidebar.css">
<link rel="stylesheet" href="../css/wynnstyles.css"> <link rel="stylesheet" href="../css/wynnstyles.css">
<link rel="stylesheet" href="../css/dev.css">
</head> </head>
<body id="body" class="all" style="overflow-y: scroll"> <body id="body" class="all" style="overflow-y: scroll">
<div id="main-sidebar" class="sidebar dark-7 dark-shadow"> <div id="main-sidebar" class="sidebar dark-7 dark-shadow">
<a href = "../builder/"><img src="../media/icons/new/builder.png" alt = "WynnBuilder" title = "WynnBuilder"><b>WynnBuilder</b></a> <a href="../builder/"><img src="../media/icons/new/builder.png" alt="WynnBuilder"
<a href = "../crafter/"><img src = "../media/icons/new/crafter.png" alt = "WynnCrafter" title = "WynnCrafter"><b>WynnCrafter</b></a> title="WynnBuilder"><b>WynnBuilder</b></a>
<a href = "../items/"><img src = "../media/icons/new/searcher.png" alt = "WynnAtlas" title = "WynnAtlas"><b>WynnAtlas</b></a> <a href="../crafter/"><img src="../media/icons/new/crafter.png" alt="WynnCrafter"
<a href = "../custom/"><img src = "../media/icons/new/custom.png" alt = "WynnCustom" title = "WynnCustom"><b>WynnCustom</b></a> title="WynnCrafter"><b>WynnCrafter</b></a>
<a href="../items/"><img src="../media/icons/new/searcher.png" alt="WynnAtlas"
title="WynnAtlas"><b>WynnAtlas</b></a>
<a href="../custom/"><img src="../media/icons/new/custom.png" alt="WynnCustom"
title="WynnCustom"><b>WynnCustom</b></a>
<a href="../map/"><img src="../media/icons/new/compass.png" alt="WynnGPS" title="WynnGPS"><b>WynnGPS</b></a> <a href="../map/"><img src="../media/icons/new/compass.png" alt="WynnGPS" title="WynnGPS"><b>WynnGPS</b></a>
<a href = "../wynnfo/"><img src = "../media/icons/new/book.png" alt = "Wynnfo" title = "WynnCrafter"><b>WynnCrafter</b></a> <a href="../wynnfo/"><img src="../media/icons/new/book.png" alt="Wynnfo"
<a onclick = "toggleIcons()"><img src = "../media/icons/new/reload.png" alt = "" title = "Swap items on page"><b>Swap Icon Style</b></a> title="WynnCrafter"><b>WynnCrafter</b></a>
<a href="" onclick="toggleIcons()"><img src="../media/icons/new/reload.png" alt=""
title="Swap items on page"><b>Swap Icon Style</b></a>
<hr /> <hr />
</div> </div>
<div class = "container"> <div class="container text-light px-5 scaled-font">
<div class="row justify-content-center page-title">
Wynnbuilder Developer Page
</div>
<div class="row"> <div class="row">
bruh Welcome to the Wynnbuilder page for developers! Here we provide documentation and specifications for our
website. Read through these sections to learn more about how WynnBuilder works!
</div> </div>
<div class="row section" title="Encoding and Decoding WynnBuilder links">
<p>
This section is about the encoding schemes Wynnbuilder uses for its various saveable items (builds,
crafted items, and custom items).
</p>
<p>
We use a Base 64 encode/decode system in most shareable links. It would be quite clunky to put a
bunch of numbers (the data we save and read) into one link. To save some space, we compress the
base 10 numerical alphabet into a custom base 64 alphabet.
</p>
<div class="row section" title="WB Base 64">
<p>
The Wynnbuilder Base 64 character table:
</p>
<code class="full-width">
0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+-
</code>
<p>
The Base 64 encoding of a number (in the 0 to 63 range) is equal to the character at the index
within the above string.
</p>
<p>
For example, if we have a set of items with id numbers in the range [<number>0</number>,
<number>10000</number>], we need at most 3 base 64 characters to encode any of these items
in the link! The item of id <number>1337</number> corresponds to the Base64 hash <code>0Kv</code>:
<math>1337 = 0 * 4096 + 20 * 64 + 57</math>, <number>0</number> maps to <code>0</code>,
<number>20</number> maps to <code>K</code>, and <number>57</number> maps to <code>v</code>.
</p>
</div> </div>
<script type="text/javascript" src="../js/"></script> <p>
Now that we understand the base 64 system, we can move on to the way builds, crafted items, and custom items are stored in links.
</p>
<div class="row section" title="Builds">
<p>
First, what do we need in order to encode an entire build?
</p>
<p>
Wynnbuilder mainly runs calculations for damages and defense. Therefore, we need:
</p>
<ul class="indent">
<li>The build's items (equipment, tomes)</li>
<li>The skill points distributed by the user (and user level)</li>
<li>Item powderings</li>
</ul>
<p>
Wynnbuilder assigns each item in the Wynncraft item pool to a unique ID number. For example, the bracelet <b class="atlas">Atlas</b>
has an id number of <number>167</number>. We can then store all of a build's item pool items in a link with the items' id numbers. A
similar idea is used for skill points and powders. However, we know how many different skills there are already (5), so we can encode
the user's assignment of skill points in 5 numbers. With powders, it's a little different. There are 31 "states" of powder: 1 for no
powder and then 5 elements with 6 tiers of powder for each element. We will know how many available powder slots we have based on our
equipment. We can then put all of these numbers in a specific order (after running Base 64 encoding) to get our build link.
</p>
<p>
All build links will end in "#[version number]_[build hash]".
</p>
<div class="row section" title="Version 6">
<code class="full-width">
</code>
</div>
<div class="row section" title="Version 5">
<p>
</p>
</div>
<div class="row section" title="Version 4">
<p>
</p>
</div>
<div class="row section" title="Version 3">
<p>
</p>
</div>
<div class="row section" title="Version 2">
<p>
</p>
</div>
<div class="row section" title="Version 1">
<p>
</p>
</div>
</div>
<div class="row section" title="Crafted Items">
</div>
<div class="row section" title="Custom Items">
</div>
<p>
Last updated: 25 May 2022
</p>
</div>
<div class="row section" title="Test Section">
</div>
</div>
<script type="text/javascript" src="../js/dev.js"></script>
<script type="text/javascript" src="../js/sq2icons.js"></script>
</body> </body>
</html> </html>

2
items_adv/items_2_help.html
View file

@ -220,6 +220,6 @@
docsFns.append(genDocEntry(entry[0], entry[1], null, entry[2])); docsFns.append(genDocEntry(entry[0], entry[1], null, entry[2]));
} }
</script> </script>
<!-- <script type="text/javascript" src="/js/icons.js"></script> --> <script type="text/javascript" src="../js/sq2icons.js"></script>
</body> </body>
</html> </html>

67
js/dev.js Normal file
View file

@ -0,0 +1,67 @@
function init_dev() {
let sections = document.getElementsByClassName("section");
for (const section of sections) {
//so clicking works
section.classList.add("down");
//add title and toggle character
let title_row = document.createElement("div");
title_row.classList.add("row", "section-title");
let title = document.createElement("div");
title.classList.add("col");
title.textContent = section.title ? section.title : "";
title_row.appendChild(title);
section.insertBefore(title_row, section.firstChild);
let toggle_char = document.createElement("div");
toggle_char.classList.add("col-auto", "arrow");
toggle_char.textContent = "V";
title_row.appendChild(toggle_char);
title_row.addEventListener("click", (event) =>
{
toggleSection(section);
}, false);
for (const child of section.children) {
if (!child.classList.contains("section-title")) {
child.style.display = "none";
}
}
}
}
/*
Toggles section content as well as up and down arrow
@params:
*/
function toggleSection(section) {
//has down arrow (default state)
let down = section.classList.contains("down");
let arrow_elem = section.getElementsByClassName("arrow")[0];
if (down) {
section.classList.remove("down");
section.classList.add("up");
arrow_elem.style.transform = 'rotate(180deg)';
for (const elem of section.children) {
if (!elem.classList.contains("section-title")) {
elem.style.display = "";
}
}
} else {
section.classList.remove("up");
section.classList.add("down");
arrow_elem.style.transform = 'rotate(0deg)';
for (const elem of section.children) {
if (!elem.classList.contains("section-title")) {
elem.style.display = "none";
}
}
}
}
init_dev();