Skip to content

Commit

Permalink
update to 0.9.3-dev
Browse files Browse the repository at this point in the history
  • Loading branch information
x87 committed Apr 14, 2022
1 parent d6ef1a8 commit 59cc45a
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 15 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
11 changes: 11 additions & 0 deletions docs/en/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 3 additions & 1 deletion docs/en/embedding.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`.
You can use all standard JavaScript features. The list of available commands can be seen in the auto-generated file `.config/unknown.d.ts`.
8 changes: 4 additions & 4 deletions docs/en/using-memory-64.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down Expand Up @@ -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)
Expand Down
31 changes: 23 additions & 8 deletions website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,23 @@
</svg> </span
><a href="https://discord.gg/d5dZSfgBZr" class="mr-3">Discord</a>
<span>
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-youtube" viewBox="0 0 16 16">
<path d="M8.051 1.999h.089c.822.003 4.987.033 6.11.335a2.01 2.01 0 0 1 1.415 1.42c.101.38.172.883.22 1.402l.01.104.022.26.008.104c.065.914.073 1.77.074 1.957v.075c-.001.194-.01 1.108-.082 2.06l-.008.105-.009.104c-.05.572-.124 1.14-.235 1.558a2.007 2.007 0 0 1-1.415 1.42c-1.16.312-5.569.334-6.18.335h-.142c-.309 0-1.587-.006-2.927-.052l-.17-.006-.087-.004-.171-.007-.171-.007c-1.11-.049-2.167-.128-2.654-.26a2.007 2.007 0 0 1-1.415-1.419c-.111-.417-.185-.986-.235-1.558L.09 9.82l-.008-.104A31.4 31.4 0 0 1 0 7.68v-.123c.002-.215.01-.958.064-1.778l.007-.103.003-.052.008-.104.022-.26.01-.104c.048-.519.119-1.023.22-1.402a2.007 2.007 0 0 1 1.415-1.42c.487-.13 1.544-.21 2.654-.26l.17-.007.172-.006.086-.003.171-.007A99.788 99.788 0 0 1 7.858 2h.193zM6.4 5.209v4.818l4.157-2.408L6.4 5.209z"/>
<svg
xmlns="http://www.w3.org/2000/svg"
width="16"
height="16"
fill="currentColor"
class="bi bi-youtube"
viewBox="0 0 16 16"
>
<path
d="M8.051 1.999h.089c.822.003 4.987.033 6.11.335a2.01 2.01 0 0 1 1.415 1.42c.101.38.172.883.22 1.402l.01.104.022.26.008.104c.065.914.073 1.77.074 1.957v.075c-.001.194-.01 1.108-.082 2.06l-.008.105-.009.104c-.05.572-.124 1.14-.235 1.558a2.007 2.007 0 0 1-1.415 1.42c-1.16.312-5.569.334-6.18.335h-.142c-.309 0-1.587-.006-2.927-.052l-.17-.006-.087-.004-.171-.007-.171-.007c-1.11-.049-2.167-.128-2.654-.26a2.007 2.007 0 0 1-1.415-1.419c-.111-.417-.185-.986-.235-1.558L.09 9.82l-.008-.104A31.4 31.4 0 0 1 0 7.68v-.123c.002-.215.01-.958.064-1.778l.007-.103.003-.052.008-.104.022-.26.01-.104c.048-.519.119-1.023.22-1.402a2.007 2.007 0 0 1 1.415-1.42c.487-.13 1.544-.21 2.654-.26l.17-.007.172-.006.086-.003.171-.007A99.788 99.788 0 0 1 7.858 2h.193zM6.4 5.209v4.818l4.157-2.408L6.4 5.209z"
/>
</svg> </span
><a href="https://www.youtube.com/playlist?list=PLNxQuEFtVkeizoLEQiok7qzr1f0mcwfFb" class="mr-3">YouTube</a>
><a
href="https://www.youtube.com/playlist?list=PLNxQuEFtVkeizoLEQiok7qzr1f0mcwfFb"
class="mr-3"
>YouTube</a
>
<span
><svg
width="16"
Expand Down Expand Up @@ -108,13 +121,15 @@ <h1 class="font-weight-bold d-flex justify-content-center">
<div class="mb-5 text-white-75">
<p>
CLEO Redux is an experimental JavaScript runtime for GTA 3D era
games.
games and, with limited functionality,
<a href="https://re.cleo.li/docs/en/embedding.html"
>other games or applications</a
>.
</p>
<p>
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.
</p>
</div>

Expand Down

0 comments on commit 59cc45a

Please sign in to comment.