Update Documentation. Fixes (#4)

Shresht7 · Dec 26, 2023 · f3c0a39 · f3c0a39
1 parent 8e9c93b
commit f3c0a39
Show file tree

Hide file tree

Showing 2 changed files with 147 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,24 @@ All notable changes to the "bg3-modding" extension will be documented in this fi
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-## [Unreleased]
+## [Unreleased - v0.1.0] - Initial Release 🚀
 
-- Initial release
+<!-- Release notes generated using configuration in .github/release.yml at main -->
+
+### What's Changed
+
+#### ⭐ Features
+
+- _Snippets_ ([#1](https://github.com/Shresht7/vscode-bg3-modding/pull/1))
+- _Add commands to generate UUIDs and BG3 Handles_ ([#3](https://github.com/Shresht7/vscode-bg3-modding/pull/3))
+- _Create snippet: Override Stat Entry_ ([#7](https://github.com/Shresht7/vscode-bg3-modding/pull/7))
+- _Provide helpful configuration defaults_ ([#9](https://github.com/Shresht7/vscode-bg3-modding/pull/9))
+- _Add JSON Schema Validation_ ([#11](https://github.com/Shresht7/vscode-bg3-modding/pull/11))
+- _Add hover widget for version number in `meta.lsx`_ ([#16](https://github.com/Shresht7/vscode-bg3-modding/pull/16))
+- _Add commands to generate version numbers_ ([#17](https://github.com/Shresht7/vscode-bg3-modding/pull/17))
+- _Add support for version numbers_ ([#15](https://github.com/Shresht7/vscode-bg3-modding/pull/15))
+
+## New Contributors
+- @Shresht7 made their first contribution ([#1](https://github.com/Shresht7/vscode-bg3-modding/pull/1))
+
+**Full Changelog**: https://github.com/Shresht7/vscode-bg3-modding/commits/v0.1.0
diff --git a/README.md b/README.md
@@ -1,9 +1,51 @@
-# BG3 Modding
+# `BG3 Modding` support for Visual Studio Code
 
 This VS Code extension contains useful tools, snippets and helpers for creating mods for [**Baldur's Gate 3**](https://baldursgate3.game/).
 
-## Features
+<details>
 
+<summary>
+    <b>Table of Contents</b>
+</summary>
+
+- [⚡ Activation Events](#-activation-events)
+- [⭐ Features](#-features)
+  - [📄 Snippets](#-snippets)
+  - [⌨️ Commands](#️-commands)
+    - [`Generate UUID`](#generate-uuid)
+    - [`Generate Handle`](#generate-handle)
+    - [`Convert Version Number`](#convert-version-number)
+      - [Input: Version Number](#input-version-number)
+  - [✅ JSON Validation](#-json-validation)
+  - [⚙️ Default Configurations](#️-default-configurations)
+    - [`files.associations`](#filesassociations)
+    - [`search.exclude`](#searchexclude)
+- [⚙️ Extension Settings](#️-extension-settings)
+- [📄 License](#-license)
+
+</details>
+
+
+## ⚡ Activation Events
+
+- `workspaceContains:/**/meta.lsx`
+
+  The extension activates for a workspace that contains the `meta.lsx` file.
+
+## ⭐ Features
+
+<!-- no toc -->
+- [Snippets](#snippets)
+- [Commands](#commands)
+  - [`Generate UUID`](#generate-uuid)
+  - [`Generate Handle`](#generate-handle)
+  - [`Convert Version Number`](#convert-version-number)
+- [JSON Validation](#json-validation)
+- [Default Configurations](#default-configurations)
+  - [`files.associations`](#filesassociations)
+  - [`search.exclude`](#searchexclude)
+
+<!-- 
 `TODO`
 
 Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
@@ -13,9 +55,90 @@ For example if there is an image subfolder under your extension project workspac
 \!\[feature X\]\(images/feature-x.png\)
 
 > Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
+-->
+
+### 📄 Snippets
+
+The extension contributes the following snippets:
+
+| Name                            |           Activation | Description                                               |
+| ------------------------------- | -------------------: | --------------------------------------------------------- |
+| BG3 UUID                        |               `uuid` | Generate a random UUID                                    |
+| BG3 Handle                      |             `handle` | Generates a random UUID handle used in localization files |
+| `Ext.Utils.Print()`             |       `print`, `eup` | `Ext.Utils.Print()`                                       |
+| `Ext.Osiris.RegisterListener()` |  `rl`, `orl`, `eorl` | `Ext.Osiris.RegisterListener()`                           |
+| Override Stat Entry             |    `new`, `override` | Create an override for an existing Stat Entry             |
+| Script-Extender Config          | `cfg`, `Config.json` | Generates the boilerplate Script-Extender `Config.json`   |
+| `meta.lsx`                      |               `meta` | Generates the boilerplate template for `meta.lsx`         |
+
+### ⌨️ Commands
+
+The extension contributes the following commands:
+
+#### `Generate UUID`
+
+Generate a random UUID and insert at the current selection.
+
+```
+b7b98e25-ff34-40dd-b019-ab25521ae5a0
+```
+
+#### `Generate Handle`
+
+Generate Handle and insert at the current selection.
 
-<!--
-## Extension Settings
+```
+hb7b98e25gff34g40ddgb019gab25521ae5a0
+```
+
+#### `Convert Version Number`
+
+Convert between BG3 version numbers.
+
+```
+1.0.0.0 --> 36028797018963968
+36028797018963968 --> 1.0.0.0
+```
+
+##### Input: Version Number
+
+Takes the version number as input in either the string format (e.g. `1.0.0.0`) or bigint format (e.g. `36028797018963968`).
+
+### ✅ JSON Validation
+
+The extension contributes JSON validation schemas for:
+- [`ScriptExtender/Config.json`](./schema/Config.schema.json)
+- [`ScriptExtenderSettings.json`](./schema/ScriptExtenderSettings.schema.json)
+
+This will enable intellisense and provide validation for these files.
+
+### ⚙️ Default Configurations
+
+The extension provides default configuration settings for:
+
+#### `files.associations`
+
+```json
+"files.associations": {
+    "*.lsx": "xml",
+    "*.lsj": "json"
+},
+```
+
+#### `search.exclude`
+
+```json
+"search.exclude": {
+    "**/*.raw": true,
+    "**/Story/*.div": true,
+    "**/*.osi": true,
+    "**/*.dat": true
+}
+```
+
+---
+
+## ⚙️ Extension Settings
 
 Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
 
@@ -25,7 +148,6 @@ This extension contributes the following settings:
 
 * `myExtension.enable`: Enable/disable this extension.
 * `myExtension.thing`: Set to `blah` to do something.
--->
 
 ---