https://github.com/damourchris/pcg-grammar-formatter

PCG Grammar Formatter for VS Code

https://github.com/damourchris/pcg-grammar-formatter

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary

Keywords

pcg pcg-grammar unreal-engine vscode-extension
Last synced: 5 months ago · JSON representation

Repository

PCG Grammar Formatter for VS Code

Basic Info
  • Host: GitHub
  • Owner: damourChris
  • License: other
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 110 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Topics
pcg pcg-grammar unreal-engine vscode-extension
Created 9 months ago · Last pushed 9 months ago
Metadata Files
Readme Changelog

README.md

PCG Grammar Formatter

Description

PCG Grammar is a domain-specific language (DSL) for defining grammars available in Unreal Engine 5.

These grammars are used to generate procedural content, such as levels, assets, and other game elements. As these grammars can become complex and difficult to read, the PCG Grammar Formatter extension for Visual Studio Code provides a way to format and beautify these grammars, making them easier to understand and work with.

Features

  • Format PCG Grammar: The extension provides a command to format PCG Grammar, making them more readable and consistent.
  • Syntax Highlighting: Syntax highlighting for PCG Grammar, providing visual cues for different modules.
  • Code Snippets: Code snippets for common PCG Grammar constructs
  • Error Checking: Error checking for PCG Grammar files,finding uncomplete or incorrect grammar definitions.

Futures Features

  • [ ] Unreal Engine Integration: Integration with Unreal Engine to provide real-time feedback and validation of PCG Grammar files.

Requirements

  • Visual Studio Code version 1.0.0 or higher
  • Unreal Engine 5.0 or higher

Extension Settings

  • pcgGrammarFormatter.enable: Enable or disable the extension.
  • pcgGrammarFormatter.formatOnSave: Enable or disable formatting on save.
  • pcgGrammarFormatter.indentSize: Set the number of spaces to use for indentation.
  • pcgGrammarFormatter.useTabs: Use tabs instead of spaces for indentation.
  • pcgGrammarFormatter.insertNewLineBeforeBrackets: Insert a newline before opening brackets.
  • pcgGrammarFormatter.insertNewLineAfterBrackets: Insert a newline after closing brackets.
  • pcgGrammarFormatter.insertFinalNewline: Insert a final newline at the end of the file.
  • pcgGrammarFormatter.trimTrailingWhitespace: Trim trailing whitespace on each line.

Known Issues

  • The extension is still in development and may have bugs or incomplete features. If you encounter any issues, please report them on the GitHub repository.

Release Notes

Full changelog is available here.

Extra Information

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! If you have suggestions for improvements or new features, please open an issue or submit a pull request on the GitHub repository

This project (tries to) follows the conventional commits specifications https://www.conventionalcommits.org/en/v1.0.0/

PCG Grammar Resources

GitHub Events

Total
  • Watch event: 1
  • Push event: 1
Last Year
  • Watch event: 1
  • Push event: 1

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 27
  • Total Committers: 1
  • Avg Commits per committer: 27.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 27
  • Committers: 1
  • Avg Commits per committer: 27.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Christopher 1****s 27

Packages

  • Total packages: 1
  • Total downloads:
    • npm 6 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
npmjs.org: pcg-grammar-formatter

Formatter to pretty print PCG Grammars

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 6 Last month
Rankings
Dependent repos count: 24.6%
Average: 30.1%
Dependent packages count: 35.5%
Maintainers (1)
Last synced: 6 months ago

Dependencies

package.json npm
  • @release-it/conventional-changelog ^10.0.1 development
  • @types/mocha ^10.0.10 development
  • @types/node 20.x development
  • @types/vscode ^1.100.0 development
  • @typescript-eslint/eslint-plugin ^8.31.1 development
  • @typescript-eslint/parser ^8.31.1 development
  • @vscode/test-cli ^0.0.10 development
  • @vscode/test-electron ^2.5.2 development
  • esbuild ^0.25.3 development
  • eslint ^9.25.1 development
  • npm-run-all ^4.1.5 development
  • release-it ^19.0.2 development
  • typescript ^5.8.3 development
pnpm-lock.yaml npm
  • 104 dependencies