{"id":24822397,"url":"https://github.com/tdecker91/puzzle-gen","last_synced_at":"2025-07-14T06:40:19.643Z","repository":{"id":57141066,"uuid":"285965315","full_name":"tdecker91/puzzle-gen","owner":"tdecker91","description":"Generate Full 3D pictures of WCA twisty puzzles! (Rubiks cube, Pyraminx, Skewb, Megaminx, Square1 image generator)","archived":false,"fork":false,"pushed_at":"2023-08-04T21:22:20.000Z","size":4013,"stargazers_count":38,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-02T02:51:23.780Z","etag":null,"topics":["3d","canvas","image","image-generator","javascript","megaminx","png","pyraminx","rubiks","rubiks-cube","rubiks-cube-simulator","skewb","square-1","svg","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tdecker91.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-08T03:26:27.000Z","updated_at":"2025-06-19T18:13:50.000Z","dependencies_parsed_at":"2025-01-30T18:54:14.703Z","dependency_job_id":"6c0e44cb-3215-4131-9ead-a66734a37734","html_url":"https://github.com/tdecker91/puzzle-gen","commit_stats":null,"previous_names":["tdecker91/puzzle-visualizer"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/tdecker91/puzzle-gen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdecker91%2Fpuzzle-gen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdecker91%2Fpuzzle-gen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdecker91%2Fpuzzle-gen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdecker91%2Fpuzzle-gen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tdecker91","download_url":"https://codeload.github.com/tdecker91/puzzle-gen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdecker91%2Fpuzzle-gen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265253669,"owners_count":23735095,"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":["3d","canvas","image","image-generator","javascript","megaminx","png","pyraminx","rubiks","rubiks-cube","rubiks-cube-simulator","skewb","square-1","svg","typescript"],"created_at":"2025-01-30T18:54:09.242Z","updated_at":"2025-07-14T06:40:19.604Z","avatar_url":"https://github.com/tdecker91.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PuzzleGen\n\nPuzzleGen is a javascript library intended to render [WCA puzzles](https://www.worldcubeassociation.org/regulations/#article-9-events). Colors can be customized, or scrambles can be applied to make references for solve guides or scramble previews. It's heavily inspired by [visualcube](https://github.com/Cride5/visualcube) and [twistysim](http://cube.rider.biz/twistysim.html). My first go at this was porting visuacube to javascript [here](https://github.com/tdecker91/visualcube). But in order to get all the functionality desired, I had to completely rewrite from scratch.\n\nPuzzleGen is built to be customizable, so if desired functionality can be extended to use cases other than embedding scramble previews in web pages.\n\n## Demonstration\n\nCheck out the library in action [HERE](https://tdecker91.github.io/puzzlegen-demo/)\n\n## Docs\n\nSee the [docs](https://tdecker91.github.io/puzzle-gen/) for more information\n\n## Examples\n\nHere are some examples of what the library is capable of.\n\n\u003cp float=\"left\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/cube.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/cube-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/cube-net.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/cube-net-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/cube-top.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/cube-top-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/megaminx.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/megaminx-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/megaminx-net.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/megaminx-net-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/pyraminx.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/pyraminx-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/pyraminx-net.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/pyraminx-net-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/skewb.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/skewb-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/skewb-net.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/skewb-net-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/sq1.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/sq1-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/sq1-net.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/sq1-net-scrm.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/megaminx-top.png\" width=\"125\" /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tdecker91/puzzle-gen/master/assets/megaminx-top-scrm.png\" width=\"125\" /\u003e\n\u003c/p\u003e\n\n## Installation\n\n```bash\n\u003e npm install sr-puzzlegen\n```\n\n## Usage\n\nFor full usage demonsration see [here](https://tdecker91.github.io/puzzle-gen/#/basicusage)\n\n## Development\n\n\u003e Requirements\n\u003e\n\u003e - [Node.js](nodejs.org) - v16.14.0 but other versions may work\n\n\u003e Tools Used\n\u003e\n\u003e - [nvm](https://github.com/nvm-sh/nvm)\n\u003e - [TypeScript](https://www.typescriptlang.org/) - v4.1.3\n\u003e - [WebPack](https://webpack.js.org/) - 5.15.0\n\nInstall dependencies\n\n```bash\n\u003e npm install\n```\n\nRun development demos. This will automatically start a web server and open a browser to the index. For more info see [Demos](src/demos/README.md)\n\n```bash\n\u003e npm run dev\n```\n\nRun tests cases (Yes we have some tests!)\n\n```bash\n\u003e npm t\n```\n\nBuild library. This will save build assets to `dist/`\n\n```bash\n\u003e npm run build # build the bundled library with webpack to /dist/bundle\n\u003e tsc # build unbundled library to /dist/lib\n```\n\nPublish to registry\n\n1. update version in `package.json`\n1. build bundle `npm run build` and build library `tsc`\n1. run npm publish command\n\n```bash\n\u003e npm publish\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftdecker91%2Fpuzzle-gen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftdecker91%2Fpuzzle-gen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftdecker91%2Fpuzzle-gen/lists"}