{"id":19044116,"url":"https://github.com/performanc/perforvnmaker","last_synced_at":"2025-08-18T03:33:44.897Z","repository":{"id":184105532,"uuid":"671299989","full_name":"PerformanC/PerforVNMaker","owner":"PerformanC","description":"NodeJS Visual Novel Maker by code generation technology.","archived":false,"fork":false,"pushed_at":"2024-09-23T03:13:00.000Z","size":2646,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T12:46:14.287Z","etag":null,"topics":["android","app-engine","code-generator","cross-platform","hacktoberfest","kotlin","nodejs","visual-novel","visual-novel-engine"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PerformanC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-27T02:31:45.000Z","updated_at":"2024-10-22T21:19:25.000Z","dependencies_parsed_at":"2023-07-27T04:47:26.012Z","dependency_job_id":"32d64323-cf76-4b09-bbb5-51268916262a","html_url":"https://github.com/PerformanC/PerforVNMaker","commit_stats":null,"previous_names":["performanc/perforvnmaker"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerformanC%2FPerforVNMaker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerformanC%2FPerforVNMaker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerformanC%2FPerforVNMaker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerformanC%2FPerforVNMaker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PerformanC","download_url":"https://codeload.github.com/PerformanC/PerforVNMaker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250530893,"owners_count":21445883,"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":["android","app-engine","code-generator","cross-platform","hacktoberfest","kotlin","nodejs","visual-novel","visual-novel-engine"],"created_at":"2024-11-08T22:44:52.437Z","updated_at":"2025-04-23T23:27:14.943Z","avatar_url":"https://github.com/PerformanC.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PerforVNMaker\n\n[![Discord Server](https://img.shields.io/discord/1036045973039890522?color=5865F2\u0026logo=discord\u0026logoColor=white)](https://discord.gg/uPveNfTuCJ) [![Package size](https://packagephobia.now.sh/badge?p=@performanc/perforvnmaker)](https://packagephobia.now.sh/result?p=@performanc/perforvnmaker)\n\nVisual Novels by optimized code generation technology.\n\n## About\n\nPerforVNM (PerforVNMaker) is a Visual Novel Maker, which uses code generation technology to create VNs based on JavaScript APIs, allowing the creation of lightweight and fast VNs. It generates native code for each supported platform, without any external dependencies (save sdp, ssp).\n\n## Project status\n\nThe current stage of PerforVNM is WIP (Work In Progress), since it's still limited to the Android System. Although it's stable, it's not recommended to use it in production.\n\nThe current features can be found in [OS_SUPPORT.md](OS_SUPPORT.md) file, which also contains the current supported OSes.\n\n## Usage\n\n### Minimum requirements\n\n- NodeJS: `v13`\n- Android: `4.0`\n\n### Installation\n\nTo install PerforVNM, you can use `npm`, `yarn`, `pnpm` or `bun` to install the `@performanc/perforvnmaker` package.\n\n### API\n\nThe documentation for the JavaScript API can be found in the [docs](docs/) folder, for most questions, the [test file](tests/vn.js) can be used as an example.\n\n### Code generation\n\nPerfor's ability to generate code, which makes it a code generator, allows it to create the best code possible, even compared to hand-made VNs codes.\n\nAfter creating the VN JavaScript file, you simply needs to run it with either `NodeJs` or `Bun`, and it will generate the code for you in the selected output Android folder.\n\n## Advantages over engines\n\nThe main advantage of PerforVNM is that it's a code generator, but the advantages over engines are not very known, so here's a list of the advantages of Perfor over engines:\n\n### Resource usage\n\nThe biggest advantage of PerforVNMaker is that it can create VNs with a very low resource usage, for reference, the [test VN](tests/vn.js) created an APK of 1.8MB, while the same VN created with Ren'Py created an APK of 40MB~.\n\n### Portability\n\nDue to the code generation technology, PerforVNM can be ported to any OS, and it's not limited to Android, as of now, it's only available on Android, but we're working on porting it to other OSes.\n\nBut it's supported in Android 4.0+, launched in 2011, while Ren'Py is only supported in Android 5+, launched in 2014. Although the difference is small, Android 5 devices can suffer with resource usage, so it will be a problem.\n\n### Technology improvement\n\nOn the modern society, technology is everywhere, and it's a necessity to improve it, and to make it more accessible, and that's what we do.\n\nPerfor uses the most modern technology available, and we're always improving it, bringing art to technology, and technology to art, and both to the people.\n\n## Goals\n\nAny change with a good support can make huge a difference, more optimized apps, games, can make a huge impact on the environment, with less energy consumption, less resources needed, and less powerful devices needed.\n\nIt's important to make technology more accessible, and to make it more optimized, and that's what we do, bring VNs to even the oldest devices available, with the most minimum hardware requirements possible.\n\nThe PerformanC Organization Team is focused on making the world a livable place, so that younger generations can live in a better world, with technology on their side.\n\n## Discord Server \u0026 Feedback\n\nFeel free to join [our Discord server](https://discord.gg/uPveNfTuCJ) to talk with the team, and community, and to give us feedback. We would also love to talk with you, don't be shy.\n\n## License\n\nPerforVNM is licensed under PerformanC's License, which is a modified version of the MIT License, focusing on the protection of the source code and the rights of the PerformanC team over the source code.\n\nIf you wish to use some part of the source code, you must contact us first, and if we agree, you can use the source code, but you must give us credit for the source code you use.\n\nOBS: The generated code is not affected by the license above unless taken to be used for another code generator, transpiler or engine.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperformanc%2Fperforvnmaker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperformanc%2Fperforvnmaker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperformanc%2Fperforvnmaker/lists"}