pso_gc_tools/quests.h

#ifndef QUESTS_H_INCLUDED
#define QUESTS_H_INCLUDED

#include <stdio.h>
#include <stdint.h>

#include "defs.h"

#define PACKET_ID_QUEST_INFO_ONLINE    0x44
#define PACKET_ID_QUEST_INFO_DOWNLOAD  0xa6
#define PACKET_ID_QUEST_CHUNK_ONLINE   0x13
#define PACKET_ID_QUEST_CHUNK_DOWNLOAD 0xa7

// quest .bin file header (after file contents have been prs-decompressed)
typedef struct _PACKED_ {
	uint32_t object_code_offset;
	uint32_t function_offset_table_offset;
	uint32_t bin_size;
	uint32_t xffffffff;                     // always 0xffffffff ?
	uint8_t download;

	// have seen some projects define this field as language. "newserv" just calls it unknown? i've seen multiple
	// values present for english language quests ...
	uint8_t unknown;

	// "newserv" has these like this here, as quest_number and episode separately. most other projects that parse
	// .bin files treat quest_number as a 16-bit number. in general, i think the "episode" field as a separate byte
	// is *probably* better when dealing with non-custom quests. however, some custom quests (which are mostly of
	// dubious quality anyway) clearly were created using a tool which had quest_number as a 16-bit value ...
	// ... so .... i dunno! i guess i'll just leave it like this ...
	uint8_t quest_number;
	uint8_t episode;

	// some sources say these strings are all UTF-16LE, but i'm not sure that is really the case for gamecube data?
	// for gamecube-format quest .bin files, it instead looks like SHIFT-JIS probably ... ?

	char name[32];
	char short_description[128];
	char long_description[288];
} QUEST_BIN_HEADER;

typedef struct _PACKED_ {
	uint32_t type;
	uint32_t table_size;
	uint32_t area;
	uint32_t table_body_size;
} QUEST_DAT_TABLE_HEADER;

// .qst file header, for either the embedded bin or dat quest data
typedef struct _PACKED_ {
	// 0xA6 = download to memcard, 0x44 = download for online play
	// (quest file data chunks must then be encoded accordingly. 0xA6 = use 0xA7, and 0x44 = use 0x13)
	uint8_t pkt_id;

	// khyller sets .dat header value to 0xC9, .bin header value to 0x88
	// newserv sets both to 0x00
	// sylverant appears to set it differently per quest, the logic/reasoning behind it is unknown to me
	// ... so, this value is probably unimportant?
	uint8_t pkt_flags;

	uint16_t pkt_size;
	char name[32];
	uint16_t unused;

	// khyller sets .dat header value to 0x02, .bin header value to 0x00
	// newserv sets both to 0x02
	// sylverant sets both to 0x00
	// ... and so, this value is also probably unimportant?
	uint16_t flags;

	char filename[16];
	uint32_t size;
} QST_HEADER;

typedef struct _PACKED_ {
	uint8_t pkt_id;
	uint8_t pkt_flags;
	uint16_t pkt_size;
	char filename[16];
	uint8_t data[1024];
	uint32_t size;
} QST_DATA_CHUNK;

int generate_qst_header(const char *src_file, size_t src_file_size, QUEST_BIN_HEADER *bin_header, QST_HEADER *out_header);
int generate_qst_data_chunk(const char *base_filename, uint8_t counter, const uint8_t *src, uint32_t size, QST_DATA_CHUNK *out_chunk);
int validate_quest_bin(QUEST_BIN_HEADER *header, uint32_t length);
int validate_quest_dat(uint8_t *data, uint32_t length);

#endif