diff --git a/README.md b/README.md index e03aff2..6ccf488 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ [![Discord](https://img.shields.io/discord/911487285990674473?style=for-the-badge)](https://discord.gg/d5dZSfgBZr) [![YouTube Channel](https://img.shields.io/badge/YouTube-Channel-FF0000?style=for-the-badge)](https://www.youtube.com/playlist?list=PLNxQuEFtVkeizoLEQiok7qzr1f0mcwfFb) -CLEO Redux is an experimental JavaScript runtime for GTA 3D era games. +CLEO Redux is an experimental JavaScript runtime for GTA 3D era games and, with limited functionality, [other games or applications](https://re.cleo.li/docs/en/embedding.html). -It brings a joy of enhancing the gameplay with countless mini-scripts that are easy to add and remove. Both players and developers can equally benefit from a flexible and secure environment it provides. +Its flexible, extensible and secure environment provides rich scripting capabilities and allows easily add and remove countless mini-scripts. A complete simple script looks like this: diff --git a/docs/en/config.md b/docs/en/config.md index e5efb40..22e24ba 100644 --- a/docs/en/config.md +++ b/docs/en/config.md @@ -2,9 +2,20 @@ CLEO Redux exposes some of the configurable settings in the file `CLEO\.config\cleo.ini`. +## General + - `AllowCs` - when set to `1` CLEO loads and executes `*.cs` files located in the [CLEO directory](./cleo-directory.md). Enabled by default. - `AllowJs` - when set to `1` CLEO loads and executes `*.js` files located in the [CLEO directory](./cleo-directory.md). Enabled by default. - `AllowFxt` - when set to `1` CLEO loads and [uses](./using-fxt.md) `*.fxt` files located in the CLEO\CLEO_TEXT directory. Enabled by default. - `CheckUpdates` - when set to `1` CLEO check if there is a new update available for download during the game startup. Enabled by default. - `LogOpcodes` - when set to `1` CLEO logs all executed opcodes in custom scripts. This log is part of the `cleo_redux.log` file (see [Log](./log.md)) - `PermissionLevel` - sets the [permission level](./permissions.md) for unsafe operations (see below). Default is `Lax`. + +## Host + +- `EnableSelfHost` - when set to `1` CLEO runs in the self-host mode. Only applicable on an Unknown host. See the [Emdedding](./embedding.md) guide for more information. +- `SelfHostFps` - the amount of iterations per second the CLEO's main loop will do. Only applicable when `EnableSelfHost` is `1`. Default is `30`. + +## Permissions + +This section lists permission tokens and sets whether they are allowed or not in the [Strict mode](./permissions.md#strict). \ No newline at end of file diff --git a/docs/en/embedding.md b/docs/en/embedding.md index d676445..5cb674e 100644 --- a/docs/en/embedding.md +++ b/docs/en/embedding.md @@ -4,6 +4,8 @@ CLEO Redux can be embedded and run JS scripts on an unknown (i.e. not [supported officially](./introduction.md#supported-releases)) host. A *host* is an application in which process `cleo_redux.asi` or `cleo_redux64.asi` gets loaded or injected and where the CLEO runtime runs. This feature is highly experimental and subject to change at any moment. +[See demo on YouTube](https://www.youtube.com/watch?v=rk2LvDt7UkI). + ## Loading into custom process There are multiple ways of loading ASI file into the target process. [Ultimate ASI Loader](https://github.com/ThirteenAG/Ultimate-ASI-Loader/releases) is one of them. The host can load CLEO ASI file as a dynamic library when needed. @@ -63,4 +65,4 @@ fn init() { In the self-hosted mode CLEO Redux supports native [bindings](./js-bindings.md) and commands made with [SDK](./using-sdk.md). It uses command definitions for the Unknown host from Sanny Builder Library (available for [32-bit](https://library.sannybuilder.com/#/unknown_x86) and [64-bit](https://library.sannybuilder.com/#/unknown_x64)). CLEO Redux automatically downloads necessary files during [the first run](./prerequisites.md). -You can use all standard JavaScript features. The list of available commands can be seen in the auto-generated file `.config/unknown_x86.d.ts` or `.config/unknown_x64.d.ts`. \ No newline at end of file +You can use all standard JavaScript features. The list of available commands can be seen in the auto-generated file `.config/unknown.d.ts`. \ No newline at end of file diff --git a/docs/en/using-memory-64.md b/docs/en/using-memory-64.md index f21e9bb..ef670f2 100644 --- a/docs/en/using-memory-64.md +++ b/docs/en/using-memory-64.md @@ -1,4 +1,4 @@ -> This guide is for the remastered games running as 64-bit applications. For the information on using the Memory class in classic era games [click here](./using-memory.md). +> This guide is for x64 hosts (e.g. the remastered trilogy). For the information on using the Memory class on x86 (classic era games) [click here](./using-memory.md). # Memory Object (x64) @@ -132,9 +132,9 @@ Alternatively, use appropriate methods to read/write the value as a float (`Read `Memory` object allows to invoke a foreign (native) function by its address using one of the following methods: -- `Memory.CallFunction` -- `Memory.CallFunctionReturn` -- `Memory.CallFunctionReturnFloat` +- `Memory.CallFunction` - calls a function at the address and discards the returned value +- `Memory.CallFunctionReturn` - calls a function and at the address and returns an integer value +- `Memory.CallFunctionReturnFloat` - calls a function and at the address and returns a floating-point value ```js Memory.CallFunction(0xEFFB30, true, 1, 13) diff --git a/website/index.html b/website/index.html index e28e9fa..69700a9 100644 --- a/website/index.html +++ b/website/index.html @@ -40,10 +40,23 @@ Discord - - + + YouTube + >YouTube

CLEO Redux is an experimental JavaScript runtime for GTA 3D era - games. + games and, with limited functionality, + other games or applications.

- It brings a joy of enhancing the gameplay with countless - mini-scripts that are easy to add and remove. Both players and - developers can equally benefit from a flexible and secure - environment it provides. + Its flexible, extensible and secure environment provides rich + scripting capabilities and allows easily add and remove countless + mini-scripts.