{"id":13995976,"url":"https://github.com/ephread/vscode-ink","last_synced_at":"2025-04-10T23:03:51.681Z","repository":{"id":42836631,"uuid":"264495207","full_name":"ephread/vscode-ink","owner":"ephread","description":"Ink support for VS Code","archived":false,"fork":false,"pushed_at":"2022-03-26T17:34:57.000Z","size":141,"stargazers_count":5,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T23:03:47.087Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ephread.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-16T17:58:11.000Z","updated_at":"2024-08-22T19:37:20.000Z","dependencies_parsed_at":"2022-09-23T16:52:04.152Z","dependency_job_id":null,"html_url":"https://github.com/ephread/vscode-ink","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ephread%2Fvscode-ink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ephread%2Fvscode-ink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ephread%2Fvscode-ink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ephread%2Fvscode-ink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ephread","download_url":"https://codeload.github.com/ephread/vscode-ink/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248312142,"owners_count":21082638,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-09T14:03:42.721Z","updated_at":"2025-04-10T23:03:51.656Z","avatar_url":"https://github.com/ephread.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Ink extension for Visual Studio Code\n\nThis extensions adds language support for [inkle's ink].\n\n⚠️ The extension is under heavy development and is not available yet on the marketplace.\n\n[inkle's ink]: https://github.com/inkle/ink\n\n## Language Features\n\n- Syntax highlighting using the [updated TextMate grammar].\n- Diagnostics (errors, warning and author's notes) through [inklecate] (inklecate must be installed separately).\n\n[updated TextMate grammar]: https://github.com/inkle/ink-tmlanguage\n[inklecate]: https://github.com/ephread/ink/tree/language-server/inklecate/LanguageServerProtocol\n\n## Configuration settings\n\nThe server supports three configuration settings.\n\n- `ink.useLanguageServer`: use the experimental language server (this feature requires a version of\n  [inklecate with LSP support], see [Quickstart] for more information).\n- `ink.languageServer.mainFilePath`: the path to the main ink file, used by inklecate to build the story.\n   If it's not provided, the extension will treat the current file in isolation.\n- `ink.languageServer.inklecatePath`: the path to the inklecate. If inklecate is accessible in `$PATH`, you can set it to `inklecate`.\n- `ink.languageServer.useSpecificRuntime`: whether to use a .NET runtime to execute `inklecate`; possible values are:\n    - `none`: use no specific runtime (only available on Windows);\n    - `mono`: use Mono runtime;\n    - `dotnet`: use .NET Core runtime.\n\n[Quickstart]: #quickstart\n[inklecate with LSP support]: https://github.com/ephread/ink/tree/language-server/inklecate/LanguageServerProtocol\n\n## Installing\n\n### Quickstart\n\n1. Clone the project\n2. Run `npm install`\n3. Run the configuration named `Run Extension (Debug)`\n4. Set the configuration settings (see below)\n\n### Language Server Support\n\n⚠️ This has only been tested on macOS with Visual Studio for Mac.\n\n1. Clone this [fork of ink].\n2. Check out the branch named `language-server`.\n3. Build the project (using the Debug configuration).\n4. Grab the path to `inklecate.dll` and set it to `ink.languageServer.inklecatePath`.\n   By default it should be at:\n```\n\u003croot-of-repository\u003e/inklecate/bin/Debug/netcoreapp3.1/inklecate.dll\n```\n4. If you're building using Visual Studio for Mac and keeping the default configuration,\n`dotnet` is a better choice than `mono` for `ink.languageServer.useSpecificRuntime`\n(although both should work).\n5. Enable `ink.useLanguageServer`.\n\n[fork of ink]: https://github.com/ephread/ink/\n\n## License\n\nThis extension is released under the MIT license. See LICENSE for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fephread%2Fvscode-ink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fephread%2Fvscode-ink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fephread%2Fvscode-ink/lists"}