Icontem

JavaScript Super Mario Maker Course Search: Search for courses for Super Mario Maker

Recommend this page to a friend!
  Info   View files Documentation   View files View files (8)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2019-05-11 (9 days ago) RSS 2.0 feedNot yet rated by the usersTotal: 7 All time: 538 This week: 7Up
Version License JavaScript version Categories
smm-course-search 1.0.1Custom (specified...5Node.js, Web services, Games
Description Author

This package can search for courses for Super Mario Maker.

It can send HTTP requests to the Nintendo Super Mario Maker API Web server to perform queries for available courses in Super Mario Maker.

The package calls a given callback function when the search query response returns search results.

  Performance   Level  
Name: Leonardo Mauro Pereira ... <contact>
Classes: 5 packages by
Country: Brazil Brazil
Age: 24
All time rank: 16116 in Brazil Brazil
Week rank: 21 Up3 in Brazil Brazil Up
Innovation award
Innovation award
Nominee: 3x

Winner: 3x

Details

smm-course-search

GPLv3 license npm JsClasses GitHub Codacy Badge

Super Mario Maker is a game from Nintendo Inc. This module can search courses from the official bookmark site. This module can request and fetching courses data information just passing a query search.

  

By response the module call a callback function with 2 arguments (error, courses). These arguments: the first is a boolean to check sucess in fetching; and the second is a json with courses informations (like ID, image, maker, difficulty..).

Note: This module makes analysis on the html structure of the bookmark site. In case of site changes, the smm-course-search system may not work correctly.

Installation

npm install --save smm-course-search

Package

courses json

The data information retrive:

id: '0000-0000-0000-0000',
difficulty: [..],
clearRate: number,
title: 'Name',
img: 'Url',
thumbnailImg: 'Url',
gameStyle: [..],
createdAt: Timestamp,
tag: [..],
stared: number,
played: number,
shared: number,
clears: number,
attempts: number,
maker: 
  \_ login: 'Nintendo ID',
  \_ faceImg: 'Url',
  \_ flag: 'Country',
  \_ name: 'Name'

Query Params

The query search parameters are optional, but must be pass at least one.

{
  gameStyle: ['all', 'marioBros', 'marioBros3', 'marioWorld', 'marioBrosU'],
  courseTheme: ['all', 'ground', 'underground', 'underwater', 'ghostHouse', 'airship', 'castle'],
  region: ['all', 'jp', 'us', 'eu', 'other'],
  difficulty: ['all', 'easy', 'normal', 'expert', 'superExpert'],
  tag: ['all', 'automatic', 'music', 'puzzle', 'gimmick', 'dash', 
        'remix', 'thumbnail', 'costume', 'yoshi', 'theme', 'speedrun', 
        'autoscroll', 'shootEmUp', 'track', 'tradicional'],
  uploadDate: ['all', 'pastDay', 'pastWeek', 'pastMonth', 'beforeOneMonth'],
  sortBy: ['all', 'starRate', 'totalStars', 'lowestClearRate', 'timesShared', 'mostRecent']
}
  

Functions

There are three functions to search courses:

  • .getCourses(query, function(error, courses){} - return first page (max 10 courses).
  • .getCoursesPages(query, (int) firstPage, (int) lastPage, function(error, courses){} - return n pages.
  • .getInfinity(query, function(error, courses){} - search all pages.

Example

Example: How search courses. See test/test.js for other examples.

/Include/
var SmmCourseSearch = require('smm-course-search');

// ## Try search courses
// For example to get the most recents courses

var query = {
    region: 'us',
    uploadDate: 'pastDay',
    sortBy: 'mostRecent'
};

console.time('test');
SmmCourseSearch.getCourses(query, function(error, courses){
    if(error) console.log('> Courses not exist.');
    else console.log(courses);
    console.timeEnd('test');
});

Also look ~

  Files folder image Files  
File Role Description
Files folder imagelib (3 files)
Files folder imagetest (1 file)
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file package-lock.json Data Auxiliary data
Accessible without login Plain text file package.json Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  lib  
File Role Description
  Plain text file CoursesWrapper.js Class Class source
  Plain text file SmmCourseSearch.js Class Class source
  Plain text file Typography.js Class Class source

  Files folder image Files  /  test  
File Role Description
  Accessible without login Plain text file test.js Aux. Auxiliary script

 Version Control Unique User Downloads Download Rankings  
 100%
Total:7
This week:0
All time:538
This week:7Up