Merge pull request #401 from enkeefe/master

Adding a Turtle Pet
tonybaloney · Mar 27, 2023 · 6b393f3 · 6b393f3
2 parents ea7323d + a7cdd11
commit 6b393f3
Show file tree

Hide file tree

Showing 18 changed files with 138 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -62,6 +62,8 @@ The forest theme was designed by [edermunizz](https://edermunizz.itch.io/free-pi
 
 [Karen Rustad Tölva](https://www.aldeka.net) designed the original concept of Ferris the crab.
 
+The turtle animations were designed by enkeefe using [Pixelart](https://www.pixilart.com/draw).
+
 ## Thank you
 
 Thanks to all the [contributors](https://github.com/tonybaloney/vscode-pets/graphs/contributors) to this project.
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -30,9 +30,9 @@ Open the setting panel with `Ctrl+,` on Windows/Linux or `Cmd(⌘)+,` on MacOS.
 
 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 Color: black, brown, green, yellow, gray, purple, red, white, orange
 * Pet Size: nano, small, medium, large
-* Pet Type: cat, chicken, crab, clippy, cockatiel, dog, mod, rocky, rubber duck, snake, totoro, zappy
+* Pet Type: cat, chicken, crab, clippy, cockatiel, dog, mod, rocky, rubber duck, snake, totoro, turtle, zappy
 
 .. image:: _static/screenshot-2.gif
    :alt: Usage screenshot

diff --git a/media/turtle/green_idle_8fps.gif b/media/turtle/green_idle_8fps.gif
diff --git a/media/turtle/green_lie_8fps.gif b/media/turtle/green_lie_8fps.gif
diff --git a/media/turtle/green_run_8fps.gif b/media/turtle/green_run_8fps.gif
diff --git a/media/turtle/green_walk_8fps.gif b/media/turtle/green_walk_8fps.gif
diff --git a/media/turtle/green_with_ball_8fps.gif b/media/turtle/green_with_ball_8fps.gif
diff --git a/media/turtle/orange_idle_8fps.gif b/media/turtle/orange_idle_8fps.gif
diff --git a/media/turtle/orange_lie_8fps.gif b/media/turtle/orange_lie_8fps.gif
diff --git a/media/turtle/orange_run_8fps.gif b/media/turtle/orange_run_8fps.gif
diff --git a/media/turtle/orange_walk_8fps.gif b/media/turtle/orange_walk_8fps.gif
diff --git a/media/turtle/orange_with_ball_8fps.gif b/media/turtle/orange_with_ball_8fps.gif
diff --git a/package.json b/package.json
@@ -158,7 +158,8 @@
                             "gray",
                             "purple",
                             "red",
-                            "white"
+                            "white",
+                            "orange"
                         ],
                         "default": "brown",
                         "description": "Pet color",
@@ -175,12 +176,13 @@
                             "dog",
                             "fox",
                             "mod",
+                            "rat",
                             "rocky",
                             "rubber-duck",
                             "snake",
                             "totoro",
-                            "zappy",
-                            "rat"
+                            "turtle",
+                            "zappy"
                         ],
                         "default": "cat",
                         "description": "Pet type",

diff --git a/src/common/names.ts b/src/common/names.ts
@@ -12,6 +12,7 @@ import { SNAKE_NAMES } from '../panel/pets/snake';
 import { TOTORO_NAMES } from '../panel/pets/totoro';
 import { ZAPPY_NAMES } from '../panel/pets/zappy';
 import { RAT_NAMES } from '../panel/pets/rat';
+import { TURTLE_NAMES } from '../panel/pets/turtle';
 import { PetType } from './types';
 
 export function randomName(type: PetType): string {
@@ -32,6 +33,7 @@ export function randomName(type: PetType): string {
                 [PetType.rocky]: ROCKY_NAMES,
                 [PetType.cockatiel]: COCKATIEL_NAMES,
                 [PetType.rat]: RAT_NAMES,
+                [PetType.turtle]: TURTLE_NAMES,
             } as Record<PetType, ReadonlyArray<string>>
         )[type] ?? CAT_NAMES;
 

diff --git a/src/common/types.ts b/src/common/types.ts
@@ -8,6 +8,7 @@ export const enum PetColor {
     purple = 'purple',
     red = 'red',
     white = 'white',
+    orange = 'orange',
     null = 'null',
 }
 
@@ -25,6 +26,7 @@ export const enum PetType {
     rubberduck = 'rubber-duck',
     snake = 'snake',
     totoro = 'totoro',
+    turtle = 'turtle',
     zappy = 'zappy',
     null = 'null',
 }
@@ -87,6 +89,7 @@ export const ALL_PETS = [
     PetType.rubberduck,
     PetType.snake,
     PetType.totoro,
+    PetType.turtle,
     PetType.zappy,
 ];
 export const ALL_COLORS = [
@@ -99,6 +102,7 @@ export const ALL_COLORS = [
     PetColor.purple,
     PetColor.red,
     PetColor.white,
+    PetColor.orange,
     PetColor.null,
 ];
 export const ALL_SCALES = [

diff --git a/src/panel/pets.ts b/src/panel/pets.ts
@@ -13,6 +13,7 @@ import { Snake } from './pets/snake';
 import { Totoro } from './pets/totoro';
 import { Zappy } from './pets/zappy';
 import { Rat } from './pets/rat';
+import { Turtle } from './pets/turtle';
 import { IPetType } from './states';
 
 export class PetElement {
@@ -201,6 +202,8 @@ export function createPet(
             return new Cockatiel(...standardPetArguments, PetSpeed.normal);
         case PetType.rat:
             return new Rat(...standardPetArguments, PetSpeed.normal);
+        case PetType.turtle:
+            return new Turtle(...standardPetArguments, PetSpeed.slow);
         default:
             throw new InvalidPetException("Pet type doesn't exist");
     }
@@ -236,6 +239,8 @@ export function availableColors(petType: PetType): PetColor[] {
             return Cockatiel.possibleColors;
         case PetType.rat:
             return Rat.possibleColors;
+        case PetType.turtle:
+            return Turtle.possibleColors;
         default:
             throw new InvalidPetException("Pet type doesn't exist");
     }

diff --git a/src/panel/pets/turtle.ts b/src/panel/pets/turtle.ts
@@ -0,0 +1,113 @@
+import { PetColor } from '../../common/types';
+import { BasePetType } from '../basepettype';
+import { States } from '../states';
+
+export class Turtle extends BasePetType {
+    label = 'turtle';
+    static possibleColors = [PetColor.green, PetColor.orange];
+    sequence = {
+        startingState: States.sitIdle,
+        sequenceStates: [
+            {
+                state: States.sitIdle,
+                possibleNextStates: [
+                    States.walkRight,
+                    States.runRight,
+                    States.lie,
+                ],
+            },
+            {
+                state: States.lie,
+                possibleNextStates: [States.walkRight, States.runRight],
+            },
+            {
+                state: States.walkRight,
+                possibleNextStates: [States.walkLeft, States.runLeft],
+            },
+            {
+                state: States.runRight,
+                possibleNextStates: [States.walkLeft, States.runLeft],
+            },
+            {
+                state: States.walkLeft,
+                possibleNextStates: [
+                    States.sitIdle,
+                    States.lie,
+                    States.walkRight,
+                    States.runRight,
+                ],
+            },
+            {
+                state: States.runLeft,
+                possibleNextStates: [
+                    States.sitIdle,
+                    States.lie,
+                    States.walkRight,
+                    States.runRight,
+                ],
+            },
+            {
+                state: States.chase,
+                possibleNextStates: [States.idleWithBall],
+            },
+            {
+                state: States.idleWithBall,
+                possibleNextStates: [
+                    States.walkRight,
+                    States.walkLeft,
+                    States.runLeft,
+                    States.runRight,
+                ],
+            },
+        ],
+    };
+    get emoji(): string {
+        return '🐢';
+    }
+    get hello(): string {
+        return ` Slow and steady wins the race!`;
+    }
+}
+
+export const TURTLE_NAMES: ReadonlyArray<string> = [
+    'Shelldon',
+    'Shelly',
+    'Shelley',
+    'Sheldon',
+    'Tortuga',
+    'Tortellini',
+    'Charlie',
+    'Ross',
+    'Squirt',
+    'Crush',
+    'Squirtle',
+    'Koopa',
+    'Bowser',
+    'Bowsette',
+    'Franklin',
+    'Koopa Troopa',
+    'Blastoise',
+    'Cecil',
+    'Wartortle',
+    'Donatello',
+    'Michaelangelo',
+    'Leonardo',
+    'Leo',
+    'Donny',
+    'Mikey',
+    'Raphael',
+    'Chelone',
+    'Emily',
+    'Joseph',
+    'Anne',
+    'Zagreus',
+    'Kratos',
+    'Atreus',
+    'Loki',
+    'Freya',
+    'Brevity',
+    'Arthur',
+    'Doyle',
+    'Sherlock',
+    'Charli',
+];
diff --git a/src/test/gifs.ts b/src/test/gifs.ts
@@ -56,6 +56,7 @@ const pets: { [key: string]: { colors: string[]; states: string[] } } = {
         colors: ['gray'],
         states: ['idle', 'run', 'swipe', 'walk', 'walk_fast'],
     },
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     'rubber-duck': {
         colors: ['yellow'],
         states: ['idle', 'run', 'swipe', 'walk', 'walk_fast', 'with_ball'],
@@ -88,6 +89,10 @@ const pets: { [key: string]: { colors: string[]; states: string[] } } = {
         colors: ['gray', 'white', 'brown'],
         states: ['idle', 'run', 'swipe', 'walk', 'walk_fast', 'with_ball'],
     },
+    turtle: {
+        colors: ['green', 'orange'],
+        states: ['idle', 'run', 'walk', 'lie', 'with_ball'],
+    },
 };
 
 function checkGifFilenames(folder: string) {