Skip to content
This repository has been archived by the owner on Jul 30, 2022. It is now read-only.

gadhagod/Hyrule-Compendium-ruby-client

Repository files navigation

Hyrule Compendium API Ruby Wrapper

The official Ruby wrapper for the Hyrule Compendium API.


WE ARE CURRENTLY LOOKING FOR MAINTAINERS FOR THIS PACKAGE. PLEASE EMAIL gadhagod@gmail.com IF YOU ARE INTERESTED.


It's recommended that you read the API documentation before getting started.

Installation

gem install Hyrule-Compendium

Usage

require 'hyrule_compendium'  # import library
compendium = Hyrule_Compendium.new  # create class instance

compendium.get_entry 1  # get entry with ID
compendium.get_entry "horse"  # get entry with name

compendium.get_category "monsters"  # get category

compendium.get_all  # get everthing

compendium.download_entry_image "lynel", "lynel.png"

Detailed docs in code comments.