Skip to content
This repository has been archived by the owner on Aug 12, 2022. It is now read-only.

Commit

Permalink
Merge pull request #6 from ShaneMaglangit/gene-quality
Browse files Browse the repository at this point in the history 
Update README.md and Documentation
  • Loading branch information
@ShaneMaglangit
ShaneMaglangit authored Aug 1, 2021
2 parents 8e645e2 + 8f0a436 commit 0eb25ea
Show file tree
Hide file tree
Showing 30 changed files with 708 additions and 330 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ Let us create an AxieGene object from the hex string that we have.
256 Bit Genes

```javascript
const { AxieGene } = require("agp-npm/dist/src/axie-gene"); // Defaults to HexType.Bit256
const { AxieGene } = require("agp-npm/dist/axie-gene"); // Defaults to HexType.Bit256
const axieGene = new AxieGene("0x11c642400a028ca14a428c20cc011080c61180a0820180604233082");
```

512 Bit Genes

```javascript
const { AxieGene } = require("agp-npm/dist/src/axie-gene");
const { AxieGene } = require("agp-npm/dist/axie-gene");
const hex = "0x280000000000010040412090830C0000000101942040440A00010190284082040001018C2061000A000101801021400400010180204080060001018418404008"
const axieGene = new AxieGene(hex, HexType.Bit512);
```
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

312 changes: 207 additions & 105 deletions docs/classes/axie_gene.AxieGene.html
View file

Large diffs are not rendered by default.

197 changes: 197 additions & 0 deletions docs/enums/axie_gene.HexType.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,197 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>HexType | agp-npm</title>
<meta name="description" content="Documentation for agp-npm">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">agp-npm</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">agp-npm</a>
</li>
<li>
<a href="../modules/axie_gene.html">axie-gene</a>
</li>
<li>
<a href="axie_gene.HexType.html">HexType</a>
</li>
</ul>
<h1>Enumeration HexType</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="axie_gene.HexType.html#Bit256" class="tsd-kind-icon">Bit256</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="axie_gene.HexType.html#Bit512" class="tsd-kind-icon">Bit512</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="Bit256" class="tsd-anchor"></a>
<h3>Bit256</h3>
<div class="tsd-signature tsd-kind-icon">Bit256<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 256</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ShaneMaglangit/agp-ts/blob/403f7f8/src/axie-gene.ts#L20">axie-gene.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="Bit512" class="tsd-anchor"></a>
<h3>Bit512</h3>
<div class="tsd-signature tsd-kind-icon">Bit512<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 512</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ShaneMaglangit/agp-ts/blob/403f7f8/src/axie-gene.ts#L21">axie-gene.ts:21</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/axie_gene.html">axie-<wbr>gene</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/models_bodySkin.html">models/body<wbr>Skin</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/models_cls.html">models/cls</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/models_color.html">models/color</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/models_gene.html">models/gene</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/models_internal_gene_bin_group.html">models/internal/gene-<wbr>bin-<wbr>group</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/models_part.html">models/part</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/models_pattern.html">models/pattern</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/models_region.html">models/region</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/models_tag.html">models/tag</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-enum tsd-parent-kind-module">
<a href="axie_gene.HexType.html" class="tsd-kind-icon">Hex<wbr>Type</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="axie_gene.HexType.html#Bit256" class="tsd-kind-icon">Bit256</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="axie_gene.HexType.html#Bit512" class="tsd-kind-icon">Bit512</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/axie_gene.AxieGene.html" class="tsd-kind-icon">Axie<wbr>Gene</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
30 changes: 15 additions & 15 deletions docs/enums/models_bodySkin.BodySkin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BodySkin | agp-ts</title>
<meta name="description" content="Documentation for agp-ts">
<title>BodySkin | agp-npm</title>
<meta name="description" content="Documentation for agp-npm">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
Expand All @@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">agp-ts</a>
<a href="../index.html" class="title">agp-npm</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">agp-ts</a>
<a href="../modules.html">agp-npm</a>
</li>
<li>
<a href="../modules/models_bodySkin.html">models/bodySkin</a>
Expand Down Expand Up @@ -82,8 +82,8 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="models_bodySkin.BodySkin.html#Default" class="tsd-kind-icon">Default</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="models_bodySkin.BodySkin.html#Frosty" class="tsd-kind-icon">Frosty</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="models_bodySkin.BodySkin.html#Normal" class="tsd-kind-icon">Normal</a></li>
</ul>
</section>
</div>
Expand All @@ -92,22 +92,22 @@ <h3>Enumeration members</h3>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="Default" class="tsd-anchor"></a>
<h3>Default</h3>
<div class="tsd-signature tsd-kind-icon">Default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;&quot;</span></div>
<a name="Frosty" class="tsd-anchor"></a>
<h3>Frosty</h3>
<div class="tsd-signature tsd-kind-icon">Frosty<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;frosty&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ShaneMaglangit/agp-ts/blob/dc172f9/src/models/bodySkin.ts#L3">models/bodySkin.ts:3</a></li>
<li>Defined in <a href="https://github.com/ShaneMaglangit/agp-ts/blob/403f7f8/src/models/bodySkin.ts#L4">models/bodySkin.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="Frosty" class="tsd-anchor"></a>
<h3>Frosty</h3>
<div class="tsd-signature tsd-kind-icon">Frosty<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;frosty&quot;</span></div>
<a name="Normal" class="tsd-anchor"></a>
<h3>Normal</h3>
<div class="tsd-signature tsd-kind-icon">Normal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ShaneMaglangit/agp-ts/blob/dc172f9/src/models/bodySkin.ts#L4">models/bodySkin.ts:4</a></li>
<li>Defined in <a href="https://github.com/ShaneMaglangit/agp-ts/blob/403f7f8/src/models/bodySkin.ts#L3">models/bodySkin.ts:3</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -159,10 +159,10 @@ <h3>Frosty</h3>
<a href="models_bodySkin.BodySkin.html" class="tsd-kind-icon">Body<wbr>Skin</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="models_bodySkin.BodySkin.html#Default" class="tsd-kind-icon">Default</a>
<a href="models_bodySkin.BodySkin.html#Frosty" class="tsd-kind-icon">Frosty</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="models_bodySkin.BodySkin.html#Frosty" class="tsd-kind-icon">Frosty</a>
<a href="models_bodySkin.BodySkin.html#Normal" class="tsd-kind-icon">Normal</a>
</li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 0eb25ea

Please sign in to comment.