Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leomaurodesenv/smm-course-search
A package to searching courses - Super Mario Maker
https://github.com/leomaurodesenv/smm-course-search
bookmark-site crawler javascript json mario-game mario-maker nodejs
Last synced: 3 months ago
JSON representation
A package to searching courses - Super Mario Maker
- Host: GitHub
- URL: https://github.com/leomaurodesenv/smm-course-search
- Owner: leomaurodesenv
- License: gpl-3.0
- Created: 2017-08-31T13:29:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T19:26:30.000Z (about 2 years ago)
- Last Synced: 2024-04-12T15:28:40.040Z (10 months ago)
- Topics: bookmark-site, crawler, javascript, json, mario-game, mario-maker, nodejs
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/smm-course-search
- Size: 2.28 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- game-datasets - smm-course-search - Search courses from Super Mario Maker game. (API)
README
# smm-course-search
[](LICENSE.md)
[](https://www.npmjs.com/package/smm-course-search)
[](https://www.jsclasses.org/smm-course-search)
[](https://github.com/leomaurodesenv/smm-course-search)
[](https://www.codacy.com/app/leomaurodesenv/smm-course-search?utm_source=github.com&utm_medium=referral&utm_content=leomaurodesenv/smm-course-search&utm_campaign=Badge_Grade)
---
Super Mario Maker is a game from Nintendo Inc. This module can search courses from the official [bookmark site](https://supermariomakerbookmark.nintendo.net).
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
```shell
npm install --save smm-course-search
```
---
## Package
### `courses` json
The data information retrive:
```js
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.
```js
{
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.
```js
/* 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 ~
- [License GPL v3](LICENSE)
- Create by Leonardo Mauro ~ [leomaurodesenv](https://github.com/leomaurodesenv/)