ingadoba v0.0.1
Indie Games Done Badly is an IGDB.com API wrapper for Node.js.
InGaDoBa uses Bluebird promises.
Every method except setHeaders
returns a promise.
Usage
var Ingadoba = require('ingadoba');
var igdb = new Ingadoba({key: 'mashape api key'});
Set custom headers:
igdb.setHeaders({'User-Agent': 'myapp/v1.0.0'});
Available API endpoints: all of them. See the left column here.
'companies'
'franchises'
'games'
'genres'
'keywords'
'people'
'platforms'
'player_perspectives'
'pulses'
'collections'
'themes'
Each endpoint is accessed by calling igdb.[method_name]
, e.g. igdb.games()
.
Each method expects a single argument. The argument is an object with one or more of the following fields:
limit
How many results per page.
offset
How many elements to skip.
fields
An array of fields to fetch. Default is ['*']
, which fetches all available fields. Please try to only request the fields you actually need.
For a full list of available fields please read the online documentation here.
Example:
igdb.games({fields: ['name', 'esrb.rating']});
filters
A list of filters in object form.
The following example gets any game released after 1st Jan 2006 with a rating between 70 and 90:
igdb.games({
filters: {
rating: {gte: 70, lte: 90},
'release_dates.date': {gt: '2006-01-01'}
}
});
The postfixes you can use (e.g. gt
or lte
) are the same as the ones documented on Mashape.
search
Filter the results with a full text search. Any string will do.
order
Specify a sort order. The correct form is: 'field_name:order'.
Example:
igdb.games({
order: 'release_dates.date:asc'
});
Or:
igdb.games({
order: 'rating:desc'
});
Complete example
var query = igdb.games({
search: 'bound',
fields: ['name', 'summary', 'rating', 'release_dates', 'cover'],
filters: {
rating: {gte: 70},
'release_dates.date': {gt: '2010-01-01'}
},
order: 'rating:desc',
limit: 10,
offset: 0
});
query.then(console.log);
Result:
-
id: 7208
name: Bound By Flame
summary:
"""
Bound by Flame lets the players customize their character. During the creation of their hero, players will be able choose their gender and freely alter their facial characteristics. This will of course have an influence on the demon's appearance.
Through its different chapters, Bound by Flame will offer many quests around a primary adventure. Depending on the choices made by the player and the influence of the demon, some chapters will offer different scenarios and a different experience. Bound by Flame also includes a crafting system, allowing them to create and improve equipment, including their armor and weapons. Several companions will join the player during his quest, and will, depending on the player's actions, develop friendship, romance or rivalry. Also, using the crafting, you can customize your weapons and armour with more depth than most other games. for example, you can change the blade and hilt of your sword separately, which not only changes its appearance, but will also change its attributes e.g., + 4 crit, + 3 speed. When fighting enemies, you can use three different fighting styles: one uses slow, heavy, damaging strikes with weapons like axes and hammers, and a push/ kick ability to interrupt enemies or break their defences; another uses small weapons like daggers for quick strikes, and gives you a dodge ability to evade enemy attacks. The third style uses fire attacks for big damage, and can be combined with the other two fighting styles to do things like enhancing weapons with fire damage. Each of the three styles has its own skill tree with both passive and active abilities. During combat, you can use other attacks aside from striking with your weapon, like a crossbow, traps, and abilities you've earned from the skill trees.
"""
release_dates:
-
category: Main Game
platform: 6
date: Fri May 09 2014 02:00:00 GMT+0200 (CEST)
-
category: Main Game
platform: 9
date: Fri May 09 2014 02:00:00 GMT+0200 (CEST)
-
category: Main Game
platform: 48
date: Fri May 09 2014 02:00:00 GMT+0200 (CEST)
-
category: Main Game
platform: 12
date: Fri May 09 2014 02:00:00 GMT+0200 (CEST)
cover:
cloudinary_id: hirridu3oqse4peztfwe
width: 1527
height: 1689
cover_small: https://res.cloudinary.com/igdb/image/upload/t_cover_small/hirridu3oqse4peztfwe.jpg
screenshot_med: https://res.cloudinary.com/igdb/image/upload/t_screenshot_med/hirridu3oqse4peztfwe.jpg
cover_big: https://res.cloudinary.com/igdb/image/upload/t_cover_big/hirridu3oqse4peztfwe.jpg
logo_med: https://res.cloudinary.com/igdb/image/upload/t_logo_med/hirridu3oqse4peztfwe.jpg
screenshot_big: https://res.cloudinary.com/igdb/image/upload/t_screenshot_big/hirridu3oqse4peztfwe.jpg
screenshot_huge: https://res.cloudinary.com/igdb/image/upload/t_screenshot_huge/hirridu3oqse4peztfwe.jpg
thumb: https://res.cloudinary.com/igdb/image/upload/t_thumb/hirridu3oqse4peztfwe.jpg
micro: https://res.cloudinary.com/igdb/image/upload/t_micro/hirridu3oqse4peztfwe.jpg
-
id: 11816
name: YU-NO: A Girl Who Chants Love at the Bound of this World
summary: YU-NO: A Girl Who Chants Love at the Bound of this World is an upcoming remake of a Japanese visual novel of the same title. While the graphics and UI of the remake will be improved and different from the original version, project lead Makoto Asada says that the scenario will be about 95% untouched, and the only bits they'll touch up on are the parts that had problems, and just need small fixes.
release_dates:
-
category: Main Game
platform: 48
date: Thu Feb 18 2016 01:00:00 GMT+0100 (CET)
region: Japan [JP]
-
category: Main Game
platform: 46
date: Thu Feb 18 2016 01:00:00 GMT+0100 (CET)
region: Japan [JP]
cover:
cloudinary_id: c7vkp5pv1tyovzy0ydig
width: 2250
height: 1800
cover_small: https://res.cloudinary.com/igdb/image/upload/t_cover_small/c7vkp5pv1tyovzy0ydig.jpg
screenshot_med: https://res.cloudinary.com/igdb/image/upload/t_screenshot_med/c7vkp5pv1tyovzy0ydig.jpg
cover_big: https://res.cloudinary.com/igdb/image/upload/t_cover_big/c7vkp5pv1tyovzy0ydig.jpg
logo_med: https://res.cloudinary.com/igdb/image/upload/t_logo_med/c7vkp5pv1tyovzy0ydig.jpg
screenshot_big: https://res.cloudinary.com/igdb/image/upload/t_screenshot_big/c7vkp5pv1tyovzy0ydig.jpg
screenshot_huge: https://res.cloudinary.com/igdb/image/upload/t_screenshot_huge/c7vkp5pv1tyovzy0ydig.jpg
thumb: https://res.cloudinary.com/igdb/image/upload/t_thumb/c7vkp5pv1tyovzy0ydig.jpg
micro: https://res.cloudinary.com/igdb/image/upload/t_micro/c7vkp5pv1tyovzy0ydig.jpg
-
id: 15181
name: The Ice-Bound Concordance
summary:
"""
The Ice-Bound Concordance is an award-winning indie game using combinatorial narrative technology, enhanced by a printed book unlocked through augmented reality. Inspired by the mysterious fiction of writers like Borges and books like House of Leaves, the story takes players deep into the frozen ruins of a sinking polar research base.
When a digital simulation of a long-dead author is created to complete his final masterpiece, a story of explorers trapped in at the end of the world, the player must help by exploring hundreds of permutations of his famous stories. By conversing with the troubled A.I. and rearranging his fragmented book, players decide how (and if) his book should end. A logic-driven combinatorial narrative system allows the player's input to shape the story with far more fidelity than most story-based games.
The game works with the physical printed book "The Ice-Bound Compendium." This full-color 80-page art book unlocks new levels and pieces of the A.I. writer's past. Seen through the iPad camera or laptop webcam, the book's pages come alive via augmented reality tech, with new layers of secrets inscribed onto its pages.
"""
release_dates:
-
category: Main Game
platform: 6
date: Thu Jan 21 2016 01:00:00 GMT+0100 (CET)
region: Worldwide [WW]
-
category: Main Game
platform: 39
date: Thu Jan 21 2016 01:00:00 GMT+0100 (CET)
region: Worldwide [WW]
cover:
cloudinary_id: qqphtei4zqmfnag1wylr
width: 1671
height: 621
cover_small: https://res.cloudinary.com/igdb/image/upload/t_cover_small/qqphtei4zqmfnag1wylr.jpg
screenshot_med: https://res.cloudinary.com/igdb/image/upload/t_screenshot_med/qqphtei4zqmfnag1wylr.jpg
cover_big: https://res.cloudinary.com/igdb/image/upload/t_cover_big/qqphtei4zqmfnag1wylr.jpg
logo_med: https://res.cloudinary.com/igdb/image/upload/t_logo_med/qqphtei4zqmfnag1wylr.jpg
screenshot_big: https://res.cloudinary.com/igdb/image/upload/t_screenshot_big/qqphtei4zqmfnag1wylr.jpg
screenshot_huge: https://res.cloudinary.com/igdb/image/upload/t_screenshot_huge/qqphtei4zqmfnag1wylr.jpg
thumb: https://res.cloudinary.com/igdb/image/upload/t_thumb/qqphtei4zqmfnag1wylr.jpg
micro: https://res.cloudinary.com/igdb/image/upload/t_micro/qqphtei4zqmfnag1wylr.jpg
-
id: 15063
name: Zen Bound 2
summary:
"""
Wrap your way to bliss in Zen Bound 2, the unique down-tempo indie game! This is a different gaming experience: an opportunity to slow down, zone out and focus on a task that’s challenging but not stressful, a set of gentle puzzles for the mind and fingers to solve.
The goal of the game is to paint wooden sculptures by wrapping them in rope - a task that may sound simple but has surprising complexity. Each of the levels presents a spatial puzzle that becomes obvious through inspection. Some levels feature paint bombs that are helpful in covering complex areas of the object.
Zen Bound 2 is a calm and meditative gameplay experience, with tactile, dusty visuals and a sublime, enveloping soundtrack by the sensational electronic artist ‘Ghost Monkey’.
"""
release_dates:
-
category: Main Game
platform: 6
date: Sat Oct 02 2010 02:00:00 GMT+0200 (CEST)
-
category: Main Game
platform: 14
date: Sat Oct 02 2010 02:00:00 GMT+0200 (CEST)
-
category: Main Game
platform: 3
date: Sat Oct 02 2010 02:00:00 GMT+0200 (CEST)
-
id: 14790
name: Bound
summary: Bound is a 3D platformer designed for people with the desire to concentrate on the narrative side of games and experience a mature story. On the other side of the spectrum, Bound is also being prepared for hardcore gamers looking for the challenge of one big puzzle that can be only solved by a community of players working together.
release_dates:
-
category: Main Game
platform: 48
date: Tue Aug 16 2016 02:00:00 GMT+0200 (CEST)
region: Worldwide [WW]
cover:
cloudinary_id: qlsahjpnesg7dvlhjmlg
width: 225
height: 60
cover_small: https://res.cloudinary.com/igdb/image/upload/t_cover_small/qlsahjpnesg7dvlhjmlg.jpg
screenshot_med: https://res.cloudinary.com/igdb/image/upload/t_screenshot_med/qlsahjpnesg7dvlhjmlg.jpg
cover_big: https://res.cloudinary.com/igdb/image/upload/t_cover_big/qlsahjpnesg7dvlhjmlg.jpg
logo_med: https://res.cloudinary.com/igdb/image/upload/t_logo_med/qlsahjpnesg7dvlhjmlg.jpg
screenshot_big: https://res.cloudinary.com/igdb/image/upload/t_screenshot_big/qlsahjpnesg7dvlhjmlg.jpg
screenshot_huge: https://res.cloudinary.com/igdb/image/upload/t_screenshot_huge/qlsahjpnesg7dvlhjmlg.jpg
thumb: https://res.cloudinary.com/igdb/image/upload/t_thumb/qlsahjpnesg7dvlhjmlg.jpg
micro: https://res.cloudinary.com/igdb/image/upload/t_micro/qlsahjpnesg7dvlhjmlg.jpg