Metadata-Version: 2.1
Name: storyscript
Version: 0.0.3
Summary: An interpreted programming language.
Home-page: https://github.com/storyscriptorg/StoryScript
Author: lines-of-code
Author-email: admin@susite.ga
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Requires-Dist: Pyinstrument
Requires-Dist: colorama (==0.4.4)
Requires-Dist: numpy (==1.21.1)

# StoryScript

![StoryScript Logo](https://github.com/lines-of-codes/StoryScript/blob/be67a0b872783b78378dc3ac0969fb1111cb3e0f/StoryScript.png)

![Issues](https://img.shields.io/github/issues/lines-of-codes/StoryScript)
![Forks](https://img.shields.io/github/forks/lines-of-codes/StoryScript)
![Stars](https://img.shields.io/github/stars/lines-of-codes/StoryScript)
![License](https://img.shields.io/github/license/lines-of-codes/StoryScript)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=StoryScriptorg_StoryScript&metric=alert_status)](https://sonarcloud.io/dashboard?id=StoryScriptorg_StoryScript)
[![Join the chat at https://gitter.im/StoryScripting/community](https://badges.gitter.im/StoryScripting/community.svg)](https://gitter.im/StoryScripting/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![codecov](https://codecov.io/gh/StoryScriptorg/StoryScript/branch/main/graph/badge.svg?token=BWC521L4X5)](https://codecov.io/gh/StoryScriptorg/StoryScript)
[![Maintainability](https://api.codeclimate.com/v1/badges/808f1a45d594387472eb/maintainability)](https://codeclimate.com/github/StoryScriptorg/StoryScript/maintainability)
[![DeepSource](https://deepsource.io/gh/StoryScriptorg/StoryScript.svg/?label=active+issues&show_trend=true&token=5Ju5wGtlKSj6HZrmU7HnIA72)](https://deepsource.io/gh/StoryScriptorg/StoryScript/?ref=repository-badge)
[![Discord](https://img.shields.io/discord/879964500151914526)](https://discord.gg/2ymyB4n6Ad)

StoryScript is an interpreted programming language that is made to being easy to learn.

## How to install

### Windows way
To install StoryScript, you can just download the zip file in one of the release, and then extract
### If you have other OS
If you don't use Windows, You can just download the `Source code` in one of the release, and run it.

Remember, Before you run it, Make sure to have the required packages installed.

## Download lastest code from main

So, Just download the source code from Main branch. \(And wish there is no bug\)

**And also, You need Python installed**

Due to Pull request #27, You can now easily setup StoryScript by doing:
```bash
python setup.py install
```

Then you can just `python -m storyscript`, Then it will launch the shell, And you can use the language.

And to execute a file, Use `python -m storyscript -i [filename]` and replace `[filename]` with the real File name. For example:

```text
python -m storyscript -i main.sts
```

Note: If you are looking for C Transpiler source, It has been moved [here](https://github.com/StoryScriptorg/StoryScript-CTranspiler/)

### Required Packages
Required packages:
- Numpy
- Colorama

These are required packages for StoryScript, You can setup them manually or install through the setup script.

## How to use the Language

Please visit the [Wiki](https://github.com/lines-of-codes/StoryScript/wiki) for more info about how to use StoryScript.



