diff --git a/README.md b/README.md index ab6f89b4..826dbd8d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Puts a small, bored cat, an enthusiastic dog, a feisty snake, a rubber duck, or [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/tonybaloney.vscode-pets?color=blue&logo=visual-studio)](https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets&WT.mc_id=python-17801-anthonyshaw) -![screenshot](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot.gif) +![screenshot](https://github.com/tonybaloney/vscode-pets/raw/master/docs/source/_static/screenshot.gif) ## Installation @@ -26,145 +26,13 @@ With VS Code open, launch VS Code Quick Open (`Ctrl+P` on Windows/Linux or `Cmd( 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). -Available commands are prefaced with `Pet Coding` in the Command Palette: -* Start pet coding session -* Spawn extra pet -* Throw ball -* Roll-call -* Remove pet -* Remove all pets +After installing, open the command palette with `Ctrl+Shift+P` on Windows/Linux or `Cmd(⌘)+Shift+P` on MacOS. -## Configure vscode-pets in the VS Code settings +Run the "Start pet coding session" command (`vscode-pets.start`) to see a cat in VS Code: -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. +![Default view](https://github.com/tonybaloney/vscode-pets/raw/master/docs/source/_static/pet-in-default-explorer.png) -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 -* Pet Size: nano, medium, large -* Pet Type: cat, crab, clippy, cockatiel, dog, mod, rocky, rubber duck, snake, totoro, zappy -* Position: panel, explorer -* Theme: none, forest, castle, beach - -![screenshot2](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot-2.gif) - -### 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 - -## 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`) - -## Playing - -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. - -![screenshot3](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot-3.gif) - -## Adding extra pets - -Run the "Spawn additional pet" command (`vscode-pets.spawn-pet`) and select the pet type and color. - -Extra pets will not persist between closing and restarting VS Code. - -![pet-select](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/pet-select.png) - -## Throwing a ball - -Play catch with your pet! Run 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. - -![screenshot4](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot-4.gif) - -## 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. - -![pet-roll-call](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/pet-roll-call.png) - -## 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 running the "Remove pet" command (`vscode-pets.delete-pet`) from the command palette. - -![pet-remove](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/pet-remove.png) - -## Themes - -Configure `vscode-pets.theme` to `"forest"` and let your pets play in a spooky forest. - -![forest](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/forest.gif) - -Set `vscode-pets.theme` to `"castle"` for them to roam the ramparts! - -![castle](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/castle.gif) - -Set `vscode-pets.theme` to `"beach"` for your friends to play by the ocean. - -![beach](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/beach-pose.png) - -## 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`. - -``` -Version: 1.72.0 -Commit: 64bbfbf67ada9953918d72e1df2f4d8e537d340e -Date: 2022-10-04T23:20:47.539Z -Electron: 19.0.17 -Chromium: 102.0.5005.167 -Node.js: 16.14.2 -V8: 10.2.154.15-electron.0 -OS: Linux x64 5.19.12-200.fc36.x86_64 -Sandboxed: No -``` - -### 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. +[Now checkout the documentation to see what else is possible!](https://tonybaloney.github.io/vscode-pets) ## Credits diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..d1638636 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +build/ \ No newline at end of file diff --git a/docs/source/_static/add-pet.png b/docs/source/_static/add-pet.png new file mode 100644 index 00000000..35570d5f Binary files /dev/null and b/docs/source/_static/add-pet.png differ diff --git a/screenshots/beach-pose.png b/docs/source/_static/beach-pose.png similarity index 100% rename from screenshots/beach-pose.png rename to docs/source/_static/beach-pose.png diff --git a/screenshots/castle.gif b/docs/source/_static/castle.gif similarity index 100% rename from screenshots/castle.gif rename to docs/source/_static/castle.gif diff --git a/screenshots/forest.gif b/docs/source/_static/forest.gif similarity index 100% rename from screenshots/forest.gif rename to docs/source/_static/forest.gif diff --git a/docs/source/_static/install.png b/docs/source/_static/install.png new file mode 100644 index 00000000..f7ae5eca Binary files /dev/null and b/docs/source/_static/install.png differ diff --git a/docs/source/_static/pet-in-default-explorer.png b/docs/source/_static/pet-in-default-explorer.png new file mode 100644 index 00000000..e459bf4f Binary files /dev/null and b/docs/source/_static/pet-in-default-explorer.png differ diff --git a/screenshots/pet-remove.png b/docs/source/_static/pet-remove.png similarity index 100% rename from screenshots/pet-remove.png rename to docs/source/_static/pet-remove.png diff --git a/screenshots/pet-roll-call.png b/docs/source/_static/pet-roll-call.png similarity index 100% rename from screenshots/pet-roll-call.png rename to docs/source/_static/pet-roll-call.png diff --git a/screenshots/pet-select.png b/docs/source/_static/pet-select.png similarity index 100% rename from screenshots/pet-select.png rename to docs/source/_static/pet-select.png diff --git a/screenshots/screenshot-2.gif b/docs/source/_static/screenshot-2.gif similarity index 100% rename from screenshots/screenshot-2.gif rename to docs/source/_static/screenshot-2.gif diff --git a/screenshots/screenshot-3.gif b/docs/source/_static/screenshot-3.gif similarity index 100% rename from screenshots/screenshot-3.gif rename to docs/source/_static/screenshot-3.gif diff --git a/screenshots/screenshot-4.gif b/docs/source/_static/screenshot-4.gif similarity index 100% rename from screenshots/screenshot-4.gif rename to docs/source/_static/screenshot-4.gif diff --git a/screenshots/screenshot-5.gif b/docs/source/_static/screenshot-5.gif similarity index 100% rename from screenshots/screenshot-5.gif rename to docs/source/_static/screenshot-5.gif diff --git a/screenshots/screenshot-6.gif b/docs/source/_static/screenshot-6.gif similarity index 100% rename from screenshots/screenshot-6.gif rename to docs/source/_static/screenshot-6.gif diff --git a/screenshots/screenshot.gif b/docs/source/_static/screenshot.gif similarity index 100% rename from screenshots/screenshot.gif rename to docs/source/_static/screenshot.gif diff --git a/docs/source/_static/start_pet_coding.png b/docs/source/_static/start_pet_coding.png new file mode 100644 index 00000000..689ab046 Binary files /dev/null and b/docs/source/_static/start_pet_coding.png differ diff --git a/docs/source/_static/step-1.png b/docs/source/_static/step-1.png new file mode 100644 index 00000000..724eda6b Binary files /dev/null and b/docs/source/_static/step-1.png differ diff --git a/docs/source/_static/throw-ball.gif b/docs/source/_static/throw-ball.gif new file mode 100644 index 00000000..a57c0015 Binary files /dev/null and b/docs/source/_static/throw-ball.gif differ diff --git a/docs/source/conf.py b/docs/source/conf.py index 673c02ea..eba9f895 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -27,8 +27,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [ -] +extensions = ['sphinx.ext.autosectionlabel'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -49,4 +48,20 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ['_static'] +html_logo = 'logo.png' +html_css_files = [ + "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css", + "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css", + "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css", +] +html_theme_options = { + "footer_icons": [ + { + "name": "GitHub", + "url": "https://github.com/tonybaloney/vscode-pets", + "html": "", + "class": "fa-solid fa-github fa-2x", + }, + ], +} \ No newline at end of file diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst new file mode 100644 index 00000000..577c586b --- /dev/null +++ b/docs/source/contributing.rst @@ -0,0 +1,59 @@ +Contributing +------------ + +Ideas and discussion +++++++++++++++++++++ + +Have an awesome idea for a new feature? Please `open an issue `_ describing your idea! You can also help by reviewing some of the `existing ideas `_ and leaving your opinion. + +Reporting bugs +++++++++++++++ + +Something is not working as it should? Please `open an issue `_ 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`. + + + Version: 1.72.0 + Commit: 64bbfbf67ada9953918d72e1df2f4d8e537d340e + Date: 2022-10-04T23:20:47.539Z + Electron: 19.0.17 + Chromium: 102.0.5005.167 + Node.js: 16.14.2 + V8: 10.2.154.15-electron.0 + OS: Linux x64 5.19.12-200.fc36.x86_64 + Sandboxed: No + +Write code +++++++++++ + +Want to contribute to vscode-pets? Feel free to `fork the repository `_ 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 `_ 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 `_ for additional resources. diff --git a/docs/source/index.rst b/docs/source/index.rst index 6dc6b898..91d20f62 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,198 +3,73 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to VS Code Pets's documentation! -======================================== +VS Code Pets +============ -.. toctree:: - :maxdepth: 2 - :caption: Contents: - -# VS Code Pets +An extension for VS Code that puts pets in your editor to keep you company whilst you code. -![icon](https://github.com/tonybaloney/vscode-pets/raw/master/icon.png) +.. image:: https://img.shields.io/visual-studio-marketplace/v/tonybaloney.vscode-pets?logo=visual-studio + :alt: Visual Studio Marketplace Version + :target: https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets&WT.mc_id=python-17801-anthonyshaw -Puts a small, bored cat, an enthusiastic dog, a feisty snake, a rubber duck, or Clippy 📎 in your code editor to boost productivity. +.. image:: _static/screenshot.gif + :alt: Usage screenshot -[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/tonybaloney.vscode-pets?color=blue&logo=visual-studio)](https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets&WT.mc_id=python-17801-anthonyshaw) +Installation +------------ -![screenshot](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot.gif) +From the VS Code Marketplace +++++++++++++++++++++++++++++ -## Installation +Install this extension 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). - -OR +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. -OR +.. image:: _static/install.png + :alt: Installation screenshot -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. +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` -## Using 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). - -Available commands are prefaced with `Pet Coding` in the Command Palette: -* Start pet coding session -* Spawn extra pet -* Throw ball -* Roll-call -* Remove pet -* Remove all pets - -## Configure vscode-pets in the VS Code settings - -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 -* Pet Size: nano, medium, large -* Pet Type: cat, crab, clippy, cockatiel, dog, mod, rocky, rubber duck, snake, totoro, zappy -* Position: panel, explorer -* Theme: none, forest, castle, beach - -![screenshot2](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot-2.gif) - -### 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 - -## 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`) - -## Playing - -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. - -![screenshot3](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot-3.gif) - -## Adding extra pets - -Run the "Spawn additional pet" command (`vscode-pets.spawn-pet`) and select the pet type and color. - -Extra pets will not persist between closing and restarting VS Code. - -![pet-select](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/pet-select.png) - -## Throwing a ball - -Play catch with your pet! Run 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. - -![screenshot4](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot-4.gif) - -## Roll-call with your pets +Getting Started +--------------- -Get a description of your current pets within VS Code. Run the "Roll-call" command (`vscode-pets.roll-call`) from the command palette. +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`. -![pet-roll-call](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/pet-roll-call.png) +.. image:: _static/start_pet_coding.png + :alt: Start screenshot -## Removing a single pet or multiple pets +This will open a new sub-panel inside the `Explorer` panel: -You can remove all pets (except the 1 configured) by running the "Remove all pets" command (`vscode-pets.delete-pets`) from the command palette. +.. image:: _static/pet-in-default-explorer.png + :alt: Step 1 screenshot -You can remove specific pets by running the "Remove pet" command (`vscode-pets.delete-pet`) from the command palette. +From here, you can add multiple pets, give them names, change the background. Find out how in the `usage section `_. -![pet-remove](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/pet-remove.png) - -## Themes - -Configure `vscode-pets.theme` to `"forest"` and let your pets play in a spooky forest. - -![forest](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/forest.gif) - -Set `vscode-pets.theme` to `"castle"` for them to roam the ramparts! - -![castle](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/castle.gif) - -Set `vscode-pets.theme` to `"beach"` for your friends to play by the ocean. - -![beach](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/beach-pose.png) - -## 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`. - -``` -Version: 1.72.0 -Commit: 64bbfbf67ada9953918d72e1df2f4d8e537d340e -Date: 2022-10-04T23:20:47.539Z -Electron: 19.0.17 -Chromium: 102.0.5005.167 -Node.js: 16.14.2 -V8: 10.2.154.15-electron.0 -OS: Linux x64 5.19.12-200.fc36.x86_64 -Sandboxed: No -``` - -### 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. - -## Credits +Credits +------- The cat and dog media assets for this extension were licensed from itch.io. -[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. +`Marc Duiker `_ created the Clippy, Rocky, Zappy, rubber duck, snake, cockatiel, Ferris the crab, and Mod the dotnet bot media assets. -[Karen Rustad Tölva](https://www.aldeka.net) designed the original concept of Ferris the crab. +`Karen Rustad Tölva `_ designed the original concept of Ferris the crab. Thank you +--------- -Thanks to all the [contributors](https://github.com/tonybaloney/vscode-pets/graphs/contributors) to this project. - +Thanks to all the `contributors `_ to this project. -Indices and tables -================== +.. toctree:: + :glob: + :maxdepth: 1 + :hidden: -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + self + usage + contributing diff --git a/docs/source/logo.png b/docs/source/logo.png new file mode 100644 index 00000000..c159ccf1 Binary files /dev/null and b/docs/source/logo.png differ diff --git a/docs/source/usage.rst b/docs/source/usage.rst new file mode 100644 index 00000000..b0bc4c9b --- /dev/null +++ b/docs/source/usage.rst @@ -0,0 +1,114 @@ +Using 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 `_. + +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: + +* :ref:`Changing your pet` +* :ref:`Playing with pets` +* :ref:`Adding additional pets` +* :ref:`Throwing a ball` +* :ref:`Roll-call with your pets` +* :ref:`Removing a single pet or multiple pets` +* :ref:`Themes` + +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 +* Pet Size: nano, medium, large +* Pet Type: cat, crab, clippy, cockatiel, dog, mod, rocky, rubber duck, snake, totoro, zappy + +.. image:: _static/screenshot-2.gif + :alt: Usage screenshot + +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 + +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. + +.. image:: _static/screenshot-3.gif + +Adding additional pets +---------------------- + +To add additional pets, run the "Spawn additional pet" command (`vscode-pets.spawn-pet`) or click the `+` icon. + +.. image:: _static/add-pet.png + +Once you've done this, select the pet type, color, and then choose a name or use the randomly assigned one. + +.. image:: _static/pet-select.png + +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: + +.. image:: _static/throw-ball.gif + +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. + +.. image:: _static/screenshot-4.gif + +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. + +.. image:: _static/pet-roll-call.png + +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. + +.. image:: _static/pet-remove.png + +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. + +.. image:: _static/forest.gif + +Set `vscode-pets.theme` to `"castle"` for them to roam the ramparts! + +.. image:: _static/castle.gif + +Set `vscode-pets.theme` to `"beach"` for your friends to play by the ocean. + +.. image:: _static/beach-pose.png