Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
jac3km4 committed Mar 15, 2022
1 parent 20266d7 commit f2f20c8
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
<img width="1021" alt="demo" src="https://user-images.githubusercontent.com/11986158/158067765-d34a774c-ac64-4456-85d3-ddb350113e84.png">


### installation
Extract the release archive in the main game directory (the one with a `system` dir inside).

0 comments on commit f2f20c8

Please sign in to comment.