This project brings animated pets to your computer terminal. These small digital characters sit in your command window while you work. They respond to your input and keep the workspace interesting. You spend many hours at your computer, and these characters provide visual interest during long tasks.
Before you start, ensure your computer meets these requirements:
- Windows 10 or Windows 11.
- A stable internet connection.
- Node.js installed on your machine.
If you do not have Node.js, go to the official website and download the Windows Installer. Run the installer and follow the prompts on your screen. This software enables your computer to run the scripts that power your animated pets.
You must visit the project page to access the files. Use the link below to reach the repository.
Click the green button labeled "Code" on the page and select "Download ZIP." Save this folder to your desktop. Right-click the folder and select "Extract All" to see the contents.
Follow these steps to set up your pets. You will use the Command Prompt, which is a standard tool on Windows.
- Open the Start menu.
- Type "cmd" and press Enter.
- Type the command
npx codex-pet-cliand press Enter.
The system will ask if you want to install the necessary packages. Type "y" and press Enter. The software downloads the library of 174+ pets. Once the download finishes, the program prompts you to choose a character. Use your arrow keys to scroll through the list and press Enter to select your preferred pet.
Once installed, your pet appears in the terminal window. Each character has unique animations. Some pets move across the screen, while others interact with your commands.
To change your pet, run the command again. The system remembers your previous settings. If you want to see a full list of available pets, visit codex-pet.com. This website contains a gallery of all 174+ animated characters. You can view high-resolution previews before you select one for your computer.
The project welcomes community contributions. If you create an animated pet, you can add it to the collection.
- Prepare your animation files in a small image format.
- Visit the website provided in the description.
- Follow the instructions to upload your creation.
- Fill in the required fields with your name and the pet name.
The project curators review your submission. Once they approve it, your pet joins the main list. Other users can then select your pet when they run the same command.
If you encounter issues, check these common items:
- Ensure your internet connection stays active during the initial setup.
- Update your Node.js version if the command returns an error.
- Check that your terminal window has enough space to render the animation.
- Close and reopen your terminal if the pet does not appear on the first try.
These pets are lightweight and do not slow down your computer. They perform well on standard hardware. If your screen resolution is too low, the terminal might hide some parts of the animation. Resize your window to see the full movement of the pet.
The collection includes pets from various categories. Some are classic pixel art, while others feature modern animation styles. The list grows as more contributors join the project. You find themes ranging from animals and mythical creatures to robots and objects.
This tool serves as a fun way to personalize your workstation. Software development can involve repetitive tasks, and these visual companions provide a small break for your eyes. You can switch pets as often as you like to keep your environment fresh. The command-line interface remains fully functional while the pet stays active on the screen. It occupies a small area of the window and does not block your text input.
This repository acts as the central hub for all development related to these terminal-based characters. Keep track of the page for updates to the software or new additions to the pet library. Future updates will include new settings to change the pet background or add sound effects. Participate in the community to shape the future of this project.