Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/TheBerkin/rant

(Obsolete) Archive of Rant 3.x.
https://github.com/TheBerkin/rant

Last synced: 3 months ago
JSON representation

(Obsolete) Archive of Rant 3.x.

Awesome Lists containing this project

README

        

# NOTICE: Repository Archived

**As of 26.6.2020, Rant 3 is no longer supported and the repository is archived.**

Check out [Rant 4](https://github.com/rant-lang/rant), a complete redesign and reimplementation of the Rant language!

***
Original readme:


Rant logo



**Rant** is an all-purpose procedural text engine
that is most simply described as the opposite of Regex.
It has been refined to include a dizzying array of features for handling everything from
the most basic of string generation tasks to advanced dialogue generation,
code templating, automatic formatting, and more.

The goal of the project is to enable developers of all kinds
to automate repetitive writing tasks with a high degree of creative freedom.



Build status


Build status




Join us on the official Discord server!

## Features

* Recursive, weighted branching with several selection modes
* Queryable dictionaries
* Automatic capitalization, rhyming, English indefinite articles, and multi-lingual number verbalization
* Print to multiple separate outputs
* Probability modifiers for pattern elements
* Loops, conditional statements, and subroutines
* Fully-functional object model
* Import/Export resources easily with the .rantpkg format
* Compatible with Unity 2017
* *And much, much, much more...*

## Examples

**Liven up a narrative with a few simple queries.**
```
likes to with pet on .
```
```
Alick likes to mount shuttlecocks with his pet bat on Mondays.
```

---

**Count to ten and spell it out.**
```
[case:sentence][numfmt:verbal][rs:10;\s]{[rn].}
```
```
One. Two. Three. Four. Five. Six. Seven. Eight. Nine. Ten.
```

---

**Write a poem**
```
[rhyme:perfect]
The the .
```
```
The bread fed the red head.
```
```
The drug dug the smug plug.
```

---

## NuGet
Rant is also available as a [NuGet package](https://www.nuget.org/packages/Rant/).
Enter this command in your package manager,
and the latest version of Rant will automagically get installed in your project:

```
PM> Install-Package Rant
```

Or if development builds are your thing:

```
PM> Install-Package Rant -Pre
```

## License
Rant is provided under [The MIT License](https://github.com/TheBerkin/Rant/blob/master/LICENSE).

## Improve Rant
If there is something you want fixed, added, or changed, feel free to submit an issue/pull request; I will try to get back to you within a day. If you would like to translate Rant into your native language, simply write a .lang file for it [like this one here](https://github.com/TheBerkin/rant/blob/master/Rant/Localization/en-US.lang).

See [CONTRIBUTING.md](CONTRIBUTING.md) for a full guide on how you can help.

## Rant Resources

* [Rant Homepage](http://berkin.me/rant)
* [Rant Documentation](http://berkin.me/rant/docs)
* [Rant Demos](https://github.com/TheBerkin/Rant.Demos)
* [Rant Standard Dictionary](https://github.com/TheBerkin/Rantionary)
* [Online Pattern Tester](http://lett.at/rantbox/)