awefs/README.md
2025-02-02 05:47:36 -05:00

62 lines
3.2 KiB
Markdown

# AWEfs
The Awesome Wonderful Entertaining File System
made for The Awesome Wonderful Operating System and AWEkernel
## Format version 1
### Header
#### Sector 1
Header and Boot sector - 512 Bytes - Offset 1
| Name | Size | Purpose |
|-----------------|------------|-------------------------------------------------------|
| Signature | 8 Bytes | Should be to "AWEFS   " |
| Version | 2 Bytes | Set to version of AWEFS (right now 01) |
| Serial number | 8 Bytes | Anything (i.e TestDisk) |
| Reserved | 46 Bytes | Reserved |
| Boot sector | 448 Bytes | Lua code (offset 65) |
#### Sector 2
Boot sector - 512 Bytes - Offset 513
| Name | Size | Purpose |
|-----------------|------------|-------------------------------------------------------|
| Boot sector | 512 Bytes | Lua code, extends sector 1 |
#### Sector 3-5
Unmanaged data - 1.5 KiB - Offset 1025
| Name | Size | Purpose |
|-----------------|------------|-------------------------------------------------------|
| Reserved | 512 Bytes | Reserved |
#### Sector 6-10
File table - 2.5 KiB - Offset 2502
| Name | Size | Purpose |
|-----------------|------------|-------------------------------------------------------|
| Signature | 8 Bytes | Should be "FILES   " |
| Padding/Reserved| 3 Bytes | Empty |
| File table | 2533 Bytes | See File Declaration |
| End of filetable| 16 Bytes | Should be "EOFTEOFTEOFTEOFT" |
#### Sector 11-x
File table - Rest - Offset 5062
| Name | Size | Purpose |
|-----------------|------------|-------------------------------------------------------|
| Data | Rest of disk| Files |
### File Declaration in FileTable
| Name | Size | Purpose |
|-----------------|------------|-------------------------------------------------------|
| File name | 16 Bytes | i.e "FILENAME.txt    " |
| File Offset | 8 Bytes | Offset of file |
| Size | 2 Bytes | Size of file to load in sectors |
| Reserved | 6 Bytes | Reserved |
### File
| Name | Size | Purpose |
|-----------------|------------|-------------------------------------------------------|
| Start file head.| 9 Bytes | "STARTFILE" |
| Data | Defined | Data |