Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/coyote-31/language-eu4mod

📦 Atom language package for ⚜ Europa Universalis IV ⚜
https://github.com/coyote-31/language-eu4mod

atom atom-grammar atom-language atom-package atom-syntax eu4 europa-universalis-4 europa-universalis-iv grammar paradox-interactive

Last synced: 20 days ago
JSON representation

📦 Atom language package for ⚜ Europa Universalis IV ⚜

Host: GitHub
URL: https://github.com/coyote-31/language-eu4mod
Owner: Coyote-31
License: mit
Created: 2020-02-28T21:56:41.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2020-12-16T23:03:55.000Z (about 4 years ago)
Last Synced: 2024-10-16T08:21:41.476Z (2 months ago)
Topics: atom, atom-grammar, atom-language, atom-package, atom-syntax, eu4, europa-universalis-4, europa-universalis-iv, grammar, paradox-interactive
Homepage: https://atom.io/packages/language-eu4mod
Size: 152 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # **`language-eu4mod`**

[![APM](https://img.shields.io/apm/v/language-eu4mod?color=%23147dce&logo=atom&logoColor=%2380f2a6)](https://atom.io/packages/language-eu4mod) [![Travis (.com)](https://img.shields.io/travis/com/Coyote-31/language-eu4mod?label=Atom%20CI&logo=Travis)](https://travis-ci.com/github/Coyote-31/language-eu4mod) [![GitHub](https://img.shields.io/github/license/Coyote-31/language-eu4mod?color=%230f1014)](https://github.com/Coyote-31/language-eu4mod/blob/master/LICENSE)

📦 [**`language-eu4mod`**](https://atom.io/packages/language-eu4mod) is a global **[tree-sitter](http://tree-sitter.github.io/tree-sitter/)** grammar for **Europa Universalis IV**.

## 📄 Description

This package is a **global EU4 grammar** powered by **[tree-sitter](http://tree-sitter.github.io/tree-sitter/)** and developed for the **[⚛️Atom](https://atom.io)** text editor.  

It supports the various languages, from extensions listed below, found in EU4 files. As this grammar is focused on developers working on EU4 mods it provides a *syntax-tree* with *scope mappings* able to handle any language used in files inside EU4 directory. Mainly for modding purposes.

### How to install :

To install [`language-eu4mod`](https://atom.io/packages/language-eu4mod) it's like any other [Atom's package](https://flight-manual.atom.io/using-atom/sections/atom-packages/) :

- Simply in the Atom's settings : `settings > install`.

- From [atom.io](https://atom.io/packages/) registry : [`language-eu4mod`](https://atom.io/packages/language-eu4mod)

- via CLI  :

        apm install language-eu4mod

### Which EU4 file extension is managed :

Extension | Supported

:---:    |   :---:

.mod    |    ✅

.gfx    |    ✅

.gui    |    ✅

.yml    |    ✅

## 📚 Documentation

### How it works :

This package enable Atom's themes with syntax highlighting to catch syntax nodes by specifying scope mappings in a grammar definition file.  

In Atom syntax highlighting is define with `css` class. And this package map the syntax nodes to theses class fallowing grammar `.cson` files directives. But the structure of theses tree-syntax nodes is define in the parser which is in the dependency package : **[`tree-sitter-eu4mod`](https://github.com/Coyote-31/tree-sitter-eu4mod#readme)**

### Repository & Releases :

Link | Info

:---:     |   :---:

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

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

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

## 🐛 Issues or bugs

If you have any issue or find a bug please :

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

:---:     |   :---:

## 🔍 See also

> - **[Creating a grammar](https://flight-manual.atom.io/hacking-atom/sections/creating-a-grammar/)** (Atom flight manual)

> - **[Tree Sitter](https://tree-sitter.github.io/tree-sitter/)** (Docs)

> - **[`tree-sitter-eu4mod`](https://github.com/Coyote-31/tree-sitter-eu4mod#readme)**  (Parser)

- **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

> **[The MIT License (MIT)](https://github.com/Coyote-31/language-eu4mod/blob/master/LICENSE)**