-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit updates the README to make it compliant to PerformanC Organization standards.
- Loading branch information
Showing
1 changed file
with
33 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,58 @@ | ||
| # PerforVNMaker | ||
| # PerforVNM | ||
|
|
||
| [](https://discord.gg/uPveNfTuCJ) [](https://packagephobia.now.sh/result?p=@performanc/perforvnmaker) | ||
| VN (Visual Novel) maker by highly optimized code generation technology. | ||
|
|
||
| Visual Novels by optimized code generation technology. | ||
| ## Features | ||
|
|
||
| ## About | ||
| - Extremely lightweight | ||
| - Fastest VN maker | ||
| - No external dependencies | ||
| - Highly fast VNs | ||
|
|
||
| PerforVNM (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). | ||
| ## Dependencies | ||
|
|
||
| ## Project status | ||
| - NodeJS: `v13`+ | ||
| - Android: `4`+ | ||
|
|
||
| The 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. | ||
| > [!NOTE] | ||
| > Node.js is only required for development, and the generated code doesn't require it. | ||
| The current features can be found in [OS_SUPPORT.md](OS_SUPPORT.md) file, which also contains the current supported OSes. | ||
| ## Installation | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Minimum requirements | ||
|
|
||
| - NodeJS: `v13` | ||
| - Android: `4.0` | ||
|
|
||
| ### Installation | ||
|
|
||
| To install PerforVNM, you can use `npm`, `yarn`, `pnpm` or `bun` to install the `@performanc/perforvnmaker` package. | ||
|
|
||
| ### API | ||
|
|
||
| The 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. | ||
|
|
||
| ### Code generation | ||
| ### 1. Install PerforVNM via npm | ||
|
|
||
| Perfor'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. | ||
| \`\`\`shell | ||
| $ npm install @performanc/perforvnmaker | ||
| \`\`\` | ||
|
|
||
| After 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. | ||
| ### 2. Install PerforVNM via GitHub | ||
|
|
||
| ## Advantages over engines | ||
| \`\`\`shell | ||
| $ npm install GitHub:PerformanC/PerforVNM | ||
| \`\`\` | ||
|
|
||
| The 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: | ||
|
|
||
| ### Resource usage | ||
|
|
||
| The 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~. | ||
|
|
||
| ### Portability | ||
|
|
||
| Due 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. | ||
|
|
||
| But 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. | ||
| ## Usage | ||
|
|
||
| ### Technology improvement | ||
| A extremely [detailed example](tests/vn.js) is available inside tests folder. This should cover all the features of PerforVNM. | ||
|
|
||
| On 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. | ||
| ## Documentation | ||
|
|
||
| Perfor 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. | ||
| Hand-written documentation is available in the [docs](docs/) folder. It's recommended to read it before starting to use PerforVNM. | ||
|
|
||
| ## Goals | ||
| ## Support | ||
|
|
||
| Any 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. | ||
| Any question related to PerforVNM or other PerformanC projects can be made in [PerformanC's Discord server](https://discord.gg/uPveNfTuCJ). | ||
|
|
||
| It'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. | ||
| ## Contribution | ||
|
|
||
| The 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. | ||
| It is mandatory to follow the PerformanC's [contribution guidelines](https://github.com/PerformanC/contributing) to contribute to PerforVNM. Following its Security Policy, Code of Conduct and syntax standard. | ||
|
|
||
| ## Discord Server & Feedback | ||
| ## Projects using PerforVNM | ||
|
|
||
| Feel 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. | ||
| Not any project (known) uses PerforVNM, but if you're using it, feel free to open a PR to add your project here. | ||
|
|
||
| ## License | ||
|
|
||
| PerforVNM is licensed under [BSD 2-Clause License](LICENSE). You can read more about it on [Open Source Initiative](https://opensource.org/licenses/BSD-2-Clause). | ||
|
|
||
| * This project is considered as: [semi-standard compliant](https://github.com/PerformanC/contributing?tab=readme-ov-file#project-information). |