{"id":22953053,"url":"https://github.com/devorbitus/vnproofer","last_synced_at":"2025-08-13T01:33:11.759Z","repository":{"id":38185878,"uuid":"365588571","full_name":"devorbitus/vnproofer","owner":"devorbitus","description":"Command-line Visual Novel Proofreading tool","archived":false,"fork":false,"pushed_at":"2023-01-24T21:04:27.000Z","size":705,"stargazers_count":6,"open_issues_count":20,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-08-10T10:55:06.782Z","etag":null,"topics":["command-line","command-line-tool","node","nodejs","proofing-tools","proofreading","renpy","renpy-applications","renpy-visual-novels"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devorbitus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-08T18:48:26.000Z","updated_at":"2024-08-25T05:21:35.000Z","dependencies_parsed_at":"2023-02-14T01:31:24.359Z","dependency_job_id":null,"html_url":"https://github.com/devorbitus/vnproofer","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/devorbitus/vnproofer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devorbitus%2Fvnproofer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devorbitus%2Fvnproofer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devorbitus%2Fvnproofer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devorbitus%2Fvnproofer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devorbitus","download_url":"https://codeload.github.com/devorbitus/vnproofer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devorbitus%2Fvnproofer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270165068,"owners_count":24538426,"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","status":"online","status_checked_at":"2025-08-12T02:00:09.011Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["command-line","command-line-tool","node","nodejs","proofing-tools","proofreading","renpy","renpy-applications","renpy-visual-novels"],"created_at":"2024-12-14T15:52:12.200Z","updated_at":"2025-08-13T01:33:11.400Z","avatar_url":"https://github.com/devorbitus.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VNProofer\nVNProofer is a Command-line Ren'Py Visual Novel proofreading tool.\n\n\u003c!-- TOC --\u003e\n- [Features](#features)\n- [Requirements](#requirements)\n- [Installation](#installation)\n  - [Via NPM](#via-npm)\n    - [Global installation:](#global-installation)\n- [Usage](#usage)\n  - [Help Menu](#help-menu)\n  - [Config](#config)\n    - [Config Command](#config-command)\n    - [Config Help](#config-help)\n      - [Sub Commands](#sub-commands)\n        - [Initial Config](#initial-config)\n        - [Update character exclusions](#update-character-exclusions)\n  - [Check](#check)\n    - [Check Command](#check-command)\n  - [All](#all)\n    - [All Command](#all-command)\n    - [All Help](#all-help)\n  - [Counts](#counts)\n    - [Counts Command](#counts-command)\n    - [Counts Help](#counts-help)\n  - [Exclude](#exclude)\n    - [Exclude Command](#exclude-command)\n    - [Exclude Help](#exclude-help)\n- [Todo](#todo)\n\u003c!-- /TOC --\u003e\n\n## Features\n - Ability to generate a cSpell configuration file for the Ren'Py visual novel\n    - Character names are automatically added to the local dictionary\n - Ability to automatically add newly added characters to the local dictionary\n - Ability to count both words added and dialogue words added today by examining git commit history\n - Ability to add words misspelled on purpose to file level exclusion list\n\n## Requirements\n - A copy of cspell must have been installed globally `npm i cspell -g` to do any spell checking\n - VNProofer is designed to work with a codebase of `*.rpy` files in any directory structure from the root.\n    - `*.rpa` files will need to be decompressed\n    - `*.rpyc` files will need to be decompressed\n\n## Installation\n\n### Via NPM\n\nIt would be best to have Node.js and NPM already installed (or you are willing to do it).\n\n#### Global installation:\n\n```\nnpm i vnproofer cspell -g\n```\n\n## Usage\n\n### Help Menu\n\nUse either `-h` or `--help` at any level\n```\nvnproofer --help\nvnproofer -h\nvnproofer config --help\nvnproofer check --help\nvnproofer all -h\n```\n\n### Config\n\nDisplays the configuration menu\n\n#### Config Command\n```\nvnproofer config\n```\n#### Config Help\n```\n$ vnproofer config --help\nvnproofer config\n\nConfigure vnproofer\n\nOptions:\n  -v, --version         Show version number                                      [boolean]\n  -s, --suppress-intro  Suppress intro of command               [boolean] [default: false]\n  -h, --help            Show help                                                [boolean]\n```\n\n##### Sub Commands\n\n###### Initial Config\n\nCreate an initial cspell.json file from a template (disabled if it already exists). VNProofer will automatically add any defined character names to the workspace dictionary list.\n\n###### Update character exclusions\n\nAdd any new characters to the workspace dictionary list that were not previously added.\n\n### Check\n\nCheck an individual file for spelling errors\n\n#### Check Command\n```\nvnproofer check ./myfile.rpy\n```\nor\n```\nvnproofer c ./myfile.rpy\n```\n\n### All\n\nPerform a complete spell check of all rpy files using cSpell\n\n#### All Command\n```\nvnproofer all\n```\nor\n```\nvnproofer a\n```\n\n#### All Help\n```\n$ vnproofer all --help\nvnproofer all\n\nperform full spell check of all rpy files\n\nOptions:\n  -v, --version         Show version number                                      [boolean]\n  -s, --suppress-intro  Suppress intro of command               [boolean] [default: false]\n  -h, --help            Show help                                                [boolean]\n```\n\n### Counts\n\nQuery git to find out how many words and how many dialogue words have been committed since 1 am today\n\n#### Counts Command\n```\nvnproofer counts\n```\nor\n```\nvnproofer n\n```\n#### Counts Help\n\n```\n$ vnproofer counts --help\nvnproofer counts\n\nQuery git to find out how many words have been committed today\n\nOptions:\n  -v, --version         Show version number                                      [boolean]\n  -s, --suppress-intro  Suppress intro of command               [boolean] [default: false]\n  -m, --only-me         Only show my own counts                 [boolean] [default: false]\n  -b, --verbose         Show detailed logs of changes with word counts for examination\n                                                                [boolean] [default: false]\n  -h, --help            Show help                                                [boolean]\n```\n\n### Exclude\n\nHandle words that are spelled wrong on purpose. If there is already a word exclusion list at the top of the file, the command will add the lowercase version of the word to the existing list in alphabetical order. Otherwise, it will add a new exclusion to the top of the file.\n\n#### Exclude Command\n```\nvnproofer exclude ./myfile.rpy yall\n```\nor\n```\nvnproofer e ./myfile.rpy yall\n```\n#### Exclude Help\n```\n$ vnproofer exclude --help\nvnproofer exclude \u003cfile\u003e \u003cword\u003e\n\nHandle words that are spelled wrong on purpose\n\nPositionals:\n  file  File path that has the misspelled word                         [string] [required]\n  word  Word to exclude from misspelled words within file              [string] [required]\n\nOptions:\n  -v, --version         Show version number                                      [boolean]\n  -s, --suppress-intro  Suppress intro of command               [boolean] [default: false]\n  -h, --help            Show help                                                [boolean]\n```\n\n## Todo\n- [x] Utility to show how many words added as well as how many dialog words have been added today by pulling all changes added to a git repo\n- [ ] Ability to automatically add the [cSpell GitHub action](https://github.com/marketplace/actions/cspell-action) to an existing codebase\n- [x] Ability to add words misspelled on purpose to an exclusion list at the top of the file\n- [ ] Ability to add file-level excluded words to the local dictionary if the exclusion is used in more than one file and remove the local exclusion from all files\n- [ ] Ability to iterate over each misspelled word and choose how to handle it (add to file level exclusion, add to the local dictionary)\n- [ ] Ability to iterate over all-new dialogue (like a new pull request to review)\n- [ ] Ability to view all Ren'Py lint issues\n- [ ] Ability to automatically add [Ren'Py linting GitHub action](https://github.com/marketplace/actions/lint-ren-py-project) to an existing codebase\n- [ ] Ability to run a line of dialogue through a command-line grammatical tool like [gramma](https://caderek.github.io/gramma/)\n- [ ] Ability to install global cSpell installation through config menu if not already installed\n- [ ] Ability to install global gramma installation through config menu if not already installed\n- [ ] Ability to extract from `*.rpa` files\n- [ ] Ability to extract from `*.rpyc` files\n- [ ] Ability to automatically generate a corrections file to be sent to an author to facilitate automatically correcting issues\n- [ ] Ability to automatically add recommended VSCode extensions for Ren'Py\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevorbitus%2Fvnproofer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevorbitus%2Fvnproofer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevorbitus%2Fvnproofer/lists"}