- {{^_disableToc}} - {{>partials/toc}} -
- {{/_disableToc}} - {{#_disableToc}} -
- {{/_disableToc}} - {{#_disableAffix}} -
- {{/_disableAffix}} - {{^_disableAffix}} -
- {{/_disableAffix}} -
- {{!body}} -
-
- {{^_disableAffix}} - {{>partials/affix}} - {{/_disableAffix}} -
-
- {{^_disableFooter}} - {{>partials/footer}} - {{/_disableFooter}} -
- {{>partials/scripts}} - - diff --git a/templates/minimal/partials/footer.tmpl.partial b/templates/minimal/partials/footer.tmpl.partial deleted file mode 100644 index d617102..0000000 --- a/templates/minimal/partials/footer.tmpl.partial +++ /dev/null @@ -1,14 +0,0 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - -
-
-
-
- - {{__global.backToTop}} - - {{{_appFooter}}} - {{^_appFooter}}Generated by DocFX{{/_appFooter}} -
-
-
diff --git a/templates/minimal/partials/navbar.tmpl.partial b/templates/minimal/partials/navbar.tmpl.partial deleted file mode 100644 index 1e7379e..0000000 --- a/templates/minimal/partials/navbar.tmpl.partial +++ /dev/null @@ -1,22 +0,0 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - - diff --git a/templates/minimal/partials/toc.tmpl.partial b/templates/minimal/partials/toc.tmpl.partial deleted file mode 100644 index 540543f..0000000 --- a/templates/minimal/partials/toc.tmpl.partial +++ /dev/null @@ -1,8 +0,0 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - -
- -
-
-
-
diff --git a/templates/minimal/styles/main.css b/templates/minimal/styles/main.css deleted file mode 100644 index 0301eed..0000000 --- a/templates/minimal/styles/main.css +++ /dev/null @@ -1,79 +0,0 @@ -.sidefilter, .sidetoc, #toc { - background-color: #FFFFFF; - border-left: #FFFFFF; -} - -.navbar-default, .navbar, .navbar-collapse { - border-color: #e7e7e7; -} - -.toc-filter { - border: 1px solid #e7e7e7; -} - -.navbar .navbar-nav > .active > a,.navbar .navbar-nav > li > a { - color: #000000; - background-color: #FFFFFF; -} - -.navbar .navbar-nav > .active > a:focus, .navbar .navbar-nav > .active > a:hover,.navbar .navbar-nav > li > a:hover { - color: #9d9d9d; - background-color: #FFFFFF; -} - -.grad-bottom { - height: 0px; -} - -.footer { - background-color: #FFFFFF; -} - -.navbar-brand > img { - padding: 10px 15px; - height: 50px; -} - -.sidetoc.shiftup { - bottom: 0px; -} - -.sidetoc { - top: 110px; -} - -.sidefilter { - top: 50px; -} - -.icon-bar { - background-color: black; -} - -.btn { - text-align: left; -} - -.sidenav, .fixed_header, .toc { - background-color: #FFFFFF; -} - -.toc > ul { - text-align: left; -} - -body { - font-size: 16px; -} - -header { - background-color: #FFFFFF; -} - -.toc .nav > li { - display: block; -} - -.toc li:after { - content: ""; -} \ No newline at end of file diff --git a/toc.yml b/toc.yml deleted file mode 100644 index 400a987..0000000 --- a/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Docs - href: docs/ \ No newline at end of file diff --git a/docfx.json b/wwwroot/docfx.json similarity index 58% rename from docfx.json rename to wwwroot/docfx.json index f562298..2be6b4f 100644 --- a/docfx.json +++ b/wwwroot/docfx.json @@ -20,15 +20,21 @@ "output": "_site", "template": [ "default", - "templates/minimal" + "modern", + "templates/material", + "templates/custom" ], "globalMetadata": { - "_appName": "tkmm-wiki", - "_appTitle": "TKMM Wiki Home", + "_appName": "TotK Mod Manager", + "_appTitle": "TKMM", "_enableSearch": true, - "_appLogoPath": "images/icon.png", + "_appLogoPath": "images/icon.ico", "_appFaviconPath": "images/icon.ico", + "_appFooter": "
© TKMM Team, 2023-2024
", "pdf": true - } + }, + "postProcessors": [ + "ExtractSearchIndex" + ] } } \ No newline at end of file diff --git a/docs/getting-started.md b/wwwroot/docs/getting-started/index.md similarity index 100% rename from docs/getting-started.md rename to wwwroot/docs/getting-started/index.md diff --git a/wwwroot/docs/index.md b/wwwroot/docs/index.md new file mode 100644 index 0000000..cc33018 --- /dev/null +++ b/wwwroot/docs/index.md @@ -0,0 +1 @@ +# Docs \ No newline at end of file diff --git a/docs/introduction.md b/wwwroot/docs/introduction/index.md similarity index 100% rename from docs/introduction.md rename to wwwroot/docs/introduction/index.md diff --git a/wwwroot/docs/toc.yml b/wwwroot/docs/toc.yml new file mode 100644 index 0000000..e344357 --- /dev/null +++ b/wwwroot/docs/toc.yml @@ -0,0 +1,6 @@ +- name: Docs + href: index.md +- name: Introduction + href: introduction/ +- name: Getting Started + href: getting-started/ diff --git a/wwwroot/download/index.md b/wwwroot/download/index.md new file mode 100644 index 0000000..3be8ffa --- /dev/null +++ b/wwwroot/download/index.md @@ -0,0 +1 @@ +# Download \ No newline at end of file diff --git a/wwwroot/download/setup/index.md b/wwwroot/download/setup/index.md new file mode 100644 index 0000000..d1068c9 --- /dev/null +++ b/wwwroot/download/setup/index.md @@ -0,0 +1 @@ +# Setup \ No newline at end of file diff --git a/wwwroot/download/toc.yml b/wwwroot/download/toc.yml new file mode 100644 index 0000000..409aaec --- /dev/null +++ b/wwwroot/download/toc.yml @@ -0,0 +1,4 @@ +- name: Download + href: index.md +- name: Setup + href: setup/ diff --git a/wwwroot/faq/index.md b/wwwroot/faq/index.md new file mode 100644 index 0000000..7aa8f6a --- /dev/null +++ b/wwwroot/faq/index.md @@ -0,0 +1 @@ +# FaQ \ No newline at end of file diff --git a/wwwroot/faq/toc.yml b/wwwroot/faq/toc.yml new file mode 100644 index 0000000..dafb922 --- /dev/null +++ b/wwwroot/faq/toc.yml @@ -0,0 +1,2 @@ +- name: FaQ + href: index.md diff --git a/wwwroot/images/Icon-Transparent-1024.png b/wwwroot/images/Icon-Transparent-1024.png new file mode 100644 index 0000000..f4dce56 Binary files /dev/null and b/wwwroot/images/Icon-Transparent-1024.png differ diff --git a/images/icon.ico b/wwwroot/images/icon.ico similarity index 100% rename from images/icon.ico rename to wwwroot/images/icon.ico diff --git a/images/icon.png b/wwwroot/images/icon.png similarity index 100% rename from images/icon.png rename to wwwroot/images/icon.png diff --git a/wwwroot/index.md b/wwwroot/index.md new file mode 100644 index 0000000..9ea2eeb --- /dev/null +++ b/wwwroot/index.md @@ -0,0 +1,73 @@ +--- +_layout: landing +--- + +
+ +

Tears of the Kingdom Mod Manager

+
+ +

+ + Releases' YouTube +   + + Discord +   + + Stars + +

+ +[![]("https://gamebanana.com/wips/embeddables/81203?type=medium")](https://gamebanana.com/wips/81203) + +**TKMM**, an acronym for **T**ears of the **K**ingdom **M**od **M**anager, is a versatile tool crafted to streamline modding across multiple platforms for the game *Tears Of The Kingdom*. **TKMM** utilizes and seamlessly integrates with various mod merging tools, delivering a quick and satisfying experience for modders, and end users alike. + +

+ + Issues +   + + Open Pull Requests +   + + Closed Pull Requests + +

+ +## Mod Merging + +TKMM integrates with multiple mod merging tools to support the seamless combination of various file types. + +### Current Supported File Types + +* **ResourceSizeTable** [LordBubbles's](https://github.com/MasterBubbles) branch of [dt12345]()'s restbl tool has been curated for maximum efficiency, and convienience! +* **RSDB** *(Tag.Product, PouchActorInfo, GameActorInfo, etc.)* inspired by [Legend5v's](https://gamebanana.com/members/2731522)'s original code, [Lord Bubbles's](https://github.com/MasterBubbles) [RSDB merger](https://github.com/MasterBubbles/rsdb-merge) is easy to use, and very efficient. +* **Localization (Mals)** created by [Arch Leaders](https://github.com/ArchLeaders), his [MalsMerger](https://github.com/ArchLeaders/MalsMerger) is lightning fast, ensuring you recieve your merged files as fast as possible. +* **SARC Archives (.pack)** created by [Mika](https://github.com/okmika), his [SARC and BYML Merger](https://github.com/okmika/TKMM-SARC) is fast, efficient, and well written. +* **BYML Files (.byml, .bgyml)** +* **ShopParam Exceptions** created by [Mika](https://github.com/okmika), [Bubbles](https://github.com/MasterBubbles), and [5th](https://github.com/The5thTear), the ShopParam handler will prevent errors in regards with too many shop entries, allowing users to order their overflow shops and keep their mods from breaking. + +## Contributions and Special Thanks + +* **Arch Leaders**: UI Support + Development, Understanding and Major Help. New BYML Lib, MalsMerger, Fixing MessageStudio, being good and genuine +* **Lord Bubbles**: RSDB Merger, RSTB Calculator, Feedback, Being Awesome +* **Mika**: SARC + BYML Merger, Speed +* **Aster**: Graphic Design, Original Idea, Feedback, Fun +* **The5thTear**: UI, and Tool Dev, Documentation, Screaming for Help +* **Alciel**: Moderation and Beta Testing +* **Godzilla4**: Moderation and Beta Testing +* **mr.the**: Beta Testing + Feedback +* **Legend5v**: Original RSDB-Merger Code +* **Watertoon**: Documentation +* **dt12345**: Extensive Knowledge, TotK Script Repo :) +* **tom** (gamebanana staff) - One-Click Install Support +* **xPretorianx**: Supporter +* **vintii**: Supporter +* **Mindstormman**: Supporter +* **King Of The Gnomes**: Beta Testing +* **Rennai**: Affiliation/Promotion + +[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/TKMM-Team/Tkmm/blob/master/License.md) + +*Join our Discord community [here](https://discord.com/invite/3tNUBWQRXv) if you'd like to contribute to the development of **TKMM**. Your insights and collaboration are highly valued!* diff --git a/wwwroot/learn/index.md b/wwwroot/learn/index.md new file mode 100644 index 0000000..9839dcc --- /dev/null +++ b/wwwroot/learn/index.md @@ -0,0 +1 @@ +# Learn \ No newline at end of file diff --git a/wwwroot/learn/toc.yml b/wwwroot/learn/toc.yml new file mode 100644 index 0000000..3357cbd --- /dev/null +++ b/wwwroot/learn/toc.yml @@ -0,0 +1,2 @@ +- name: Learn + href: index.md diff --git a/wwwroot/templates/custom/public/main.css b/wwwroot/templates/custom/public/main.css new file mode 100644 index 0000000..bbc1e31 --- /dev/null +++ b/wwwroot/templates/custom/public/main.css @@ -0,0 +1,32 @@ +@import url('https://fonts.googleapis.com/css2?family=Fira+Sans:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap'); + +:root { + --bs-font-sans-serif: 'Fira Sans'; +} + +[data-bs-theme=dark] { + --bs-body-bg: #1e1e1e; + --bs-body-bg-rgb: 34, 34, 34; +} + +p { + font-size: 1.1rem; +} + +a { + text-decoration: none; +} + +.content { + margin-left: 15vh; + margin-right: 15vh; +} + +#logo { + width: 40px; + margin-right: 12px; +} + +#copyright { + text-align: center; +} \ No newline at end of file diff --git a/wwwroot/templates/material/public/main.css b/wwwroot/templates/material/public/main.css new file mode 100644 index 0000000..06fd6a7 --- /dev/null +++ b/wwwroot/templates/material/public/main.css @@ -0,0 +1,182 @@ +@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@100;400;700&display=swap'); + +:root { + --bs-font-sans-serif: 'Roboto'; + --bs-border-radius: 10px; + + --border-radius-button: 40px; + --card-box-shadow: 0 1px 2px 0 #3d41440f, 0 1px 3px 1px #3d414429; + + --material-yellow-light: #e6dfbf; + --material-yellow-dark: #5a5338; + + --material-blue-light: #c4d9f1; + --material-blue-dark: #383e5a; + + --material-red-light: #f1c4c4; + --material-red-dark: #5a3838; + + --material-warning-header: #f57f171a; + --material-warning-background: #f6e8bd; + --material-warning-background-dark: #57502c; + + --material-info-header: #1976d21a; + --material-info-background: #e3f2fd; + --material-info-background-dark: #2c4557; + + --material-danger-header: #d32f2f1a; + --material-danger-background: #ffebee; + --material-danger-background-dark: #572c2c; +} + +/* HEADINGS */ + +h1 { + font-weight: 600; + font-size: 32px; +} + +h2 { + font-weight: 600; + font-size: 24px; + line-height: 1.8; +} + +h3 { + font-weight: 600; + font-size: 20px; + line-height: 1.8; +} + +h5 { + font-size: 14px; + padding: 10px 0px; +} + +article h2, +article h3, +article h4 { + margin-top: 15px; + margin-bottom: 15px; +} + +article h4 { + padding-bottom: 8px; + border-bottom: 2px solid #ddd; +} + +/** IMAGES **/ +img { + border-radius: var(--bs-border-radius); + box-shadow: var(--card-box-shadow); +} + +/** NAVBAR **/ +.navbar-brand > img { + box-shadow: none; + color: var(--bs-nav-link-color); +} + +[data-bs-theme='light'] nav.navbar { + background-color: var(--bs-primary-bg-subtle); +} + +[data-bs-theme='dark'] nav.navbar { + background-color: var(--bs-tertiary-bg); +} + +.navbar-nav > li > a { + border-radius: var(--border-radius-button); + transition: 200ms; +} + +.navbar-nav a.nav-link:focus, +.navbar-nav a.nav-link:hover { + background-color: var(--bs-primary-border-subtle); +} + +.navbar-nav .nav-link.active, +.navbar-nav .nav-link.show { + color: var(--bs-link-hover-color); +} + +/** SEARCH AND FILTER **/ +input.form-control { + border-radius: var(--border-radius-button); +} + +form.filter { + margin: 0.3rem; +} + +/** ALERTS **/ +.alert { + padding: 0; + border: none; + box-shadow: var(--card-box-shadow); +} + +.alert > p { + padding: 0.2rem 0.7rem 0.7rem 1rem; +} + +.alert > ul { + margin-bottom: 0; + padding: 5px 40px; +} + +.alert > h5 { + padding: 0.5rem 0.7rem 0.7rem 1rem; + border-radius: var(--bs-border-radius) var(--bs-border-radius) 0 0; + font-weight: bold; + text-transform: capitalize; +} + +.alert-info { + color: var(--material-blue-dark); + background-color: var(--material-info-background); +} + +[data-bs-theme='dark'] .alert-info { + color: var(--material-blue-light); + background-color: var(--material-info-background-dark); +} + +.alert-info > h5 { + background-color: var(--material-info-header); +} + +.alert-warning { + color: var(--material-yellow-dark); + background-color: var(--material-warning-background); +} + +[data-bs-theme='dark'] .alert-warning { + color: var(--material-yellow-light); + background-color: var(--material-warning-background-dark); +} + +.alert-warning > h5 { + background-color: var(--material-warning-header); +} + +.alert-danger { + color: var(--material-red-dark); + background-color: var(--material-danger-background); +} + +[data-bs-theme='dark'] .alert-danger { + color: var(--material-red-light); + background-color: var(--material-danger-background-dark); +} + +.alert-danger > h5 { + background-color: var(--material-danger-header); +} + +/* CODE HIGHLIGHT */ +code { + border-radius: var(--bs-border-radius); + margin: 4px 2px; + box-shadow: var(--card-box-shadow); +} diff --git a/wwwroot/toc.yml b/wwwroot/toc.yml new file mode 100644 index 0000000..a726932 --- /dev/null +++ b/wwwroot/toc.yml @@ -0,0 +1,8 @@ +- name: Download + href: download/ +- name: Docs + href: docs/ +- name: FaQ + href: faq/ +- name: Learn + href: learn/