-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
10 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |