https://github.com/renpy/language-renpy
:bookmark_tabs: :electric_plug: Ren'Py package for Atom and Linguist Grammars
https://github.com/renpy/language-renpy
grammars python ren-py renpy visual-novel
Last synced: 6 months ago
JSON representation
:bookmark_tabs: :electric_plug: Ren'Py package for Atom and Linguist Grammars
- Host: GitHub
- URL: https://github.com/renpy/language-renpy
- Owner: renpy
- License: other
- Created: 2015-02-07T02:35:37.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-06-05T03:36:31.000Z (over 3 years ago)
- Last Synced: 2025-03-26T15:21:20.348Z (6 months ago)
- Topics: grammars, python, ren-py, renpy, visual-novel
- Language: Python
- Homepage: https://atom.io/packages/language-renpy
- Size: 413 KB
- Stars: 50
- Watchers: 6
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Ren'Py language support in Atom
[](https://travis-ci.org/renpy/language-renpy)
Adds syntax highlighting and snippets to Ren'Py files in Atom. It also adds syntax
highlighting to GitHub files, markdown code blocks and GitHub Gist
([more info here](https://gist.github.com/williamd1k0/3b231c42e4a3efdd9759)).
Originally converted from the [Python package for Atom](https://github.com/atom/language-python).
Syntax highlighting test: [`GitHub Lightshow`](https://github-lightshow.herokuapp.com/?utf8=%E2%9C%93&scope=from-url&grammar_format=cson&grammar_url=https%3A%2F%2Fgithub.com%2Frenpy%2Flanguage-renpy%2Fblob%2Fmaster%2Fgrammars%2Frenpy.cson&grammar_text=&code_source=from-url&code_url=https%3A%2F%2Fgithub.com%2Frenpy%2Flanguage-renpy%2Fblob%2Fmaster%2Fexample.rpy)
Contributions are greatly appreciated. Please fork this repository and open a
pull request to add snippets, make grammar tweaks, etc.
* The highlight may vary depending on the syntax theme used.
* Default suggested syntax theme: [`Ren'Py Dark`](https://atom.io/themes/renpy-dark-syntax).
* Alternative suggested syntax theme:
* [`Atom Dark`](https://atom.io/themes/atom-dark-syntax).
* [`Monokai`](https://atom.io/themes/monokai).
* [`octocat-syntax`](https://atom.io/themes/octocat-syntax)
* Other recommended packages:
* [`file-icons`](https://atom.io/packages/file-icons) - Just for file icons style
* [`pigments`](https://atom.io/packages/pigments) - Display colors in project (Hex, RGB etc)
* [`color-picker`](https://atom.io/packages/color-picker) - Color picker (Hex, RGB etc)
* [`minimap`](https://atom.io/packages/minimap) - Code minimap
>Ren'Py is a Visual Novel development tool, available from [www.renpy.org](http://www.renpy.org/)
>Thanks to [Koroshiya](https://github.com/koroshiya) (Sublime-Renpy).
## Getting Started
### Installation
When using Ren'Py 6.99.14.2 or higher, go to preferences and select Atom as your text editor.
With [Atom](https://atom.io/) already installed, open the Settings tab: `File`>`Settings` (or with Ctrl+,)
Click in + Install and search for `renpy` then click in Install button of the package `language-renpy`.
It's also possible installing using the cli command `apm` (atom package manager):
```sh
apm install language-renpy
```
### Usage
Open a `.rpy` file or create a new one and test the syntax highlighting of the Ren'Py. You can also use the [example file](example.rpy) available on the package repository.
## Snippets:
Snippets are pieces of code like in the following example.
The usage is done with keywords followed by a Tab to insert the snippet.
For example, there's a snippet with useful links, type `dochelp` and press Tab or Enter.
You can check the snippets list while editing a `.rpy` file, just open the Command Palette (Ctrl/Cmd+Shift+P) and search for **Snippets: Available** or go to the package settings (`Settings`>`Packages`>`language-renpy`>`Snippets`).
Snippets are added by need, so suggestions are welcome.