I was hoping we could get together and create a best practices/best style guide for Orx config. Maybe something we could put as a wiki page?
Good organization of config .ini files is important in a larger project.
I'll start. Here are some things I do that I have found helpful for organizing the config.
- Use Hungarian notation for the section types. For example, call the sections [O-<name>] for an object, [G-<name>] for a graphic, [FXS-<name>] for an FXSlot, etc.
- Split the section types into different files. graphics.ini, strings.ini.
- Split game objects by scene. levelobjects.ini, titlescreenobjects.ini, sharedobjects.ini
- Indent two spaces for the objects that are part of a ChildList of an owner object
- New one, testing now: If I have a base object that's inherited and extended by a lot of child objects, I don't specify position in the base object. Every child object specifies its position explicitly (avoids confusion when reading the sections).
Any comments on the above? Any other tips that others have found?
Sounds like a great idea!
I go with hungarian too but postfix instead of prefix. No real reason beside a matter of taste I think.
Not sure I understand that one. Probably too tired. Do you have a short example?
As I use ScrollEd for most object placements, I don't specify any position at all beside groups of objects for relative child positioning.
Also good to know: when your game is done, you can collapse all the config into one file and even encrypt it using orxCrypt. Makes a neat & clean release "package".
The config module is used by orx to describe user data handled by orx, as showned in CreationTemplate.ini.
But, maybe some users on this forum didn't realize that this module can be used to describe your own data, with your Key/Val. It's very very usefull to store/parse/load custum data. So, I just add this information here ^^
But yeah, it's a key info to convey, for sure.
A bit OT: Based on the feedback so far, my next Scroll tutorial will need to cover ScrollEd. Just as soon as I take the time to figure out how map loading works in Scroll..