Create cross-reference spreadsheet

[ghost]

The purpose of this is similar to Sanctuary/notes. The idea is to have a spreadsheet containing a list of all the functions and major structs, and the location of them for each game version. This eliminates the need for offsets in the source code, since one can easily find the location of specific code across multiple game versions.

Instead of documenting every single patch, I'd like to focus on the notable ones:

• 1.09(b) - PSX: This is already finished as per Devilution
• 1.00 Debug: Very useful as it contains debug code not found in the release build, possibly other kinky features
• 1.04/Hellfire 1.01: Useful to document the new features (DRLG)
• Battle.net Beta: Now this is where things get really interesting. This patch was nearly identical to the final game in functionality, but contained lots of removed code. This includes code for unused spells, items, and more! I'd like to add this code back as a comment, since the devs likely kept it as such
• Alpha Demo: Only useful for spells like Invisibility, Sentinel, and Blood Boil.

The excel spreadsheet will look similar to a map file. It will have multiple offset columns.

[ghost]

Begin drafting a few different layouts. I like the last one but it would take forever to color each function. Any preferences guys?

[Cabalist]

I like the last one as well.

I can write a python script to get them formatted if the data is there. :)

[ghost]

@Cabalist That's great! I'll keep you posted once I get the initial spreadsheet uploaded. The text will be formatted as tabbed-text.

[Cabalist]

Fantastic. I'll set it up so that it can be run dynamically.

Excel is no issue but would this be worthwhile as an HTML document as well?

[DaveidWeba]

@Cabalist I know both Google Sheets and Excel can make an HTML capable file with ease.

Sheets
File > Publish To The Web > Link: Web Page > Publish
Example

Excel
File > Export > Change File Type > Save As > Web Page (.html) or Single File Web Page (.mhtml)

[ghost]

Initial version has been uploaded. galaxyhaxz/devilution@5f31783

I've decided not to include any PSX references, since the code is much too different. Instead it will focus primarily on Hellfire and the battle.net beta, with the debug build on the side. There's converters online for HTML but the size is pretty big so I'm just uploading the .XLS for now.

[ghost]

Handled via https://github.com/diasurgical/scalpel