Skip to content

lizriderwilson/acnh-critterpedia

Repository files navigation

ACNH Critterpedia

ACNH Critterpedia is a CLI application for interacting with the Critterpedia from Animal Crossing New Horizons. It allows you to see what critters are available to catch at the current moment, as well as searching critters by month and pulling up information on specific critters.

Future functionality is planned to allow adding critters to your personal collection so you can use the Critterpedia to keep track of which critters you still need to catch.

Installation

To install, run the following command:

$ gem install acnh_critterpedia

Usage

After installing, run $ acnh_critterpedia to start the application.

ACNH Critterpedia is an interactive app for interfacing with Animal Crossing New Horizon's Critterpedia. It is for personal use to help you keep track of available critters while you play the game!

Development

After checking out the repo, run bin/setup to install dependencies.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/merlumina/acnh_critterpedia. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the AcnhCritterpedia project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

CLI application to get critter information for Animal Crossing: New Horizons.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published