<commit_before># ink

[![Gitter](https://badges.gitter.im/inkle/ink.svg)](https://gitter.im/inkle/ink?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

Ink is [inkle](http://www.inklestudios.com/)'s scripting language for writing interactive narrative, both for text-centric games as well as more graphical games that contain highly branching stories. It's designed to be easy to learn, but with powerful enough features to allow an advanced level of structuring.

 * **inklecate** is the command-line compiler for ink. It takes one or more text files with an `.ink` extension, and produces a `.json` file. It can also be used in *play* mode, for testing a story on the command line.
 * The **ink runtime engine** is a C# library that can be used within Unity or other C# environment.

**Warning:** **ink** is in alpha. Features may change, bugs may be encountered. We're yet to complete a project with this major rewrite of ink - it's a work in progress!


# Getting started

## Writing

Note that you will require basic knowledge of the Mac command line.

 * Install **inklecate** by following the instructions below
 * Create a text file called `myStory.ink`, containing the text `Hello, world!`.
 * On the command line, run: `inklecate2 -p myStory.ink`. The `-p` option uses play mode so that you can see the result immediately.
 * Follow the tutorial: [Writing with Ink](https://github.com/inkle/ink/blob/master/Documentation/ArchitectureAndDevOverview.md).

## Installing *inklecate* - the ink compiler

Pre-requisites:

 * Install [Xamarin](https://xamarin.com/download)
 * Install [Xcode](https://itunes.apple.com/app/xcode/id497799835), and run, make sure it [installs command line tools](http://stackoverflow.com/questions/9329243/xcode-4-4-and-later-install-command-line-tools).

Run the `build_and_install_inklecate2.command` script by double clicking it. This will:

 - Build the latest version of the compiler and install it in `/usr/local/bin/` with the name `inklecate2` so that you can access it from the command line.

 
## Building the runtime DLL (for Unity)

Run the `build-runtime-dll.command` script. This will build a DLL file and place it in `RuntimeDLL/ink-engine.dll`.

# The development of ink

## How to contribute

We’d of course appreciate any bug fixes you might find! Also see the roadmap below for future planned features and optimisations that you might be able to help out with.

[Create a GitHub issue](https://github.com/inkle/ink/issues/new) if you want to start a discussion or request a feature. (Is this the best place for community discussion? We're pretty new to open source!) Or if you want to get in touch with us directly, [email us](mailto:<EMAIL>).

We also have a room on Gitter where you may find someone to help you:

[![Gitter](https://badges.gitter.im/inkle/ink.svg)](https://gitter.im/inkle/ink?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)<commit_msg>Oops, we were referencing the wrong file in the README<commit_after># ink

[![Gitter](https://badges.gitter.im/inkle/ink.svg)](https://gitter.im/inkle/ink?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

Ink is [inkle](http://www.inklestudios.com/)'s scripting language for writing interactive narrative, both for text-centric games as well as more graphical games that contain highly branching stories. It's designed to be easy to learn, but with powerful enough features to allow an advanced level of structuring.

 * **inklecate** is the command-line compiler for ink. It takes one or more text files with an `.ink` extension, and produces a `.json` file. It can also be used in *play* mode, for testing a story on the command line.
 * The **ink runtime engine** is a C# library that can be used within Unity or other C# environment.

**Warning:** **ink** is in alpha. Features may change, bugs may be encountered. We're yet to complete a project with this major rewrite of ink - it's a work in progress!


# Getting started

## Writing

Note that you will require basic knowledge of the Mac command line.

 * Install **inklecate** by following the instructions below
 * Create a text file called `myStory.ink`, containing the text `Hello, world!`.
 * On the command line, run: `inklecate2 -p myStory.ink`. The `-p` option uses play mode so that you can see the result immediately.
 * Follow the tutorial: [Writing with Ink](https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md).

## Installing *inklecate* - the ink compiler

Pre-requisites:

 * Install [Xamarin](https://xamarin.com/download)
 * Install [Xcode](https://itunes.apple.com/app/xcode/id497799835), and run, make sure it [installs command line tools](http://stackoverflow.com/questions/9329243/xcode-4-4-and-later-install-command-line-tools).

Run the `build_and_install_inklecate2.command` script by double clicking it. This will:

 - Build the latest version of the compiler and install it in `/usr/local/bin/` with the name `inklecate2` so that you can access it from the command line.

 
## Building the runtime DLL (for Unity)

Run the `build-runtime-dll.command` script. This will build a DLL file and place it in `RuntimeDLL/ink-engine.dll`.

# The development of ink

## How to contribute

We’d of course appreciate any bug fixes you might find! Also see the roadmap below for future planned features and optimisations that you might be able to help out with.

[Create a GitHub issue](https://github.com/inkle/ink/issues/new) if you want to start a discussion or request a feature. (Is this the best place for community discussion? We're pretty new to open source!) Or if you want to get in touch with us directly, [email us](mailto:<EMAIL>).

We also have a room on Gitter where you may find someone to help you:

[![Gitter](https://badges.gitter.im/inkle/ink.svg)](https://gitter.im/inkle/ink?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
{'fraction_non_alphanumeric': 0.09879272232613501, 'fraction_numerical': 0.007141642577792893, 'mean_word_length': 4.497196261682243, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 16, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6281474', 'n_tokens_mistral': 1770, 'n_tokens_neox': 1678, 'n_words': 736}