What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how the Bat familar works in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay TT_000 and all the files under src/servant/tt_000, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

OS: Ubuntu 22.04.3 via WSL2

sha1sum --check config/check.us.sha
build/us/main.exe: FAILED
...
sha1sum: WARNING: 1 computed checksum did NOT match
make: *** [Makefile:146: check] Error 1

Bisected to 437856d

What

func_801BAB70 is a small function that has not yet been decompiled. It belongs to the stage SEL.

This is a good function for those who wants to start contributing to the project and have little programming skills. Please follow Build and Decompilation to know how to start with decompiling functions.

Acceptance criteria

The function func_801BAB70 must all be written in C, running make all must return OK and a Pull Request must follow. The issue will be marked as Complete if the Pull Request will be accepted and merged.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how the debug map work in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay MAD and all the files under src/st/mad, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how entities work in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay DRA and all the files under src/dra/, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how the Nightmare map and the boss Succubus work in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay DRE and all the files under src/st/dre, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how entities work in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay CEN and all the files under src/st/cen, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how entities work in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay RIC and all the files under src/ric/, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

What

The latest minor version bump of GNU Make does not work well with this project due to some documented breaking changes. The problem only occurs when building happens in parallel (e.g. make -j build. The problem is GCC wants to compile C files and output them to directories that do not yet exist.

This good first issue will help you to familiarise with our build chain.

Technical details

In the Makefile there are targets that are responsible for creating the output directories:

tt_%_dirs:
	$(foreach dir,$(ASM_DIR)/servant/tt_$* $(ASM_DIR)/servant/tt_$*/data $(SRC_DIR)/servant/tt_$* $(ASSETS_DIR)/servant/tt_$*,$(shell mkdir -p $(BUILD_DIR)/$(dir)))
st%_dirs:
	$(foreach dir,$(ASM_DIR)/st/$* $(ASM_DIR)/st/$*/data $(SRC_DIR)/st/$* $(ASSETS_DIR)/st/$*,$(shell mkdir -p $(BUILD_DIR)/$(dir)))
%_dirs:
	$(foreach dir,$(ASM_DIR)/$* $(ASM_DIR)/$*/data $(SRC_DIR)/$* $(ASSETS_DIR)/$*,$(shell mkdir -p $(BUILD_DIR)/$(dir)))

When an overlay is built, these targets are called. For example doing make cen calls the target cen: stcen_dirs $(BUILD_DIR)/CEN.BIN to first create the directories and then the output binary. This behaviour was working on Make 4.3 and below as dependent targets were always processed in order.

Potential solution

Before GCC is called, mkdir -p $(dir $@) can be called to ensure the directory exists. This is already done in Makefile.saturn.mk. Once this part is done, the various targets %_dirs can be deleted.

On Arch Linux I personally made a back-up of make 4.3-5.1 to easily downgrade and test things around.

What is affected

• Arch Linux since October 2022
• Gentoo since October 2022
• Fedora since version 38
• openSUSE since February 2023

What is NOT affected

• Debian 12
• Debian 13
• Ubuntu 22.04 LTS
• Ubuntu 23.10
• Ubuntu 24.04 LTS

Acceptance criteria

Any of the affected operating systems, or Debian/Ubuntu with make 4.4 installed, needs to be able to run make -j build successfully and consistently.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how the Warp Room works in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay WRP and all the files under src/st/wrp, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

What

func_801B0414 is a small function that has not yet been decompiled. It belongs to the stage ST0.

This is a good function for those who wants to start contributing to the project and have little programming skills. Please follow Build and Decompilation to know how to start with decompiling functions.

Acceptance criteria

The function func_801B0414 must all be written in C, running make all must return OK and a Pull Request must follow. The issue will be marked as Complete if the Pull Request will be accepted and merged.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how the Prologue stage and Dracula work in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay ST0 and all the files under src/st/st0, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

What

func_801D0B40 is a small function that has not yet been decompiled. It belongs to the stage NP3.

This is a good function for those who wants to start contributing to the project and have little programming skills. Please follow Build and Decompilation to know how to start with decompiling functions.

Acceptance criteria

The function func_801D0B40 must all be written in C, running make all must return OK and a Pull Request must follow. The issue will be marked as Complete if the Pull Request will be accepted and merged.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how the Castle Entrance map work in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function. This is very similar to #746 as they both share a large amount of code.

Acceptance criteria

For the overlay NP3 and all the files under src/st/np3, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

Feature request

Problem or desire

The repository looks incomplete because of the missing CONTRIBUTING.md file to specify the rules and regulations to follow while contributing to the repository, I want to add that file to the repo.

Proposal

Add the CONTRIBUTING file to the repository with guidelines.

Kindly assign me this issue.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how the Marble Gallery map and how Gaibon&Slogra bosses work in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay NZ0 and all the files under src/st/nz0, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

What

In the past we used a structure for our Entity system that held all the unknown values. Later on we found the last 0x40 bytes are a reserved memory area for each entity to store their custom values. After a few proposals #187, #188, #195 we decided to come with a pattern where all this reserved areas for each entity will fall into their respective unique struct found in include/entity.h with ET_ as a prefix. This approach was never retroactively applied to the already decompiled entities, which are now using the structure ET_Generic and used as .ext.generic. This is legacy and it is creating unnecessary coupling to a dying structure.

This is an opportunity to learn how the Castle Entrance map, the introductory sequence and the dialogue with Death work in Symphony of the Night. You will have the freedom of documenting what an entity does and take ownership of each entity function.

Acceptance criteria

For the overlay NO3 and all the files under src/st/no3, remove any reference to .ext.generic and use dedicated structures for the entity. No union or weird casts should to be used with the new structures.

The contributing.md file can be enhanced way better.