alexandre
/
binding-of-isaac
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updating readme

This commit is contained in:
Alexandre 2025-02-22 12:05:23 +01:00
parent f855642a60
commit 6de46b1197
1 changed files with 25 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,4 +1,15 @@
# --| Syntax for level files |--
1) **General rule**
each file must be named "room_k" where k is a positive integer
if "room_k" exists then all "room_u" where 0 <= u < k exists
2) **Data structure**
below is a detailled list for all block types ;
each block type (Blocks, Teleporters, Entities) must have the corresponding word directly above it
not all three keywords have to be written
*Data-specific structure :*
blocks: blocks:
[x, y, z, w, h, d, rhz, rvt, r, g, b] [x, y, z, w, h, d, rhz, rvt, r, g, b]
@ -7,36 +18,33 @@ teleporters:
entities: entities:
[x, y, z, w, h, d, rhz, rvt, r, g, b, hp, damage, entityType ..] [x, y, z, w, h, d, rhz, rvt, r, g, b, hp, damage, entityType ..]
// Entity types are : *Entity types are :*
// 0 (coin) -> damage equals the coin's value -> **0 (coin)** -> damage equals the coin's value
// 1 (still explosive) -> **1 (non-moving explosive)**
// 2 (seeking explosive) -> **2 (seeking explosive)**
// 3 (shooting still explosive) -> **3 (shooting non-moving explosive)**
// if entityType = 4 (moving platform) -> **4 (moving platform)**
[.. amplitude_x, amplitude_y, amplitude_z, mult, divd, phase] with [.. amplitude_x, amplitude_y, amplitude_z, mult, divd, phase] with *<- extra arguments at the end of []*
amplitude_{x,y,z} = double[>= 0.0] amplitude_{x,y,z} = double[>= 0.0]
{mult,divd} = int {mult,divd} = int
{phase} = int[0, 360] {phase} = int[0, 360]
// else if entityType = 5 (linear moving platform) -> **5 (linear moving platform)**
[.. amplitude_x, amplitude_y, amplitude_z, speed_x, speed_y, speed_z] with [.. amplitude_x, amplitude_y, amplitude_z, speed_x, speed_y, speed_z] with
amplitude_{x,y,z} = double[>= 0.0] amplitude_{x,y,z} = double[>= 0.0]
speed_{x,y,z} = double speed_{x,y,z} = double
// else if entityType = 6 (text box) -> **6 (text box)**
[.. text, tred, tgreen, tblue] with [.. text, tred, tgreen, tblue] with
text = {char*} text = {char*}
// else if entityType = 7 (warp text box) -> **7 (warp text box)**
[.. dest_folder, room_count, text, tred, tgreen, tblue] with [.. dest_folder, room_count, text, tred, tgreen, tblue] with
{dest_folder,text} = {char*} (length <= 50) {dest_folder,text} = {char*} (length <= 50)
{r,g,b} = int[0-256] {r,g,b} = int[0-256]
// else if entityType = 8 (lock box) -> **8 (lock box)**
[.. cost, doPay, tred, tgreen, tblue] with [.. cost, doPay, tred, tgreen, tblue] with
cost = int[> 0] (0 breaks) cost = int[> 0] (0 breaks)
doPay = {0, 1} (bool) doPay = {0, 1} (bool)
else
[..]