Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leomaurodesenv/smm-course-viewer
A package to reading courses (*.cdt) - Super Mario Maker
https://github.com/leomaurodesenv/smm-course-viewer
cdt javascript json mario-game mario-maker nodejs viewer
Last synced: 7 days ago
JSON representation
A package to reading courses (*.cdt) - Super Mario Maker
- Host: GitHub
- URL: https://github.com/leomaurodesenv/smm-course-viewer
- Owner: leomaurodesenv
- License: gpl-3.0
- Created: 2019-01-25T11:52:22.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-06T19:00:04.000Z (over 5 years ago)
- Last Synced: 2024-10-14T02:49:41.422Z (27 days ago)
- Topics: cdt, javascript, json, mario-game, mario-maker, nodejs, viewer
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/smm-course-viewer
- Size: 69.1 MB
- Stars: 18
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- game-datasets - smm-course-viewer - Read courses from Super Mario Maker saves. (API)
README
# smm-course-viewer
[](LICENSE.md)
[](https://www.npmjs.com/package/smm-course-viewer)
[](https://www.jsclasses.org/smm-course-viewer)
[](https://github.com/leomaurodesenv/smm-course-viewer)
[](https://www.codacy.com/app/leomaurodesenv/smm-course-viewer?utm_source=github.com&utm_medium=referral&utm_content=leomaurodesenv/smm-course-viewer&utm_campaign=Badge_Grade)
Simple viewer for level files from Super Mario Maker ([Online](http://projects.leonardomauro.com/smm-course-viewer/)). Based on [MarioUnmaker](https://github.com/Treeki/MarioUnmaker/) and [PointlessMaker](https://github.com/aboood40091/PointlessMaker).
This package has two main features:
1. `SmmCourseViewer`: Interpret/extract course data from .cdt files.
2. `Draw`: Draw the course in a HTML Canvas element.
The code is developed in Vanilla JS, but with extension to Node.js ([Code Documentation](/lib)).
Explore the monsters and objects of your Super Mario Maker courses, see ([Data Format](FORMAT.md)) for more details.
---
## Summary
- [Code Documentation](/lib)
- [Drawing Documentation](/draw)
- [Data Format](FORMAT.md)
- [Installation](#installation)
- [Object Structure](#object-structure)
---
## Installation
1. Download or git clone.
- `git clone https://github.com/leomaurodesenv/smm-course-viewer.git`
2. Download the images `/layout/draw/monster/` and `/layout/draw/titleset/`
3. Open the `/index.html` in a web browser.
4. _Load Example_ or _Browse..._ to a \*.cdt file.
To use the Node.js:
```shell
npm install --save smm-course-viewer
```
---
## Node.js Example
Example: How to read courses files.
Run this example `nodejs test/test.js`.
```js
/* Include */
const smmCourseViewer = require('smm-course-viewer');
// ## Try interpret a course file
smmCourseViewer.read('path/course_data.cdt', function(err, course, objects) {
if(!err) {
console.log(course)
console.log(objects);
}
});
```
---
## Object Structure
Accessing by a web browser:
1. After _Load Example_ or _Browse_ for a file, the object is created.
2. Open the web console, usually `Ctrl+Shift+k` or `F12`, and type `smmCourseViewer`.
```javascript
course:
\_ name: string
\_ mode: ['M1', 'M3', 'MW', 'WU']
\_ timeLimit: number
\_ scroll: [0, 1, 2, 3]
\_ scrollName: ['none', 'slow', 'medium', 'fast']
\_ theme: [0, 1, 2, 3, 4, 5]
\_ themeName: ['overworld', 'underground', 'castle',
'airship', 'water', 'ghostHouse']
\_ year: number (creation)
\_ month: number (creation)
\_ day: number (creation)
\_ hour: number (creation)
\_ minute: number (creation)
\_ width: number
\_ widthBlock: number of blocks
\_ heightBlock: number of blocks
\_ objectCount: number
\_ checksum: number (file check)
\_ version: number
\_ flags: (unknown)
\_ hexMiiData: (unknown)
objects:
\_ Array[CourseObject]
```
```javascript
CourseObject:
\_ name: string
\_ x: X-axis
\_ y: Y-axis
\_ z: Z-index
\_ height: number
\_ width: number
\_ size: number (only monsters)
\_ wing: boolean (only monsters)
\_ type: number (monster ID)
\_ subType: number (sub ID)
\_ flags: number (under discovery)
\_ extendedData: number
\_ effect: number (unknown)
\_ transform: number (unknown)
\_ childFlags: number (under discovery)
\_ childTransform: number (unknown)
\_ childType: number (coupled monster)
\_ linkId: number (coupled monster ~father)
```
---
## Also look ~
Any suggestions or doubts, please open an "issue".
If you want to contribute, make a "pull request".
- [License GPLv3](LICENSE)
- Create by Leonardo Mauro ~ [leomaurodesenv](https://github.com/leomaurodesenv/)