GamecraftScripting/README.md

# GamecraftScripting

Python scripting support for Gamecraft

## Installation
[Please follow the official mod installation guide](https://www.exmods.org/guides/install.html)

*IMPORTANT* Extract the zip file in the main Gamecraft directory, *NOT* the Plugins directory.
Also, please install the [GamecraftModdingAPI](https://git.exmods.org/modtainers/GamecraftModdingAPI), otherwise the GamecraftScripting mod will not work.

## Script Development
GamecraftScripting uses IronPython to run Python 2.7 scripts in the Mono/.NET runtime.
To get started with Python 2.7 on Mono, check out the resources below.

Resources
- [Python <-> Mono/.NET interfacing](https://ironpython.net/documentation/dotnet)
- [Python 2.7 docs](https://docs.python.org/2.7)
- [GamecraftModdingAPI Mono/.NET library](https://git.exmods.org/modtainers/GamecraftModdingAPI)

## External Libraries
GamecraftScripting uses the [GamecraftModdingAPI](https://git.exmods.org/modtainers/GamecraftModdingAPI) to modify the behaviour of existing Gamecraft code.
[IronPython](https://github.com/IronLanguages/ironpython2) is used to run Python code in the Mono runtime.

# Disclaimer
This API is an unofficial modification of Gamecraft software, and is not endorsed or supported by FreeJam or Gamecraft.
The GamecraftModdingAPI developer(s) claim no rights on the Gamecraft code referenced within this project.