-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated regions.txt and the documentation on how to format it
- Loading branch information
1 parent
c8291e5
commit fbdadeb
Showing
4 changed files
with
97 additions
and
240 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
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,16 +1,93 @@ | ||
# Formatting `regions.csv` | ||
# Formatting `regions.txt` | ||
|
||
> _NOTE_: USE ` INSTEAD OF ' OR " | ||
## Here is how each of the types should be setup in regions.txt: | ||
|
||
### standard types | ||
|
||
> this includes: | ||
> - `u8`, `u16`, `u32` | ||
> - for positive-only numbers | ||
> - `i8`, `i16`, `i32` | ||
> - for numbers that can be negative | ||
these are just the typical integer-based number formats. | ||
|
||
```txt | ||
name: type | ||
start offset | ||
end offset (exclusive) | ||
end offset | ||
section | ||
description | ||
``` | ||
|
||
### ABILITIES | ||
|
||
abilities are a built-in special type that just create a drop down | ||
of each spirit ability automatically. | ||
These should be taken care of already, so no need to change | ||
or modify them further. | ||
|
||
```txt | ||
name: ABILITY | ||
start offset | ||
end offset | ||
section | ||
description | ||
``` | ||
|
||
### HEX | ||
|
||
a type used when not much is known about a region other than the bounds. | ||
this indicates that you'll need to edit the value in the hex editor. | ||
|
||
```txt | ||
name: HEX | ||
start offset | ||
end offset | ||
section | ||
description | ||
``` | ||
|
||
### ENUM | ||
|
||
a type used when you want to only provide known sets of values for one | ||
entry in the form of a drop-down. | ||
|
||
**THIS CAN BE SET TO AFFECT INDIVIDUAL BITS TOO** | ||
|
||
```txt | ||
name: ENUM | ||
0xHEX b(0-7) | ||
0xHEX b(0-7) | ||
section | ||
documentation | ||
| <-- LINE BREAK | ||
<next entry here> | ||
{ | ||
entry 1: value 1 | ||
entry 2: value 2 | ||
etc: etc | ||
} | ||
description | ||
``` | ||
|
||
start and end offsets should be represented as hex. | ||
line breaks signify the next entry. | ||
it should be noted that `value`s can take the form of: | ||
- numbers (`69`, `234234`, `646345`, ...) | ||
- hex (`0x56`, `0x04`, ...) | ||
- binary (`0b00001`, `0b100101`, `0b0101`) | ||
|
||
### bits | ||
|
||
a type used when you want to affect **bits** *instead* of full bytes. | ||
While as of 6/16/2020 it is currently unused, I have a feeling that will change | ||
once a greater understanding of stuff is reached. | ||
|
||
```txt | ||
name: bits | ||
0xHEX b(0-7) | ||
0xHEX b(0-7) | ||
section | ||
description | ||
``` | ||
|
||
> _NOTE_: USE ` INSTEAD OF ' OR " | ||
Unlike typical input boxes, this will *always* have the binary display | ||
beside it for ease of understanding. |
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