From 3b7753e5306d343429e50e8f63556d4a85538dcf Mon Sep 17 00:00:00 2001 From: "NGnius (Graham)" Date: Thu, 26 Dec 2019 20:23:11 -0500 Subject: [PATCH] Update README --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 930f89e..62a818c 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,24 @@ Python scripting support for Gamecraft ## Installation -[Follow the official mod installation guide](https://www.exmods.org/guides/install.html) +[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 <-> .NET interfacing](https://ironpython.net/documentation/dotnet) +- [Python <-> Mono/.NET interfacing](https://ironpython.net/documentation/dotnet) - [Python 2.7 docs](https://docs.python.org/2.7) -- [GamecraftModdingAPI .NET library](https://git.exmods/modtainers/GamecraftModdingAPI) \ No newline at end of file +- [GamecraftModdingAPI Mono/.NET library](https://git.exmods/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. \ No newline at end of file