README.md in xiv_lodestone-0.0.4 vs README.md in xiv_lodestone-0.0.5

- old
+ new

@@ -7,25 +7,26 @@ Please note this gem is currently in Alpha stage of development expect bugs, submit a issue for bug or feature requests. ## Features - Character Search (via ID number or Name and Server) +- To Json functionality - Character profile - name, server, portrait image url - HP, MP, TP - Race, Sex, Clan, Nameday, Guardian, City, Grand Company, Free Company - Gear List - Shows item name, ilevel, slot, ffxiv db url, calculates total ilevel - Disciple List(Classes) - Shows class name, level, current exp, total exp, icon url, calculates experience to next level - All character attributes + - Mounts & Minions + - Server Status + - Job detection ## TODO -- Server Status parser -- Job detection, soul crystal -- To Json functionality -- Achievements, Blogs, Friends list, Mounts, Pets +- Multi-Language support(JP,NA,DE,FR) +- Achievements - Free Company Search/Gather Member information -- Clean up smelly code 24/7 ## Installation Add this line to your application's Gemfile: @@ -46,19 +47,27 @@ This usage of the gem is pretty straight forward most of the method names are directly taken from the lodestone naming conversation. ```ruby require 'xiv_lodestone' -``` +``` To parse a character ```ruby - character = XIVLodestone::Character("Benpi Kancho", "Tonberry") - character = XIVLodestone::Character("Benpi Kancho") - character = XIVLodestone::Character(1549391) -``` + character = XIVLodestone::Character(name: "Benpi Kancho", :server: "Tonberry") + character = XIVLodestone::Character(name: "Benpi Kancho") + character = XIVLodestone::Character(id: 1549391) +``` +Get server status +```ruby + status = XIVLodestone::ServerStatus.new + status.tonberry.name #=> Returns a string server name + status.tonberry.registration #=> Returns a string Open or Closed(Character registration) + status.tonberry.status #=> Retuns a string Online or Offline +``` + Basic examples ```ruby character.name #=> character full name #String character.first_name #=> character first name #String @@ -75,19 +84,22 @@ character.clan #=> character clan #String character.nameday #=> character nameday #String character.guardian #=> character guardian #String character.city #=> character home city #String character.grand_company #=> character grand company #String +character.job #=> characters current job # Character Attributes str, dex, vit, int, mnd, pie, fire, ice, wind, earth, lighting, water, accuracy, critical_hite_rate, determination, defense, parry, magical_defense, attack_power, skill_speed, attack_magic_potency, healing_magic_potency, spell_speed, blunt, piercing, slashing, heavy_resistance, bind_resistance, sleep_resistance, stun_resistance, poison_resistance, blind_resistance, silence_resistance, slow_resistance +character.attribute.str #=> character str #Integer + # Available Gear Slot weapon, head, body, hands, belt, legs, feet, shield, necklace, earrings, bracelets, ring1, ring2 character.gear.weapon # => Hash of below data @@ -107,10 +119,32 @@ character.disciple.rogue.level # => current level #Integer character.disciple.rogue.current_exp # => current experience #Interger character.disciple.rogue.total_exp # => total experience #Integer character.disciple.rogue.icon_url # => class icon url #String character.disciple.rogue.next_level # => experience to required to level #Integer -``` + +# Mounts & Minions +character.mounts.each do |mount| + puts mount.name + puts mount.icon_url +end + +character.minions.each do |minion| + puts minion.name + puts minion.icon_url +end + +character.minions #=> Returns a array of Minion +character.mounts #=> Returns a array of mounts + +# To Json +character.to_json +character.mounts.to_json +character.minions.to_json +character.disciple.to_json +character.gear.to_json +character.attribute.to_json +``` ## Contributing 1. Fork it ( https://github.com/[my-github-username]/xiv-lodestone/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`)