{"id":13528608,"url":"https://github.com/leomaurodesenv/smm-course-viewer","last_synced_at":"2025-06-26T10:03:40.846Z","repository":{"id":57364200,"uuid":"167539878","full_name":"leomaurodesenv/smm-course-viewer","owner":"leomaurodesenv","description":"A package for reading courses (*.cdt) from Super Mario Maker game","archived":false,"fork":false,"pushed_at":"2019-05-06T19:00:04.000Z","size":72411,"stargazers_count":17,"open_issues_count":1,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-06T14:43:48.588Z","etag":null,"topics":["cdt","javascript","json","mario-game","mario-maker","nodejs","viewer"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/smm-course-viewer","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leomaurodesenv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-25T11:52:22.000Z","updated_at":"2025-01-04T03:46:35.000Z","dependencies_parsed_at":"2022-08-29T11:01:48.135Z","dependency_job_id":null,"html_url":"https://github.com/leomaurodesenv/smm-course-viewer","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/leomaurodesenv/smm-course-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fsmm-course-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fsmm-course-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fsmm-course-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fsmm-course-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leomaurodesenv","download_url":"https://codeload.github.com/leomaurodesenv/smm-course-viewer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fsmm-course-viewer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262044434,"owners_count":23249748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cdt","javascript","json","mario-game","mario-maker","nodejs","viewer"],"created_at":"2024-08-01T07:00:21.747Z","updated_at":"2025-06-26T10:03:40.826Z","avatar_url":"https://github.com/leomaurodesenv.png","language":"JavaScript","funding_links":[],"categories":["API"],"sub_categories":[],"readme":"# smm-course-viewer\n\n[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE.md)\n[![npm](https://img.shields.io/badge/Code-npm-yellow.svg)](https://www.npmjs.com/package/smm-course-viewer)\n[![JsClasses](https://img.shields.io/badge/Code-JsClasses-yellow.svg)](https://www.jsclasses.org/smm-course-viewer)\n[![GitHub](https://img.shields.io/badge/Code-GitHub-yellow.svg)](https://github.com/leomaurodesenv/smm-course-viewer)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b7ef61d2da02479fa751d488d4d85fd6)](https://www.codacy.com/app/leomaurodesenv/smm-course-viewer?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=leomaurodesenv/smm-course-viewer\u0026amp;utm_campaign=Badge_Grade)\n\nSimple 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).  \nThis package has two main features: \n1.   `SmmCourseViewer`: Interpret/extract course data from .cdt files.\n2.   `Draw`: Draw the course in a HTML Canvas element.\n\nThe code is developed in Vanilla JS, but with extension to Node.js ([Code Documentation](/lib)).  \nExplore the monsters and objects of your Super Mario Maker courses, see ([Data Format](FORMAT.md)) for more details.   \n   \n---\n## Summary\n\n-   [Code Documentation](/lib)\n-   [Drawing Documentation](/draw)\n-   [Data Format](FORMAT.md)\n-   [Installation](#installation)\n-   [Object Structure](#object-structure)\n\n---\n## Installation\n\n1.  Download or git clone.\n    -   `git clone https://github.com/leomaurodesenv/smm-course-viewer.git`\n\n2.  Download the images `/layout/draw/monster/` and `/layout/draw/titleset/`\n\n3.  Open the `/index.html` in a web browser.\n\n4.  _Load Example_ or _Browse..._ to a \\*.cdt file.\n\nTo use the Node.js:  \n\n```shell\nnpm install --save smm-course-viewer\n```\n\n---\n## Node.js Example\n\nExample: How to read courses files.  \nRun this example `nodejs test/test.js`.  \n\n```js\n/* Include */\nconst smmCourseViewer = require('smm-course-viewer');\n\n// ## Try interpret a course file\nsmmCourseViewer.read('path/course_data.cdt', function(err, course, objects) {\n    if(!err) {\n        console.log(course)\n        console.log(objects);\n    }\n});\n```\n\n---\n## Object Structure\n\nAccessing by a web browser:  \n\n1.  After _Load Example_ or _Browse_ for a file, the object is created.   \n2.  Open the web console, usually `Ctrl+Shift+k` or `F12`, and type `smmCourseViewer`.\n\n```javascript\ncourse: \n  \\_ ​name: string\n  \\_ ​mode: ['M1', 'M3', 'MW', 'WU']\n  \\_ ​timeLimit: number\n  \\_ ​scroll: [0, 1, 2, 3]\n  \\_ ​scrollName: ['none', 'slow', 'medium', 'fast']\n  \\_ ​theme: [0, 1, 2, 3, 4, 5]\n  \\_ ​themeName: ['overworld', 'underground', 'castle', \n                 'airship', 'water', 'ghostHouse']\n  \\_ year: number (creation)\n  \\_ ​month: number (creation)\n  \\_ day: number (creation)\n  \\_ hour: number (creation)\n  \\_ ​minute: number (creation)\n  \\_ ​​width: number\n  \\_ ​​widthBlock: number of blocks\n  \\_ ​heightBlock: number of blocks\n  \\_ ​objectCount: number\n  \\_ checksum: number (file check)\n  \\_ ​version: number\n  \\_ flags: (unknown)\n  \\_ hexMiiData: (unknown)\nobjects:\n  \\_ Array[CourseObject]\n```\n   \n```javascript\nCourseObject:\n  \\_ name: string\n  \\_ x: X-axis\n  \\_ ​y: Y-axis\n  \\_ z: Z-index\n  \\_ height: number\n  \\_ width: number\n  \\_ size: number (only monsters)\n  \\_ ​​wing: boolean (only monsters)\n  \\_ ​​type: number (monster ID)\n  \\_ subType: number (sub ID)\n  \\_ ​​​flags: number (under discovery)\n  \\_ ​​​extendedData: number\n  \\_ effect: number (unknown)\n  \\_ transform: number (unknown)\n  \\_ ​​​childFlags: number (under discovery)\n​​​  \\_ ​​​childTransform: number (unknown)\n  \\_ ​​​childType: number (coupled monster)\n  \\_ linkId: number (coupled monster ~father)\n```\n   \n---\n## Also look ~\n\nAny suggestions or doubts, please open an \"issue\".  \nIf you want to contribute, make a \"pull request\".  \n\n-   [License GPLv3](LICENSE)\n-   Create by Leonardo Mauro ~ [leomaurodesenv](https://github.com/leomaurodesenv/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleomaurodesenv%2Fsmm-course-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleomaurodesenv%2Fsmm-course-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleomaurodesenv%2Fsmm-course-viewer/lists"}