Skip to content

Commit

Permalink
Merge pull request #666 from tonybaloney/markdown_docs
Browse files Browse the repository at this point in the history
Change rst for markdown docs
tonybaloney authored Jan 28, 2025
2 parents 8f2e323 + 915fabb commit 03d046a
Showing 15 changed files with 281 additions and 419 deletions.
11 changes: 5 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Deploy Sphinx with GitHub Pages dependencies preinstalled
name: Deploy Mkdocs site

on:
# Runs on pushes targeting the default branch
@@ -28,15 +28,14 @@ jobs:
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Build HTML with sphinx
- name: Build HTML with mkdocs
run: |
python -m pip install -r requirements.txt
make html
working-directory: docs/
python -m pip install -r docs/requirements.txt
python -m mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html
path: site

# Deployment job
deploy:
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

47 changes: 47 additions & 0 deletions docs/contributing.md
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.
25 changes: 25 additions & 0 deletions docs/credits.md
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.
40 changes: 40 additions & 0 deletions docs/index.md
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 Version](https://img.shields.io/visual-studio-marketplace/v/tonybaloney.vscode-pets?logo=visual-studio)
[Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets&WT.mc_id=python-17801-anthonyshaw)

![Usage screenshot](source/_static/screenshot.gif)

## 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.

![Installation screenshot](source/_static/install.png)

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`.

![Start screenshot](source/_static/start_pet_coding.png)

This will open a new sub-panel inside the `Explorer` panel:

![Step 1 screenshot](source/_static/pet-in-default-explorer.png)

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.
35 changes: 0 additions & 35 deletions docs/make.bat

This file was deleted.

58 changes: 58 additions & 0 deletions docs/pets.md
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.

![Playing with pets](source/_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.

![Add pet](source/_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.

![Pet select](source/_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:

![Throw ball](source/_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.

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:

![Throw ball with mouse](source/_static/throw-ball-with-mouse.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](source/_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.

![Pet remove](source/_static/pet-remove.png)

## 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.

![Pet import-export](source/_static/pet-import-export.gif)
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
furo
mkdocs
mkdocs-material
67 changes: 0 additions & 67 deletions docs/source/conf.py

This file was deleted.

65 changes: 0 additions & 65 deletions docs/source/contributing.rst

This file was deleted.

75 changes: 0 additions & 75 deletions docs/source/index.rst

This file was deleted.

150 changes: 0 additions & 150 deletions docs/source/usage.rst

This file was deleted.

21 changes: 21 additions & 0 deletions docs/themes.md
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.

![Forest theme](source/_static/forest.gif)

Set `vscode-pets.theme` to `"castle"` for them to roam the ramparts!

![Castle theme](source/_static/castle.gif)

Set `vscode-pets.theme` to `"beach"` for your friends to play by the ocean.

![Beach theme](source/_static/beach-pose.png)

Set `vscode-pets.theme` to `"winter"` for your pets roam around the snowy mountains.

![Winter theme](source/_static/winter.gif)

If you find the snowfall too distracting, you can disable special effects in settings.
58 changes: 58 additions & 0 deletions docs/usage.md
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

![Usage screenshot](source/_static/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

## 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`.

![Position setting](source/_static/position-setting.png)

**Explorer**:

![Position explorer](source/_static/position-explorer.png)

**Panel**:

![Position panel](source/_static/position-panel.png)
25 changes: 25 additions & 0 deletions mkdocs.yml
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

0 comments on commit 03d046a

Please sign in to comment.