|
1 |
| -# pico8vscodeeditor README |
| 1 | +# Pico-8 VSCode Plugin |
2 | 2 |
|
3 |
| -This is the README for your extension "pico8vscodeeditor". After writing up a brief description, we recommend including the following sections. |
| 3 | +This plugin provides facilities for editing Pico-8 p8 files in VSCode. |
4 | 4 |
|
5 | 5 | ## Features
|
6 | 6 |
|
7 |
| -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
| 7 | +Currently the plugin provides the following features: |
8 | 8 |
|
9 |
| -For example if there is an image subfolder under your extension project workspace: |
| 9 | +* Enables LUA syntax highlighting (based off the latest base LUA language plugin) |
| 10 | +* Basic LUA language snippets for loops etc. |
| 11 | +* Pico-8 API snippets for the (hopefully) whole Pico-8 API |
| 12 | +* Additional Pico-8 helper snippets such as: |
| 13 | + * Creating new carts |
| 14 | + * Helpful "enumerations" for input and colours |
| 15 | + * Memory locations/GPIO |
| 16 | +* Launching Pico-8 to open or run a cartridge from within VSCode |
10 | 17 |
|
11 |
| -\!\[feature X\]\(images/feature-x.png\) |
12 |
| - |
13 |
| -> 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. |
| 18 | +Wherever Pico-8 has an API where there are a "common" set of parameters, and less used optional ones, the snippet for the optional parameters includes the comma, so they can be quickly deleted if not needed, but you will need to type the comma if you want to use them. |
14 | 19 |
|
15 | 20 | ## Requirements
|
16 | 21 |
|
17 |
| -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
18 |
| - |
19 |
| -## Extension Settings |
| 22 | +* VSCode |
| 23 | +* Pico-8 |
20 | 24 |
|
21 |
| -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
| 25 | +:) |
22 | 26 |
|
23 |
| -For example: |
| 27 | +## Extension Settings |
24 | 28 |
|
25 | 29 | This extension contributes the following settings:
|
26 | 30 |
|
27 |
| -* `myExtension.enable`: enable/disable this extension |
28 |
| -* `myExtension.thing`: set to `blah` to do something |
| 31 | +* `pico8vscodeeditor.pico8fullpath`: full path, including the executable, for Pico-8 |
| 32 | +* `pico8vscodeeditor.pico8additionalParameters`: any additional parameters to pass to Pico-8 when launching |
29 | 33 |
|
30 | 34 | ## Known Issues
|
31 | 35 |
|
32 |
| -Calling out known issues can help limit users opening duplicate issues against your extension. |
| 36 | +Documentation needs more info :) |
33 | 37 |
|
34 | 38 | ## Release Notes
|
35 | 39 |
|
36 |
| -Users appreciate release notes as you update your extension. |
37 |
| - |
38 |
| -### 1.0.0 |
39 |
| - |
40 |
| -Initial release of ... |
41 |
| - |
42 |
| -### 1.0.1 |
43 |
| - |
44 |
| -Fixed issue #. |
45 |
| - |
46 |
| -### 1.1.0 |
47 |
| - |
48 |
| -Added features X, Y, and Z. |
49 |
| - |
50 |
| ------------------------------------------------------------------------------------------------------------ |
51 |
| - |
52 |
| -## Working with Markdown |
53 |
| - |
54 |
| -**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
55 |
| - |
56 |
| -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux) |
57 |
| -* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux) |
58 |
| -* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets |
59 |
| - |
60 |
| -### For more information |
61 |
| - |
62 |
| -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
63 |
| -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
| 40 | +### 0.1.0 |
64 | 41 |
|
65 |
| -**Enjoy!** |
| 42 | +Initial release. |
0 commit comments