|
6 | 6 | <img src="https://img.shields.io/discord/1508590792149827745?style=for-the-badge&logoColor=5865F2&color=5865F2&labelColor=2A2C33&logo=discord&label=discord" alt="Discord"/> |
7 | 7 | </a> |
8 | 8 | <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" |
10 | 10 | </a> |
11 | 11 | <a href="https://github.com/TKVSC-Team/totk-vscode"> |
12 | 12 | <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 | 21 |
|
22 | 22 | 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. |
23 | 23 |
|
| 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 | + |
24 | 28 | **TKVSC** GameBanana page: https://gamebanana.com/tools/22893. |
25 | 29 |
|
26 | 30 | ## Features |
@@ -59,6 +63,16 @@ Preview and edit subfiles of SARC and BNTX archives |
59 | 63 | - Visual editor for [TKMM](https://tkmm.org) `.tkproj` files |
60 | 64 | - 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). |
61 | 65 |
|
| 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 | + |
62 | 76 | ## Setup |
63 | 77 |
|
64 | 78 | ### Requirements |
@@ -96,6 +110,11 @@ That produces `totk-vscode-0.0.1.vsix` (version comes from `package.json`). |
96 | 110 |
|
97 | 111 | ## Development |
98 | 112 |
|
| 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 | + |
99 | 118 | ```bash |
100 | 119 | npm install |
101 | 120 | npm run compile |
|
0 commit comments