Animal Compatibility Checker

Description

The Animal Compatibility Checker is a simple web application that allows users to select one or two animal species to check their compatibility based on data from the game Planet Zoo. Users can see detailed compatibility levels grouped by tier (0-4) or specific compatibility between two chosen animals.

Features

• Single Animal Selection: Provides compatibility information for the selected animal with all other animals, grouped by their compatibility tier.
• Dual Animal Selection: Shows the compatibility level between two specifically selected animals.
• Easy to Use Interface: User-friendly dropdown menus for animal selection.
• Instant Results: Compatibility results are displayed immediately after selection.

Credit

This app wouldn't be possible without the data collected and provided by Villanelle (Steam/Reddit). Their spreadsheet has tons of awesome information way beyond compatibility linked here: https://docs.google.com/spreadsheets/d/1J5YrIya-yduiAqBC-dEHyBYZ8Ev3KsTM6fyP7DsKUJQ/edit#gid=1480260872

Usage

To use the application, follow these steps:

1. Open the project URL: https://msarczar.github.io/msarczar/Planet-Zoo-Animal-Compatibility
2. Use the dropdown menus to select one or two animals.
3. Click the "Check Compatibility" button to display the compatibility results.

For local testing:

1. Open index.html in your web browser.

Installation

This project is hosted on GitHub Pages and does not require any installation. However, if you wish to run it locally or contribute to the development, you can follow these steps:

1. Clone the repository:

   git clone https://github.com/msarczar/Planet-Zoo-Animal-Compatibility.git

2. Navigate into the repository directory:

   cd Planet-Zoo-Animal-Compatibility

Contributing

Contributions to the Animal Compatibility Checker are welcome! Here are some ways you can contribute:

• Reporting bugs
• Suggesting enhancements
• Pull Requests

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Contact

• Project Link: https://github.com/msarczar/Planet-Zoo-Animal-Compatibility/
• Issue Tracker: https://github.com/msarczar/Planet-Zoo-Animal-Compatibility/issues