- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 407
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Merge pull request #666 from tonybaloney/markdown_docs
Change rst for markdown docs
Showing
15 changed files
with
281 additions
and
419 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Contributing | ||
|
||
## Ideas and discussion | ||
|
||
Have an awesome idea for a new feature? Please [open an issue](https://github.com/tonybaloney/vscode-pets/issues/new) describing your idea! You can also help by reviewing some of the [existing ideas](https://github.com/tonybaloney/vscode-pets/issues) and leaving your opinion. | ||
|
||
## Reporting bugs | ||
|
||
Something is not working as it should? Please [open an issue](https://github.com/tonybaloney/vscode-pets/issues/new) giving as much information as you can. Writing an effective bug report is a valuable skill as a Software Engineer, refer to the given example below for advice. | ||
|
||
* Title - Clearly summarize what the bug is with specific details. | ||
* Summary - If the title is too long, include a summary with additional details. | ||
* Visual/Screenshot - A picture is always worth the time. Include one if possible. | ||
* Expected/Actual Results - Explain what you expected to happen and what actually happened. | ||
* Steps to Reproduce - The steps to follow should be comprehensive, easy to understand, and short. We want to experience the bug first-hand. | ||
* Environment - Share the current version information by copying from `Help` and clicking `About`. | ||
|
||
## Write code | ||
|
||
Want to contribute to vscode-pets? Feel free to [fork the repository](https://github.com/tonybaloney/vscode-pets/fork) and submit a pull request. | ||
|
||
## Drawing and Animations | ||
|
||
If you want to contribute improvements to the animations, additional pet colors or even new pets, clone the repository and work in the `media/` folder. | ||
|
||
Most drawings are done in [aseprite](https://www.aseprite.org/) because you can edit GIFs directly. However, you are free to use any tool to make the animations. Animations should be 8 frames per second. The style of the extension is to have pixelated creatures (although not limited to an 8-bit color canvas). | ||
|
||
Don't worry if you don't have enough coding experience to add the changes to the extension to support the new animations, we can help you with that. | ||
|
||
The minimum set of behaviors is: | ||
|
||
* standing | ||
* walking | ||
* running/chasing | ||
* holding green ball | ||
|
||
## Testing the changes | ||
|
||
* Run `npm install`. | ||
* Run `npm run compile`. | ||
* Go to the debug panel on the sidebar and launch the development version with the extension loaded (first option in the debug profiles). | ||
* Refer to [VS Code Extension Documentation](https://code.visualstudio.com/api) for additional resources. | ||
|
||
## Submitting a PR | ||
|
||
* Please make sure to run `npm run lint` and verify there are no errors/warnings. | ||
* You can run `npm run lint:fix` to fix the lint issues. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Credits | ||
|
||
The cat animations were designed by [seethingswarm](https://seethingswarm.itch.io/catset). The dog media assets for this extension were designed by [NVPH Studio](https://nvph-studio.itch.io/dog-animation-4-different-dogs). | ||
|
||
The winter theme is original artwork by [Kiana Mosser](https://www.instagram.com/kianamosser/) created for VS Code Pets. | ||
|
||
The forest theme was designed by [edermunizz](https://edermunizz.itch.io/free-pixel-art-forest). The castle assets were created using artwork by [GuttyKreum](https://guttykreum.itch.io/gothic-castle-game-assets). | ||
|
||
[Marc Duiker](https://twitter.com/marcduiker) created the Clippy, Rocky, Zappy, rubber duck, snake, cockatiel, Ferris the crab, and Mod the dotnet bot media assets. | ||
|
||
[Elthen](https://twitter.com/pixelthen) created the fox media assets. | ||
|
||
[Karen Rustad Tölva](https://www.aldeka.net) designed the original concept of Ferris the crab. | ||
|
||
[Kevin Huang](https://github.com/kevin2huang) created the Akita inu media assets. | ||
|
||
The turtle animations were designed by enkeefe using [Pixelart](https://www.pixilart.com/draw). | ||
|
||
The horse animations were adapted by [Chris Kent](https://github.com/thechriskent) from assets by [Onfe](https://onfe.itch.io/horse-sprite-with-rider-asset-pack). | ||
|
||
[Kennet Shin](https://github.com/WoofWoof0) created the snail media assets. | ||
|
||
The frog animations were created by [seethingswarm](https://seethingswarm.itch.io/frogpack). | ||
|
||
[Jessie Ferris](https://github.com/jeferris) created the panda media assets. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# VS Code Pets | ||
|
||
An extension for VS Code that puts pets in your editor to keep you company whilst you code. | ||
|
||
 | ||
[Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets&WT.mc_id=python-17801-anthonyshaw) | ||
|
||
 | ||
|
||
## Installation | ||
|
||
### From the VS Code Marketplace | ||
|
||
Install this extension from the [VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets&WT.mc_id=python-17801-anthonyshaw). | ||
|
||
### From VS Code | ||
|
||
With VS Code open, search for `vscode-pets` in the extension panel (`Ctrl+Shift+X` on Windows/Linux or `Cmd(⌘)+Shift+X` on MacOS) and click install. | ||
|
||
 | ||
|
||
Alternatively, with VS Code open, launch VS Code Quick Open (`Ctrl+P` on Windows/Linux or `Cmd(⌘)+P` on MacOS), paste the following command, and press enter. | ||
|
||
`ext install tonybaloney.vscode-pets` | ||
|
||
## Getting Started | ||
|
||
Launch VS Code Command Palette (`Ctrl+Shift+P` on Windows/Linux or `Cmd(⌘)+Shift+P` on MacOS, then type `pets` and select `Pets: Start Pet Coding Session`. | ||
|
||
 | ||
|
||
This will open a new sub-panel inside the `Explorer` panel: | ||
|
||
 | ||
|
||
From here, you can add multiple pets, give them names, change the background. Find out how in the [usage section](usage.md). | ||
|
||
## Thank you | ||
|
||
Thanks to all the [contributors](https://github.com/tonybaloney/vscode-pets/graphs/contributors) to this project. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Pets | ||
|
||
## Playing with pets | ||
|
||
Pets will interact with your mouse pointer within the open Pet Panel. Additionally, pets will display text bubbles as you move your mouse over the pet. | ||
|
||
 | ||
|
||
## Adding additional pets | ||
|
||
To add additional pets, run the "Spawn additional pet" command (`vscode-pets.spawn-pet`) or click the `+` icon. | ||
|
||
 | ||
|
||
Once you've done this, select the pet type, color, and then choose a name or use the randomly assigned one. | ||
|
||
 | ||
|
||
If you have more than 1 pet, they become friends. When pets become friends, they will say a little "❤️" and then play chase with each other. | ||
|
||
You can also click the squirrel icon in the bottom of the VS Code Window to create pets. | ||
|
||
## Throwing a ball | ||
|
||
Play catch with your pet! Click the ball icon in the VS Code Pets panel to throw the ball: | ||
|
||
 | ||
|
||
You can also use the "Throw ball" command (`vscode-pets.throw-ball`). | ||
|
||
* Rocky will not run & catch a ball. Have you ever seen a rock run after a ball? Neither have we. | ||
|
||
Want to challenge your pets to a harder game of fetch? Enable the "Throw ball with mouse" (`vscode-pets.throwBallWithMouse`) option in the settings. | ||
Then use the mouse to click and throw the ball: | ||
|
||
 | ||
|
||
## Roll-call with your pets | ||
|
||
Get a description of your current pets within VS Code. Run the "Roll-call" command (`vscode-pets.roll-call`) from the command palette. | ||
|
||
 | ||
|
||
## Removing a single pet or multiple pets | ||
|
||
You can remove all pets (except the 1 configured) by running the "Remove all pets" command (`vscode-pets.delete-pets`) from the command palette. | ||
|
||
You can remove specific pets by clicking the trashcan icon or by running the "Remove pet" command (`vscode-pets.delete-pet`) from the command palette. | ||
|
||
 | ||
|
||
## Importing or Exporting your Pet List | ||
|
||
Have a certain pet setup you would like to share with your friends? | ||
You can export your pet list by running the "Export pet list" command (`vscode-pets.export-pets`) from the command palette. | ||
The pet list can be imported by running the "Import pet list" command (`vscode-pets.import-pets`) from the command palette. | ||
|
||
 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
furo | ||
mkdocs | ||
mkdocs-material |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Themes | ||
|
||
VS Code Pets comes with themes. Themes are set from the VS Code Preferences Window. Search for "vscode-pets" to find the VS Code Pets specific settings. | ||
|
||
Configure `vscode-pets.theme` to `"forest"` and let your pets play in a spooky forest. | ||
|
||
 | ||
|
||
Set `vscode-pets.theme` to `"castle"` for them to roam the ramparts! | ||
|
||
 | ||
|
||
Set `vscode-pets.theme` to `"beach"` for your friends to play by the ocean. | ||
|
||
 | ||
|
||
Set `vscode-pets.theme` to `"winter"` for your pets roam around the snowy mountains. | ||
|
||
 | ||
|
||
If you find the snowfall too distracting, you can disable special effects in settings. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Getting Started with VS Code Pets | ||
|
||
Congrats on installing joy! Enjoy interacting with these cute pixelated pets. | ||
Read below to get a full understanding of this extension. | ||
Not convinced? Watch our extension spotlight on [Visual Studio Code](https://www.youtube.com/watch?v=aE6Ifj_KstI). | ||
|
||
## Start pet coding session to show your pet | ||
|
||
Open the command palette with `Ctrl+Shift+P` on Windows/Linux or `Cmd(⌘)+Shift+P` on MacOS. | ||
|
||
Run the "Start pet coding session" command (`vscode-pets.start`) | ||
|
||
Once you have the pet panel open, you can: | ||
|
||
* [Changing your pet](#changing-your-pet) | ||
* [Place the pet's window](#place-the-pets-window) | ||
* [Playing with pets](pets.md#playing-with-pets) | ||
* [Adding additional pets](pets.md#adding-additional-pets) | ||
* [Throwing a ball](pets.md#throwing-a-ball) | ||
* [Roll-call with your pets](pets.md#roll-call-with-your-pets) | ||
* [Removing a single pet or multiple pets](pets.md#removing-a-single-pet-or-multiple-pets) | ||
* [Importing or Exporting your Pet List](pets.md#importing-or-exporting-your-pet-list) | ||
* [Change the background with themes](themes.md) | ||
|
||
## Changing your pet | ||
|
||
Open the setting panel with `Ctrl+,` on Windows/Linux or `Cmd(⌘)+,` on MacOS. In the search bar, enter “vscode-pets” to see all available options. | ||
|
||
Set a default color, size, pet type, position, and theme when you open a Pet Panel. | ||
|
||
* Pet Color: black, brown, green, yellow, gray, purple, red, white, orange | ||
* Pet Size: nano, small, medium, large | ||
* Pet Type: cat, chicken, crab, clippy, cockatiel, dog, horse, mod, rocky, rubber duck, snake, totoro, turtle, zappy | ||
|
||
 | ||
|
||
### Restrictions | ||
|
||
* Snake can only be green | ||
* Rubber duck & Zappy can only be yellow | ||
* Ferris the crab can only be red | ||
* Rocky can only be gray | ||
* Mod can only be purple | ||
|
||
## Place the pet's window | ||
|
||
To switch the pet's window between *explorer (default)* and *panel*, you can use the command `vscode-pets.position`. | ||
Or in the setting panel the option `Position`. | ||
|
||
 | ||
|
||
**Explorer**: | ||
|
||
 | ||
|
||
**Panel**: | ||
|
||
 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
site_name: VS Code Pets | ||
nav: | ||
- Home: index.md | ||
- Getting Started: getting-started.md | ||
- Pets: pets.md | ||
- Themes: themes.md | ||
- Credits: credits.md | ||
- Contributing: contributing.md | ||
|
||
theme: | ||
name: material | ||
features: | ||
- content.code.copy | ||
repo_url: https://github.com/tonybaloney/vscode-pets | ||
markdown_extensions: | ||
- pymdownx.highlight: | ||
anchor_linenums: true | ||
line_spans: __span | ||
pygments_lang_class: true | ||
- pymdownx.inlinehilite | ||
- pymdownx.snippets | ||
- pymdownx.superfences | ||
- attr_list | ||
- admonition | ||
- pymdownx.details |