Secretchronicles / TSC

An open source two-dimensional platform game.
https://secretchronicles.org/
GNU General Public License v3.0
204 stars 50 forks source link

Document settings files #53

Open Quintus opened 10 years ago

Quintus commented 10 years ago

There is currently no documentation for the .settings files that define sprites’ behaviours. Settings file parsing is implemented in img_settings.cpp. See Eato’s settings file for a simple example.

This should go into a file smc/docs/settings_files.txt or so.

Valete, Quintus

Luiji commented 10 years ago

I can write that up later today. I would like to mention that FluXy was always interested in converting the settings format to Xml, along with all other custom formats. I imagine his eventual goal would be the ability to obliterate the custom key-pair format class as well.

Quintus commented 10 years ago

Moving it to XML to have a uniform format is a good idea. But, as SMC 2.0.0 at least tries to be backward-compatible, the time for this has not yet come. For the next big version, when we break backward-compatibility, that should definitely be done.

Vale, Quintus

Luiji commented 9 years ago

Note to self: remove italics commands from headings because they don't work within code blocks.

DarkAceZ commented 9 years ago

Do the different ground types spawn different particle effects? (like when running/jumping on them)

datahead8888 commented 9 years ago

Moving it to XML to have a uniform format is a good idea. But, as SMC 2.0.0 at least tries to be backward-compatible, the time for this has not yet come. For the next big version, when we break backward-compatibility, that should definitely be done.

I seem to remember people saying they did not want the .settings files in an xml format because it might make it a bit harder to manipulate them with scripts. Many programmers on the team use scripts to mass manipulate .settings files rather than a tool such as the image settings file editor that Quintus wrote.

I understand the desire to have everything in xml rather than have some data in xml and some data not in xml, but I think it's worth talking some more before switching everything over.

Quintus commented 9 years ago

Do the different ground types spawn different particle effects? (like when running/jumping on them)

Yes. Set it to ice and you’ll slide on it.

Vale, Quintus

Luiji commented 9 years ago

@Quintus I'll keep that in mind!

Quintus commented 8 years ago

Unassigning, Luiji doesn’t have time for this.