Add initial wiki (WIP)

wiki/application_guide.md

@@ -8,43 +8,48 @@ This page is meant to help inform and guide users as to how this application wor
 
 ![ui-guide0](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/blob/main/tutorial-screenshots/ui-guide0.png)
 
-**On the top left of the application menu bar is**
-- **Open** - It opens a folder browser dialog where you can select the folder that contains your extracted D3DTX textures.
-- **Save** - save the selected file to a location
-- **Add** - add a file to the folder
-- **Delete** - delete a file 
-- **Help** - opens the wiki page
-- **About** - opens a window with information about the software with credits and a version number
+On the top left of the application menu bar the following buttons are located:
+- **Open** - It opens a folder browser dialog window where you can select the folder that contains your extracted textures.
+- **Save** - Save the selected file to a location.
+- **Add** - Add a file to the directory that is opened.
+- **Delete** - Delete a file from the directory that is opened.
+- **Help** - Opens the wiki page.
+- **About** - Opens a window with information about the software, credits and a version number.
 
 ## Textures Directory
 
 ![ui-guide1](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/blob/main/tutorial-screenshots/ui-guide1.png)
 
 This section contains a simple file browser for selecting and viewing all of your texture files.
 
-**On the top left of this section**
-- **Textures Directory** - The section title
-- **Directory Path** - tells you the path of the folder in which you selected
-- **Return Folder Button** - goes up one level in the directory
-- **Refresh Directory Button** - simply refreshes the Listview in case there are any changes and the application doesn't update the interface.
+##### On the top left of this section
+- **Textures Directory** - The section title.
+- **Directory Path** - Displays the path of the folder which you selected.
+- **Return Folder Button** - Goes up one level in the directory when clicked. (Like the Previous Button in the File Explorer)
+- **Refresh Directory Button** - Refreshes the **file browser** in case there are any changes to the folder content and the application doesn't update the interface.
 
 **In the middle of this section**
-- **File Browser** - a datagridview of the all supported image file formats, including **.png, .jpg, .bmp, .tiff, .dds, .d3dtx and .json** 
+- **File Browser** - a view of the all supported image file formats, including **.png, .jpg, .bmp, .tiff, .dds, .d3dtx and .json**. It also supports folders. 
 
 ![ui-guide5](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/blob/main/tutorial-screenshots/ui-guide5.png)
 
-**There is also a context menu for the middle section** (Right-click on this section in the application)
-- **Refresh** - 
-- **Open Folder** - opens the directory you have open in File Explorer
+##### There is also a context menu for the middle section (Right-click on this section in the application)
+- **Add** - Same functionality as **Add Button**.
+- **Open** - Opens the file with the preferred software.
+- **Open Folder** - Opens the selected folder inside the application.
+- **Open in Explorer** - Opens the directory you have opened in File Explorer.
+- **Refresh Directory** - Same functionality as **Refresh Directory Button**.
+- **Delete File** - Same functionality as **Delete Button**.
 
-**There are also some double click actions** 
+##### There are also some double click actions 
 - **Double clicking on a folder** - opens the folder in the current software
 - **Double clicking on a file** - opens the file in the preffered software
 
-**On the middle right of this section**
-- **Convert Options:** - a combo box containing all possible options of the selected image format
-- **Choose Output Directory Checkbox** - a checkbox if you want to specify the path when converting
-- **Convert Button** - Refreshes the Listview in case there are any changes and the application doesn't update the interface.
+##### On the middle right of this section
+- **Convert Options** - A combo box containing all possible options of the selected image format.
+- **Choose Output Directory Checkbox** - A checkbox if you want to specify the path when converting.
+- **Conversion Type** - A combo box containing all possible conversion options. Users should stick to the **Default** option for all games **after The Walking Dead**.
+- **Convert Button** - Converts the texture into the chosen format.
 
 ## Output Section
 
@@ -56,30 +61,28 @@ This section contains an Output in which information is written during the conve
 
 ![ui-guide3](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/blob/main/tutorial-screenshots/ui-guide3.png)
 
-This section contains an image viewer for viewing textures. It displays **.png, .jpg, .bmp, .tiff, .dds and .d3dtx** files (if the game is supported).
+This section contains an image viewer. It displays **.png, .jpg, .bmp, .tiff, .dds and .d3dtx** files.
 
 **On the top of this section contains**
-- **File Name** - where the name of the image is displayed
-- **Image Preview** - title of the section
-
+- **File Name** - Displaying the name of the selected file.
 
 **On the middle of this section contains**
-- **Image Window** - when an image is selected from the Textures Directory DataGrid it will be displayed here
+- **Image Window** - The selected image from the **File Browser** will be displayed here. w
 
-## Image Properties
+### Image Properties
 
 ![ui-guide4](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/blob/main/tutorial-screenshots/ui-guide4.png)
 
-This section contains and shows the properties of an image when it's selected from the Listview in the Textures Directory section
+This section contains and shows the properties of an image when it's selected from the **File Browser** in the Textures Directory section.
 
 **Properties that will be displayed**
-- **Image Name** - the name of the image
-- **Pixel Width** - the image resolution in width. (of the largest mipmap, or also known as the main texture)
-- **Pixel Height**- the image resolution in height. (of the largest mipmap, or also known as the main texture)
-- **Surface Format** - the surface format of the texture. Additional info can be found here.
-- **Transparency** - indicates if the texture has alpha
-- **Channel count** - shows the number of color channels of the surface format (at the moment it's broken)
-- **Mip Map Count** - how many mipmaps are in the texture
-- **Layout** - shows what type of texture layout it is - 2d, 3d or cube texture (to be added)
+- **Image Name** - The name of the image. Telltale texture files 
+- **Pixel Width** - The width of the image. (Textures files use the width of the largest mipmap, also known as the main texture).
+- **Pixel Height**- The height of the image. (Textures files use the height of the largest mipmap, also known as the main texture).
+- **Surface Format** - The surface format of the texture. Additional information can be found here.
+- **Transparency** - Indicates if the textures has transparency/alpha.
+- **Channel count** - Shows the number of color channels of the surface format (at the moment it's broken).
+- **Mip Map Count** - The number of mipmaps in the texture. Telltale textures always have 1 mipmap (the main texture).
+- **Layout** - The type of texture layout. The possibilities are: 2D, 3D, CubeMap.
 
 And that is all there is to it!

wiki/home.md

@@ -1,11 +1,14 @@
 Welcome to the DDS-D3DTX-Converter wiki!
 
-This is the home page containing all the pages and information about the Texture Mod Tool
+This is the home page containing all the pages and information about the Texture Mod Tool. If you have trouble understanding, please use an in-built Google Translate.
 
 ### Table of Contents
 1. **[Application Guide](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/wiki/%5BHelp%5D-Application-Guide)**
 2. **[Reporting issues/bugs](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/wiki/%5BHelp%5D---Reporting-an-Issue-or-Bug)**
 
 ### Tutorials
-1. **[How to make a Texture Mod (Part 1)](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/wiki/%5BTutorial%5D--How-to-make-a-Texture-Mod-(Part-1))**
-2. **[How to make a Texture Mod (Part 2)](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/wiki/%5BTutorial%5D--How-to-make-a-Texture-Mod-(Part-2))**
+1. **[How to make a Texture Mod (Prelude)](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/wiki/%5BTutorial%5D--How-to-make-a-Texture-Mod-(Part-1))**
+2. **[How to make a Texture Mod (Part 1)](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/wiki/%5BTutorial%5D--How-to-make-a-Texture-Mod-(Part-1))**
+3. **[How to make a Texture Mod (Part 2)](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/wiki/%5BTutorial%5D--How-to-make-a-Texture-Mod-(Part-2))**
+
+For The Walking Dead Season 1 (2012) and older games texture editing check out [this tutorial.](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/wiki/%5BTutorial%5D-The-Walking-Dead-Season-1-(and-older-games)-Texture-Editing-Tutorial)

wiki/issue.md

@@ -0,0 +1,16 @@
+## Reporting an Issue/Bug
+
+Welcome to the Issue/Bug Reporting page for the Texture Mod Tool. This is meant to help guide you on how to report an issue to us. If you happen to come across a bug, or an issue with the Mod Launcher. **Please report the issue here.**
+
+**Reporting issues allow you to help us improve the application through increased stability and/or more features.**
+### What to write when putting an issue
+
+**PLEASE write in a detailed and concise manner, explaining what the issue/bug is.**
+
+More importantly, you also need to be able to ***reproduce the error***. You need to be able to reproduce the error that occurs, otherwise, it will be very difficult for us to track down the case in which the error you are receiving happens. If you're able to reproduce it, then be sure to write the clear and concise steps needed to be taken in order for us to recreate the error ourselves and patch it.
+
+**If this is an issue related to a file, be sure to also upload/attach the file to your issue report.**
+
+It's also worth noting you should only be reporting issues that relate to this tool only. If there are issues you have with the Mod Launcher, or the Script Editor please report those issues to their respective repositories.
+
+***The more information you provide us about the bug/issue, the better it is for us to quickly understand, reproduce, and patch the issue.***

wiki/tutorials/tutorial_part_1.md

@@ -0,0 +1,71 @@
+## How to find and extract textures 
+
+**Welcome to the first part of the tutorial on how to make a texture mod for Telltale's games. In this section we focus on how to find and extract the textures needed for your mods!**
+
+## [Make sure you read the prelude before beginning. It contains important information.](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/wiki/%5BTutorial%5D-How-to-make-a-Texture-Mod-(Prelude))
+
+**Now with that out of the way let's begin.**
+We use Telltale Explorer for this part of the tutorial. Make sure to download it.
+
+## Step 1/9 - Locating the textures
+Telltale store their files in **.ttarch/.ttarch2** files also know as **Telltale archives**. We open these archives using Telltale Explorer. Now the question remains - which? Luckily, Telltale has good naming conventions. 
+
+Most textures can be found in the archives ending with **_txmesh**. Additionally, in front of **_txmesh** there is useful data like episode number (for e.g. 202 would mean season 2 episode 2) or Menu, which is related to ui menu content. 
+
+Here is an example of how TWD:DE directory looks like and where .d3dtx files are stored.
+
+##### Note, textures file can be found in other archives as well, but I am gonna leave it for you to explore them. 
+
+## Step 2/9 Opening the archives
+After you have an idea where to look, run TelltaleExplorer.exe.
+It should look like this [image of explorer]
+
+
+Click on Open and find the game's directory. 
+
+Select your desired archive and open it. 
+
+Click on Open and find the game's directory where the archives are stored.
+
+
+## Step 3/9 - Finding the right textures
+This looks like a mess, doesn't it? And it is, but it's an organised one.
+
+Typically *(unless you are an experienced texture artist)* you would only really need to be modifying the **[diffuse textures](https://www.reallusion.com/iclone/help/iclone3/15_multiple_channel_texture_mapping/types_of_maps.htm)**. 
+
+**[Diffuse textures](https://www.reallusion.com/iclone/help/iclone3/15_multiple_channel_texture_mapping/types_of_maps.htm)** are just the raw material/model colors and these textures typically have no suffix after them in their file names like _spec, _ink, _detail, _nm, etc. **For example, sk54_lee_head.d3dtx is a diffuse texture, however sk54_lee_head_spec.d3dtx is a specular texture.** These suffixes indicate and deal with other material properties like the **[specularity](https://www.modding-forum.com/guide/17-diffuse-specular-and-normal-maps/)** of a material, the **[normal/bump map](https://en.wikipedia.org/wiki/Normal_mapping)** of the material, or the ink/black lines on a material.
+
+
+
+![tut1](./wiki/tutorial-screenshots/tut1_old.png)
+
+![tut2](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/blob/main/tutorial-screenshots/tut2.png)
+
+![tut3](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/blob/main/tutorial-screenshots/tut3.png)
+
+## Step 4/9 - Extracting the textures
+
+When you select the texture you want to edit, click on **Save** -> **Save as Raw**. 
+Choose a folder on your preference (it's a good idea to be empty) and save it.
+
+### Congratulations, you can now locate and extract the right textures!
+
+### Tips and tricks
+
+Telltale Explorer has some good QoL features. 
+
+### The view button acts like a filter. Don't want to see .d3dmesh files? Click "View" and choose .d3dtx.
+
+### Want to save all files? 
+Clicking on Save All Files will give you some options.
+- Save all (raw dump) - save all files from the archive
+- Save all visible files (raw dump) - like Save all (raw dump), but with an applied filter
+
+### Want to find a specific texture? 
+Use the search option in the top right corner. 
+##### Note: it doesn't work with filters.
+![tut4](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/blob/main/tutorial-screenshots/tut4.png)
+
+
+![tut5](https://github.com/Telltale-Modding-Group/DDS-D3DTX-Converter/blob/main/tutorial-screenshots/tut5.png)
+