Skip to content

Commit

Permalink
Add a bunch of pages and stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
ArchLeaders committed Feb 23, 2024
1 parent 873042d commit 7a14010
Show file tree
Hide file tree
Showing 29 changed files with 328 additions and 203 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ jobs:
run: dotnet tool update -g docfx

- name: Build DocFX
run: docfx docfx.json
run: docfx wwwroot/docfx.json

- name: Setup Pages
uses: actions/configure-pages@v4.0.0

- name: Upload artifact
uses: actions/upload-pages-artifact@v3.0.1
with:
path: _site
path: wwwroot/_site

- name: Deploy to GitHub Pages
id: deployment
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
/_site
**/_site
4 changes: 0 additions & 4 deletions docs/toc.yml

This file was deleted.

11 changes: 0 additions & 11 deletions index.md

This file was deleted.

55 changes: 0 additions & 55 deletions templates/minimal/layout/_master.tmpl

This file was deleted.

14 changes: 0 additions & 14 deletions templates/minimal/partials/footer.tmpl.partial

This file was deleted.

22 changes: 0 additions & 22 deletions templates/minimal/partials/navbar.tmpl.partial

This file was deleted.

8 changes: 0 additions & 8 deletions templates/minimal/partials/toc.tmpl.partial

This file was deleted.

79 changes: 0 additions & 79 deletions templates/minimal/styles/main.css

This file was deleted.

2 changes: 0 additions & 2 deletions toc.yml

This file was deleted.

16 changes: 11 additions & 5 deletions docfx.json → wwwroot/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": "<div id=\"copyright\">© TKMM Team, 2023-2024</div>",
"pdf": true
}
},
"postProcessors": [
"ExtractSearchIndex"
]
}
}
File renamed without changes.
1 change: 1 addition & 0 deletions wwwroot/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Docs
File renamed without changes.
6 changes: 6 additions & 0 deletions wwwroot/docs/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- name: Docs
href: index.md
- name: Introduction
href: introduction/
- name: Getting Started
href: getting-started/
1 change: 1 addition & 0 deletions wwwroot/download/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Download
1 change: 1 addition & 0 deletions wwwroot/download/setup/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Setup
4 changes: 4 additions & 0 deletions wwwroot/download/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: Download
href: index.md
- name: Setup
href: setup/
1 change: 1 addition & 0 deletions wwwroot/faq/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# FaQ
2 changes: 2 additions & 0 deletions wwwroot/faq/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: FaQ
href: index.md
Binary file added wwwroot/images/Icon-Transparent-1024.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes
73 changes: 73 additions & 0 deletions wwwroot/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
_layout: landing
---

<div align="center">
<img src="images/Icon-Transparent-1024.png" width="300vh">
<h1 style="font-family: Fira Sans">Tears of the Kingdom Mod Manager</h1>
</div>

<p align="center" style="text-align: center;">
<a href="https://github.com/TKMM-Team/Tkmm/releases">
<img src="https://img.shields.io/github/v/tag/TKMM-Team/Tkmm?style=for-the-badge&logoColor=C71B42&color=C71B42&labelColor=2A2C33&logo=github&label=Version" alt="Releases' YouTube"/>
</a> &nbsp;
<a href="https://discord.com/invite/3tNUBWQRXv">
<img src="https://img.shields.io/discord/1179611100183011429?style=for-the-badge&logoColor=3b83c8&color=3b83c8&labelColor=2A2C33&logo=discord&label=discord" alt="Discord"/>
</a> &nbsp;
<a href="https://github.com/TKMM-Team/Tkmm">
<img src="https://img.shields.io/github/stars/TKMM-Team/Tkmm?style=for-the-badge&logoColor=FFCB41&color=FFCB41&labelColor=2A2C33&logo=github" alt="Stars"/>
</a>
</p>

[![]("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.

<p>
<a href="https://github.com/TKMM-Team/Tkmm/issues">
<img src="https://img.shields.io/github/issues/TKMM-Team/Tkmm?logoColor=red&color=red&logo=github&style=flat&labelColor=2A2C33" alt="Issues"/>
</a> &nbsp;
<a href="https://github.com/TKMM-Team/Tkmm/pulls">
<img src="https://img.shields.io/github/issues-pr/TKMM-Team/Tkmm?style=flat&labelColor=2A2C33&logoColor=blue&color=blue&logo=github" alt="Open Pull Requests"/>
</a> &nbsp;
<a href="https://github.com/TKMM-Team/Tkmm/pulls">
<img src="https://img.shields.io/github/issues-pr-closed/TKMM-Team/Tkmm?style=flat&labelColor=2A2C33&logoColor=5751FF&color=5751FF&logo=github" alt="Closed Pull Requests"/>
</a>
</p>

## 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!*
1 change: 1 addition & 0 deletions wwwroot/learn/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Learn
2 changes: 2 additions & 0 deletions wwwroot/learn/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: Learn
href: index.md
32 changes: 32 additions & 0 deletions wwwroot/templates/custom/public/main.css
Original file line number Diff line number Diff line change
@@ -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;
}
Loading

0 comments on commit 7a14010

Please sign in to comment.