Skip to content

Commit

Permalink
fix DOCUMENTATION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SalatielSauer committed Dec 31, 2024
1 parent 6f4d506 commit 84cf772
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 3 additions & 3 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The available entity types are:
- `at4`: Sets fifth attribute of entity.

The engine loads a maximum of 10.000 entities. Some entities (like particles) accept colors as an attribute. Example:
```json
```js
// adds a magenta colored fire particle
{x: 512, y: 512, z: 512, t: 5, at3: [255, 0, 255]}
```
Expand All @@ -64,7 +64,7 @@ The engine loads a maximum of 10.000 entities. Some entities (like particles) ac

#### Textures
Textures are defined using the face identifier and an index corresponding to registered textures. Example:
```json
```js
// adds a cube with size 32x32 and white texture (assuming default registered textures)
{x: 512, y: 512, z: 512, g: 5, af: 1462}
```
Expand Down Expand Up @@ -94,7 +94,7 @@ Currently the formatter does not automatically adjust corners to prevent interse

#### Vslots commands
Currently the formatter will take any given texture as a base and apply the modified vslot index to an `af`, which means that for now it is only possible to apply vcommands to individual faces by setting the indexes manually to link them to the modified slot indexes.
```json
```js
// adds two 32x32 cubes, the first one adds a custom vslot color with base texture 1462, the second one uses the same created slot (1704) on a different face (assuming the default registered textures length is 1703).
[
{x: 512, y: 512, z: 512, g: 5, af: 1462, vcolor: [255, 0, 255]},
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ https://salatielsauer.github.io/OGZ-Editor/

<hr>

Below is a general guide, you can find more information about JSOCTA properties in [DOCUMENTATION.md](DOCUMENTATION.md).

## Map Variables
To apply mapvars you can use the `mapvars({})` function. Pay special attention to their types, strings must be enclosed in double quotes and RGB colors must be defined as arrays.
```js
Expand Down

0 comments on commit 84cf772

Please sign in to comment.