zenithsiz/ddw3
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed some typos and wrong links in documentation.

Browse Source
This commit is contained in:
Filipe Rodrigues 2023-10-05 20:46:49 +01:00
parent c6f77d0881
commit d100ae9e42
2 changed files with 24 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -9,20 +9,19 @@ The name stands for "Decompilation - Digimon World 3/2003"
Currently the following is done:
- ✅: Done
-
- 🚧: In work
- 🛑: Not started
| Project | Status | Comments |
| ------------------ | ------ | --------------------------------------------------------------------------------------------------------------------- |
| Digimon world 3 | 🛑 | For now, 2003 is receiving the main focus. It should be easy to make it catch up to it, but it will require some time |
| Digimon world 2003 | 🚧 | See [this section](##2003) |
| Digimon world 2003 | 🚧 | See [this section](#2003) |
## 2003
| Project | Status | Comments |
| ------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Executable (and dylibs) | 🚧 | Fully disassembled in `asm/`. Some parts have been organized, but it's mostly still just machine-generated. |
| Executable (and dylibs) | 🚧 | Fully disassembled in `asm/` and `rust/` (mostly data here). Some parts have been organized, but it's mostly still just machine-generated. |
| Images (`tim`s) | ✅ (🚧) | All found `tim`s have been fully converted to pngs with their `clut`s as separate png files in `tim/`. Further work should be done here to convert them to a single file |
| Localization files (lang files) | ✅ (🚧) | All found localization files are in `lang_file/`. Some escape codes are currently unknown and need to be documented |
| Video (`str`s) | 🛑 | They remain in their original `str` file format. In the future we would want to convert them to another file format that would support lossless conversion to `str`. |
@ -30,7 +29,7 @@ Currently the following is done:
# Documentation
See [`docs/index.MD`]() for an introduction to the repository.
See [`docs/index.MD`](docs/index.md) for an introduction to the repository.
# Building

43
docs/tim.md
View File

@ -25,33 +25,32 @@ bpp: Indexed4 | Indexed8 | Color16 | Color24
# Palette data
# Note: Only used if `Indexed4` or `Indexed8`
clut:
# Position to store the clut at
pos:
- <x position>
- <y position>
# Position to store the clut at
pos:
- <x position>
- <y position>
# Kind of palette:
# - `include`: Uses the clut to generate the indices
# for the image, and will include the clut.
# - `external`: Uses the clut to generate the indices
# for the image, but will *not* include the clut.
# - `auto`. Automatically calculates the clut from
# the given image, and includes it.
kind: include
path: 0.clut.png
# Kind of palette:
# - `include`: Uses the clut to generate the indices
# for the image, and will include the clut.
# - `external`: Uses the clut to generate the indices
# for the image, but will *not* include the clut.
# - `auto`. Automatically calculates the clut from
# the given image, and includes it.
kind: include
path: 0.clut.png
# Image data
img:
# Note: Required even when using indexed images
pos:
- <x position>
- <y position>
# Path to the image
# Note: Even when indexed, this should be a png.
# The indices will be calculated from the clut.
path: <path to image>
# Note: Required even when using indexed images
pos:
- <x position>
- <y position>
# Path to the image
# Note: Even when indexed, this should be a png.
# The indices will be calculated from the clut.
path: <path to image>
```
Then using `build/tools/ddw3-mktim <yaml> --output <tim>`