jan-leila/Slipstream-Mod-Manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Revised readmes

Browse source
This commit is contained in:
Vhati 2017-12-11 20:52:50 -05:00
parent 699bbcf328
commit c52d28c33c
4 changed files with 44 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -19,7 +19,7 @@ Requirements
------------ ------------
* Java (1.6 or higher). * Java (1.6 or higher).
* http://www.java.com/en/download/ * http://www.java.com/en/download/
* FTL (1.01-1.5.13, Windows/OSX/Linux, Steam/GOG/Standalone). * FTL (1.01-1.6.2, Windows/OSX/Linux, Steam/GOG/Standalone).
* http://www.ftlgame.com/ * http://www.ftlgame.com/
* WinXP SP1 can't run Java 1.7. * WinXP SP1 can't run Java 1.7.
* (1.7 was built with VisualStudio 2010, causing a DecodePointer error.) * (1.7 was built with VisualStudio 2010, causing a DecodePointer error.)

12
skel_common/readme_modders.txt
View file

@ -55,9 +55,7 @@ General
accepts the unix style (LF): fine for xml, crashing for layout.txt. accepts the unix style (LF): fine for xml, crashing for layout.txt.
Slipstream will convert both to CR-LF as it patches. Slipstream will convert both to CR-LF as it patches.
File and directory names must be plain ASCII (no accents). That File and directory names must be plain ASCII (no accents).
restriction isn't confirmed for the game, but the mod manager enforces
it just to be safe.
Images should be 32bit PNGs (24bit color + 8bit alpha transparency). Images should be 32bit PNGs (24bit color + 8bit alpha transparency).
Things that *should* be opaque rectangles like backgrounds may vary, Things that *should* be opaque rectangles like backgrounds may vary,
@ -108,6 +106,14 @@ Encoding!?
by including tests to determine when they're dealing with UTF-16 or by including tests to determine when they're dealing with UTF-16 or
something else. something else.
Note to translators: Slipstream lets modders encode how they like and
converts to whatever FTL wants, but characters are limited by how FTL
ultimately reads the text. FTL 1.01-1.5.13 assumes text to be windows-1252
(you can only use characters that would be valid in that encoding). Since
FTL 1.6.1, it assumes UTF-8 (no worries). After the game has read the text,
another issue is whether the fonts contain the glyphs to display the
characters. You may need to replace the fonts.
Advanced XML Advanced XML

27
skel_unix/readme_for_unixlike.txt
View file

@ -84,13 +84,20 @@ Troubleshooting
See the suggestion below for replacing corrupt resources. See the suggestion below for replacing corrupt resources.
* If FTL's resources are corrupt... * If FTL's resources are corrupt...
Delete the files in SMM/backup/ Option 1:
Steam users: In SMM, Help-DeleteBackups
Delete FTL's resource directory: Steam users:
Linux: "[~/.local/share or $XDG_DATA_HOME]/Steam/SteamApps/common/FTL Faster Than Light/data/resources" In SMM, Help-Steam:VerifyGameCache.
Mac: "~/Library/Application Support/Steam/SteamApps/common/FTL Faster Than Light/FTL.app" Standalone users:
Start Steam and "verify game cache". Reinstall FTL.
https://support.steampowered.com/kb_article.php?ref=2037-QEUH-3335
Run FTL, which will cause steam to copy fresh resources from its cache. Option 2:
Standalone users: Delete the files in SMM/backup/
Reinstall FTL. Steam users:
Delete FTL's resource directory:
Linux: "[~/.local/share or $XDG_DATA_HOME]/Steam/SteamApps/common/FTL Faster Than Light/data/resources"
Mac: "~/Library/Application Support/Steam/SteamApps/common/FTL Faster Than Light/FTL.app"
Start Steam and "verify game cache".
https://support.steampowered.com/kb_article.php?ref=2037-QEUH-3335
Standalone users:
Reinstall FTL.

27
skel_win/readme_for_windows.txt
View file

@ -16,7 +16,7 @@ Requirements
Java (1.6 or higher). Java (1.6 or higher).
http://www.java.com/en/download/ http://www.java.com/en/download/
FTL (1.01-1.5.13, Windows/OSX/Linux, Steam/GOG/Standalone). FTL (1.01-1.6.2, Windows/OSX/Linux, Steam/GOG/Standalone).
http://www.ftlgame.com/ http://www.ftlgame.com/
* WinXP SP1 can't run Java 1.7. * WinXP SP1 can't run Java 1.7.
@ -121,12 +121,19 @@ Troubleshooting
See the suggestion below for replacing corrupt resources. See the suggestion below for replacing corrupt resources.
* If FTL's resources are corrupt... * If FTL's resources are corrupt...
Delete the files in SMM\backup\ Option 1:
Steam users: In SMM, Help-DeleteBackups
Delete FTL's resource directory: Steam users:
"C:\Program Files [or (x86)]\Steam\steamapps\common\FTL Faster Than Light\resources" In SMM, Help-Steam:VerifyGameCache.
Start Steam and "verify game cache". Standalone users:
https://support.steampowered.com/kb_article.php?ref=2037-QEUH-3335 Reinstall FTL.
Run FTL, which will cause steam to copy fresh resources from its cache.
Standalone users: Option 2:
Reinstall FTL. Delete the files in SMM\backup\
Steam users:
Delete FTL's resource directory:
"C:\Program Files [or (x86)]\Steam\steamapps\common\FTL Faster Than Light\resources"
Start Steam and "verify game cache".
https://support.steampowered.com/kb_article.php?ref=2037-QEUH-3335
Standalone users:
Reinstall FTL.