diff --git a/README.md b/README.md index a23ae6bd..49130671 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![GitHub Release](https://img.shields.io/github/v/release/SpontanCombust/witcherscript-ide) ![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/SpontanCombust.witcherscript-ide) -WitcherScript IDE is an unofficial tool aimed at bringing better developer experience to scripting Witcher 3 by providing a WitcherScript Language Server. +WitcherScript IDE is an unofficial Witcher 3 modding tool aimed at bringing better developer experience to scripting the game by providing a WitcherScript Language Server. Currently the only supported client is Visual Studio Code. Website: diff --git a/RELEASE_TODO.md b/RELEASE_TODO.md index 610bca55..1b6cd04c 100644 --- a/RELEASE_TODO.md +++ b/RELEASE_TODO.md @@ -5,18 +5,19 @@ Just a list of all the tasks that are to be done before the release, so I don't 1. Check TODOs 2. Update extension README 3. Update documentation +4. Update changelog -4. Verify Linux version -5. Verify README in extensions tab +5. Verify Linux version +6. Verify README in extensions tab -6. Merge to master +7. Merge to master -7. Verify the website -8. Verify documentation/site links +8. Verify the website +9. Verify documentation/site links -9. Bump version in `Cargo.toml` -10. Bump version in client `package.json` -11. Create a version tag and the release +10. Bump version in `Cargo.toml` +11. Bump version in client `package.json` +12. Create a version tag and the release -12. Verify Marketplace -13. Move tasks on the board to `Shipped` \ No newline at end of file +13. Verify Marketplace +14. Move tasks on the board to `Shipped` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 57a14af0..d2444895 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # About -WitcherScript IDE is a unofficial project aimed at improving the developer experience of Witcher 3 script modding by supplying developers with powerful code analysis tools in form of an editor extension. +WitcherScript IDE is a unofficial Witcher 3 modding tool aimed at improving the developer experience by supplying them with powerful code analysis tools in form of an editor extension. `witcherscript-ide` implements the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) for the WitcherScript language - a proprietary scripting language used by award winning game Witcher 3 Wild Hunt created by CD Projekt RED. diff --git a/docs/user-manual/changelog.md b/docs/user-manual/changelog.md index 33ebc6bc..e42377d4 100644 --- a/docs/user-manual/changelog.md +++ b/docs/user-manual/changelog.md @@ -3,10 +3,35 @@ # Changelog +## v0.2.1 +REDKit project support & fixes + +### Features +- Added support for REDKit projects + +### Fixes +- Fixed script analysis not being reloaded when file was saved +- Fixed duplicated syntax errors for code inside functions +- Fixed `defaults` blocks not having syntax analysis +- Fixed diagnostics not displaying immediately when a manifest file was changed and saved +- Fixed content not being detected if it resided in the root of a repository directory + +### Documentation +- Moved copyright information directly into the "About" page +- Made a dedicated page for "Getting started" which is available from the main page of user manual +- Updated "Project System" with REDKit project information + +### Other +- Opening a new/unknown manifest file now doesn't trigger content graph rebuild and a manual file save action is required to trigger it +- More descriptive errors diagnostics when linking content dependencies +- The extension now also gets published to Eclipse's Open VSX Registry at + + + ## v0.2.0 Project system update -### Editor +### Features - Added a project system for WitcherScript, check the user manual for details - Added workspace-wide analysis thanks to the project system - Improved syntax highlighting diff --git a/docs/user-manual/editor.md b/docs/user-manual/editor.md index d4775381..39d97314 100644 --- a/docs/user-manual/editor.md +++ b/docs/user-manual/editor.md @@ -6,6 +6,7 @@ - basic syntactical analysis - initializing or creating new script projects - importing and comparing scripts with their vanilla counterparts +- support for REDKit projects **More coming soon!** diff --git a/docs/user-manual/getting-started.md b/docs/user-manual/getting-started.md index 3742e875..817fb3af 100644 --- a/docs/user-manual/getting-started.md +++ b/docs/user-manual/getting-started.md @@ -1,6 +1,6 @@ # Getting started -1. Install the extension from the [marketplace](https://marketplace.visualstudio.com/items?itemName=SpontanCombust.witcherscript-ide) or grab a .vsix file for your OS from the [releases](https://github.com/SpontanCombust/witcherscript-ide/releases) page. +1. Install the extension from the [Visual Studio marketplace](https://marketplace.visualstudio.com/items?itemName=SpontanCombust.witcherscript-ide) or [Open VSX](https://open-vsx.org/extension/SpontanCombust/witcherscript-ide) if you're using other VSCode variants. You can also grab a .vsix file directly from the [releases](https://github.com/SpontanCombust/witcherscript-ide/releases) page. 2. Configure paths to existing vanilla and mod scripts by going to settings (File > Preferences > Settings). Start typeing "witcherscript" and look for "Game Directory" and "Content Repositories" settings. 3. Open the command prompt using Ctrl + Shift + P and start typeing "witcherscript". Choose a command to create or initialize a WitcherScript project. @@ -8,4 +8,4 @@ -Alternatively if you're already working on a mod using the REDKit you can open the editor in your project's folder. This still requires step 2 to work properly. +You can skip step 3. if you're already working on a mod using the REDKit modding tool. Just open the editor in your project's directory. If you want to use other mods as a dependency for your mod for example you should still check out [`witcherscript.toml` projects](./project-system.md#project) though. diff --git a/editors/vscode/README.md b/editors/vscode/README.md index dbd9b11e..485a6f61 100644 --- a/editors/vscode/README.md +++ b/editors/vscode/README.md @@ -8,6 +8,7 @@ Provides support for Witcher 3's scripting language WitcherScript. - basic syntactical analysis - initializing or creating new script projects - importing and comparing scripts with their vanilla counterparts +- support for REDKit projects **More coming soon!**