mirror of https://github.com/SeekyCt/spm-decomp.git synced 2024-11-27 07:10:33 +00:00

History

Seeky fb581abc09 M2C fixes		2023-09-01 15:08:54 +01:00
..
decomp	git subrepo clone https://github.com/SeekyCt/spm-headers.git spm-headers	2022-12-23 11:34:05 +00:00
include	M2C fixes	2023-09-01 15:08:54 +01:00
linker	git subrepo pull --force --branch=spm-decomp spm-headers	2023-01-28 21:45:22 +00:00
mod	git subrepo clone https://github.com/SeekyCt/spm-headers.git spm-headers	2022-12-23 11:34:05 +00:00
.gitrepo	git subrepo pull --force --branch=spm-decomp spm-headers	2023-01-28 21:45:22 +00:00
CONTRIBUTING.md	git subrepo clone https://github.com/SeekyCt/spm-headers.git spm-headers	2022-12-23 11:34:05 +00:00
README.md	git subrepo pull --force --branch=spm-decomp spm-headers	2023-01-28 21:45:22 +00:00

README.md

spm-headers

WIP header library for Super Paper Mario.

Setup

General

One of the following preprocessor defines should be used for the target game version:

SPM_JP0
SPM_JP1
SPM_US0
SPM_US1
SPM_US2
SPM_EU0
SPM_EU1
SPM_KR0

It is recommended to use this with git subrepo.

Decomp

For use in decomp, the include and decomp folders should be added to the include path, and the preprocessor define DECOMP should be used.

Mods

For use in mods, the include and mod folder should be added to the include path and an lst from linker should be used..

Licensing

All code originally written for this project (everything under the include, decomp and linker directories) is available under the MIT license.

Everything under the mod folder is available under the GPLv3 license as it's derived from other GPL code.

Symbols

Currently, symbols are manually added and ported as needed. Any symbols that are missing from the lsts here can be found in the decomp symbols yml for eu0. In the future, that yml will become part of this repo and the lsts will be auto generated based on it.

Contributing

See CONTRIBUTING.md for guidelines on contributing.