Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coyote-31/tree-sitter-eu4mod

📦 Tree sitter parser package for ⚜ Europa Universalis IV ⚜
https://github.com/coyote-31/tree-sitter-eu4mod

eu4 europa-universalis-4 europa-universalis-iv paradox-interactive tree-sitter

Last synced: 3 months ago
JSON representation

📦 Tree sitter parser package for ⚜ Europa Universalis IV ⚜

Host: GitHub
URL: https://github.com/coyote-31/tree-sitter-eu4mod
Owner: Coyote-31
License: mit
Created: 2020-02-28T09:49:09.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-07-03T09:02:58.000Z (over 1 year ago)
Last Synced: 2024-10-14T13:36:58.585Z (3 months ago)
Topics: eu4, europa-universalis-4, europa-universalis-iv, paradox-interactive, tree-sitter
Language: C
Homepage: https://www.npmjs.com/package/tree-sitter-eu4mod
Size: 2.52 MB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # **`tree-sitter-eu4mod`**

[![npm](https://img.shields.io/npm/v/tree-sitter-eu4mod?color=%23147dce&logo=npm)](https://www.npmjs.com/package/tree-sitter-eu4mod) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Coyote-31/tree-sitter-eu4mod/Node.js%20CI?label=Node.js%20CI&logo=github)](https://github.com/Coyote-31/tree-sitter-eu4mod/actions?query=workflow%3A%22Node.js+CI%22) [![GitHub](https://img.shields.io/github/license/Coyote-31/tree-sitter-eu4mod?color=%230f1014)](https://github.com/Coyote-31/tree-sitter-eu4mod/blob/master/LICENSE)

📦 `tree-sitter-eu4mod` is a global grammar parser for **Europa Universalis IV**.

## 📄 Description

This package is a global **grammar parser** for **EU4** files. Focusing on developers working on EU4 mods and providing them a grammar parser able to handle any extension's file listed below in EU4 directory for modding purpose.

### How to install :

To install this package from the [npmjs repository](https://www.npmjs.com/package/tree-sitter-eu4mod) via CLI :

    npm install tree-sitter-eu4mod

### Which EU4 file extension is managed :

Extension | Supported

:---:   |   :---:

.mod    |    ✅

.gfx    |    ✅

.gui    |    ✅

.yml    |    ✅

### Which text editor use this package :

- **[⚛ Atom](https://atom.io)** : With the package [`language-eu4mod`](https://atom.io/packages/language-eu4mod) on [atom.io](https://atom.io/packages/) registry.

## 📚 Documentation

### How it works :

The parser is build with a generator tool from the dependency package [`tree-sitter`](https://github.com/tree-sitter/tree-sitter). The grammar is define with a *Javascript* file named `grammar.js` then [`tree-sitter`](https://github.com/tree-sitter/tree-sitter) generate *C* libraries as parsers. And theses parsers can be used in other applications supporting [context-free grammars](https://en.wikipedia.org/wiki/Context-free_grammar) (eg. [⚛ Atom](https://atom.io)) for the syntax highlighting of eu4 modding files.

### Source archive :

Link | Info

:---:     |   :---:

**[GitHub repository](https://github.com/Coyote-31/tree-sitter-eu4mod)** | [![GitHub commits](https://badgen.net/github/commits/Coyote-31/tree-sitter-eu4mod?icon=git&label=total%20commits)](https://github.com/Coyote-31/tree-sitter-eu4mod/commits/master)

**[Last release](https://github.com/Coyote-31/tree-sitter-eu4mod/releases/latest)** | [![GitHub tag (latest by date)](https://badgen.net/github/tag/Coyote-31/tree-sitter-eu4mod?icon=atom&label=last%20release)](https://github.com/Coyote-31/tree-sitter-eu4mod/releases/latest)

**[All releases](https://github.com/Coyote-31/tree-sitter-eu4mod/releases)** | [![total releases](https://badgen.net/github/tags/Coyote-31/tree-sitter-eu4mod?icon=npm&label=total%20releases)](https://github.com/Coyote-31/tree-sitter-eu4mod/releases)

## 🐛 Any issue or bug **[report here](https://github.com/Coyote-31/tree-sitter-eu4mod/issues)**

If you have any issue or find a bug please :

- **[Open an issue on GitHub](https://github.com/Coyote-31/tree-sitter-eu4mod/issues)** : ![GitHub issues](https://img.shields.io/github/issues/Coyote-31/tree-sitter-eu4mod?logo=github)

## 🔍 See also

- **[Tree Sitter](https://tree-sitter.github.io/tree-sitter/)** (documentation web site)

- **[language-eu4mod](https://github.com/Coyote-31/language-eu4mod#README.md)**  (GitHub)

- **EU4 definition** :

  - **[GUI/GFX Xyloz](https://eu4.paradoxwikis.com/User:Xyloz/sandbox)** (eu4.paradoxwikis)

  - **[Interface modding](https://eu4.paradoxwikis.com/Interface_modding)**  (eu4.paradoxwikis)

  - **[Graphical asset modding](https://eu4.paradoxwikis.com/Graphical_asset_modding)**  (eu4.paradoxwikis)

## ©️ License

**[MIT](https://github.com/Coyote-31/tree-sitter-eu4mod/blob/master/LICENSE)**