swordio/README.md

A medieval warrior-based programming language

# Swordio

**Swordio** is a 2D esoteric language inspired by [Marbelous](https://github.com/marbelous-lang/docs) and [SpaceChem](http://www.zachtronics.com/spacechem/).

## Introduction

Welcome... to war. You are a member of the Canny Clan, who is being invaded by the Argands, from the complex plane. It is up to you to defend your clans castle.

Now, the Canny Clan isn't just any ordinary clan - it's the smartest clan in the world! And as a result, the leader, Mr Egghead, wants to utilize the war situation in the best way possible - and what better way to do this, than by performing calculations! So, with an almost endless supply of weapons, soldiers, and pirates, you get to do some useful calculations, while also defending your civilizations from the imaginary warriors. Good luck.

## Usage

To learn how to write **Swordio** programs, take a look at the [language documentation](https://github.com/cpdt/swordio/wiki/Language).

> Web based editor/debugger coming soon!

The 'official' **Swordio** interpreter is written in Javascript, and runs on NodeJS - install it with [NPM](https://www.npmjs.com/):

```bash
npm install swordio -g
```

To run code from a file, use the `swordio` command:

```bash
swordio [file]
```

For more information on the command-line interface, including usages, take a look at the [interpreter documentation](https://github.com/cpdt/swordio/wiki/Interpreter).

## Credits

The first version of Swordio, as well as the Javascript interpreter, were created by cpdt.

The language is inspired by a similar esoteric language, [Marbelous](https://github.com/marbelous-lang/marbelous.py) created by cjfaure with the aid of Martin Büttner, Nathan Merrill, overactor, sparr, githubphagocyte, es0124, and Visual Melon.

Swordio is also inspired by the game/simulator [SpaceChem](http://www.zachtronics.com/spacechem/), created by [Zachtronics](http://www.zachtronics.com).

## License

Both Swordio, and the Swordio Javascript interpreter, are licensed under the MIT license, available below.

```
Copyright (c) 2015 cpdt

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```