Added support for embedded descriptions

This commit is contained in:
Vhati 2013-09-19 13:00:48 -04:00
parent 2cdba9062e
commit 5cd19480ad
22 changed files with 889 additions and 333 deletions

File diff suppressed because one or more lines are too long

Binary file not shown.

Binary file not shown.

View file

@ -1,13 +1,3 @@
Drop any .ftl files here and restart Slipstream in order to be able to patch them in.
The last-used order is remembered with modorder.txt, if it exists here.
"Beginning Scrap Advantage" is a simple example mod. All it does is give you some extra scrap when you first start a game. Rename .ftl to .zip and extract it in order to study it further.
"Engi Scrap Advantage" is another example mod demonstrating advanced XML tags to chain-load existing events. All it does is give you some extra scrap when you enter an Engi sector.
See also: "readme_modders.txt".
Those special tags require Slipstream Mod Manager 1.2+.

View file

@ -10,6 +10,7 @@ Changelog
- Fixed sloppy parser Validate error about things not allowed at root
- Added a Preferences dialog as an alternative to editing modman.cfg
- Added a troubleshooting note about Java 1.7.0_25 to readmes
- Added support for embedded descriptions in *.ftl files
1.2:
- Added a commandline interface

View file

@ -3,23 +3,29 @@ Mod Developer Notes
Creating an .ftl File
An .ftl file is simply a renamed .zip with a specific file structure.
For an example, try renaming and unpacking the example .ftl file that
comes with the program.
For an example, try renaming and unpacking the example mods.
The root of the ZIP file should contain one or more of these folders:
data/
audio/
fonts/
img/
mod-appendix/
You should ONLY put in the files that you want to modify. This keeps
mod sizes low and prevents major conflict between mods.
The "mod-appendix/" folder is for extra files that will not be inserted
into the game's resources. Slipstream will look for the following inside.
metadata.xml
Optional embedded description. (See the example mods.)
The Append Extension
Any file in your .ftl with the extension .xml.append will be appended to
its respective vanilla file. (See the example mod.)
its respective vanilla file. (See the example mods.)
It is highly recommended that you take advantage of this as much as
possible. As a rule of thumb, if you're editing an event xml file,