Skip to content

Commit ca8cdca

Browse files
2 parents 2725696 + 2f513be commit ca8cdca

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<img src="https://img.shields.io/discord/1508590792149827745?style=for-the-badge&logoColor=5865F2&color=5865F2&labelColor=2A2C33&logo=discord&label=discord" alt="Discord"/>
77
</a> &nbsp;
88
<a href="https://github.com/TKVSC-Team/totk-vscode/releases/latest">
9-
<img src="https://img.shields.io/github/v/tag/TKVSC-Team/totk-vscode?style=for-the-badge&logoColor=ffffff&color=C71B42&labelColor=2A2C33&logo=github&label=Version" alt="Releases' YouTube"/>
9+
<img src="https://img.shields.io/github/v/tag/TKVSC-Team/totk-vscode?style=for-the-badge&logoColor=ffffff&color=C71B42&labelColor=2A2C33&logo=github&label=Version" alt="Latest Release"
1010
</a> &nbsp;
1111
<a href="https://github.com/TKVSC-Team/totk-vscode">
1212
<img src="https://img.shields.io/github/stars/TKVSC-Team/totk-vscode?style=for-the-badge&color=FFCB41&labelColor=2A2C33&logo=github" alt="Stars"/>
@@ -21,6 +21,10 @@
2121

2222
The **T**ears of the **K**ingdom **V**isual **S**tudio **C**ode Extension or **TKVSC** is a Visual Studio Code extension for editing and browsing **Tears of the Kingdom** (**TotK**) game files.
2323

24+
Our core design philosophy creating this extension is **centralization of tooling concerns**, and **automating the boilerplate of the design process**.
25+
26+
<sup></sub>It also pairs well with **TKMM!**</sup></sub>
27+
2428
**TKVSC** GameBanana page: https://gamebanana.com/tools/22893.
2529

2630
## Features
@@ -59,6 +63,16 @@ Preview and edit subfiles of SARC and BNTX archives
5963
- Visual editor for [TKMM](https://tkmm.org) `.tkproj` files
6064
- For files TKVSC does not support, such as `.bfres`, the user can choose external programs to open them in by default (separate from similar features in the OS).
6165

66+
## Planned Features
67+
68+
*( if there are any features you don't see on here, feel free to make an issue on this GitHub! )*
69+
70+
- Node Based Editors (AINB, ASB, BAEV, and EVFL are all planned.)
71+
- BFRES Support (Preview, Editing.)
72+
- Audio Support (BARS, BWAV.)
73+
- Actor Tooling (Automating the process as much as possible.)
74+
- <sub></sup>PTCL/ELink support is being researched but not confirmed. This is uncharted territory.</sup></sub>
75+
6276
## Setup
6377

6478
### Requirements
@@ -96,6 +110,11 @@ That produces `totk-vscode-0.0.1.vsix` (version comes from `package.json`).
96110

97111
## Development
98112

113+
### Contributing:
114+
We are an open project, and if there are any features you'd like to see, or issues you come across: feel free to make a PR!
115+
116+
### Getting Started:
117+
99118
```bash
100119
npm install
101120
npm run compile

0 commit comments

Comments
 (0)