From f2f20c83f352c747df342d7c27bf72e0b3a7ba12 Mon Sep 17 00:00:00 2001 From: jekky <11986158+jac3km4@users.noreply.github.com> Date: Tue, 15 Mar 2022 22:44:38 +0000 Subject: [PATCH] Readme update --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4e031cb..d2d0ad9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ ## C.R.O.N.Y GUI -Small WIP script hook/extender for Elex 2 +Small WIP scripting framework for Elex 2 -### how it works -This library uses [Rhai](https://rhai.rs) as the scripting language. -A script console can be toggled with the Home key. -You can find available game functions [here](https://github.com/jac3km4/crony-gui/tree/master/doc/FUNCTIONS.md). +### synopsis +This project provides a way to extend Elex 2 with custom scripts. +It exposes a [library of functions](https://github.com/jac3km4/crony-gui/tree/master/doc/FUNCTIONS.md) that can be used to various things in the game (looting containers, adding followers etc). +The scripting runtime is backed by a programming language called [Rhai](https://rhai.rs). +There's also graphical console available, it can be toggled with the Home key and used to run scripts while you're playing. ### demo demo + + +### installation +Extract the release archive in the main game directory (the one with a `system` dir inside).