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

Revised readmes and renamed the Steam Verify menu item

Browse source
This commit is contained in:
Vhati 2017-12-31 06:34:12 -05:00
parent fa8ac1f6d1
commit 4604519de7
3 changed files with 39 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

21
skel_unix/readme_for_unixlike.txt
View file

@ -24,9 +24,8 @@ Setup
Extract the files from this archive anywhere. Extract the files from this archive anywhere.
On the first run, you may be prompted to locate your On the first run, you may be prompted to locate your FTL resources.
FTL resources. Specifically "data.dat" in the "resources\" Specifically "data.dat" in a directory where FTL was installed.
directory under your FTL install.
On OSX, you can select "FTL.app", because the resources are inside it. On OSX, you can select "FTL.app", because the resources are inside it.
@ -55,6 +54,7 @@ Usage
If you upgrade FTL: If you upgrade FTL:
Delete the outdated files in Slipstream/backup/ Delete the outdated files in Slipstream/backup/
This can be done from the menu: Help-"Delete Backups".
If you don't, the game's resources will get corrupted. If you don't, the game's resources will get corrupted.
Commandline: Commandline:
@ -84,19 +84,22 @@ Troubleshooting
* If FTL's resources are corrupt... * If FTL's resources are corrupt...
Option 1: Option 1:
In SMM, Help-DeleteBackups In SMM, Help-"Delete Backups"
Steam users: Steam users:
In SMM, Help-Steam:VerifyGameCache. In SMM, Help-"Steam: Verify integrity of game files".
Standalone users: Standalone users:
Reinstall FTL. Reinstall FTL.
Option 2: Option 2:
Delete the files in SMM/backup/ Delete the files in SMM/backup/
Steam users: Steam users:
Delete FTL's resource directory: Start Steam and "verify integrity of game files".
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 https://support.steampowered.com/kb_article.php?ref=2037-QEUH-3335
Standalone users: Standalone users:
Reinstall FTL. Reinstall FTL.
* UnmappableCharacterException during patching...
For FTL 1.01-1.5.13, Slipstream re-encodes text to windows-1252, which
restricts the set of characters that can be used in mods. Click the
Validate button to find any problematic characters. FTL 1.6.1 switched to
unicode and should not have this problem.

20
skel_win/readme_for_windows.txt
View file

@ -28,9 +28,8 @@ Setup
Extract the files from this archive anywhere. Extract the files from this archive anywhere.
On the first run, you may be prompted to locate your On the first run, you may be prompted to locate your FTL resources.
FTL resources. Specifically "data.dat" in the "resources\" Specifically "data.dat" in a directory where FTL was installed.
directory under your FTL install.
In most cases, this should be located automatically. In most cases, this should be located automatically.
@ -43,7 +42,7 @@ Usage
To start the mod manager: To start the mod manager:
On XP, double-click modman.exe. On XP, double-click modman.exe.
On Windows 7 or Vista, Slipstream usually needs to be run as an administrator. Since Windows Vista, Slipstream usually needs to be run as an admin.
Right-click modman.exe and "Run as Administrator". Right-click modman.exe and "Run as Administrator".
Or double-click modman_admin.exe. Or double-click modman_admin.exe.
@ -61,12 +60,13 @@ Usage
If you upgrade FTL: If you upgrade FTL:
Delete the outdated files in Slipstream\backup\ Delete the outdated files in Slipstream\backup\
This can be done from the menu: Help-"Delete Backups".
If you don't, the game's resources will get corrupted. If you don't, the game's resources will get corrupted.
Commandline: Commandline:
Run "modman.exe -h" for commandline usage. Run "modman_admin.exe -h" for commandline usage.
On Windows 7 or Vista, the Command Prompt itself must be started as an Since Windows Vista, the Command Prompt itself may need to be started as an
administrator (right-click it in the start menu). administrator (right-click it in the start menu).
@ -136,7 +136,13 @@ Troubleshooting
Steam users: Steam users:
Delete FTL's resource directory: Delete FTL's resource directory:
"C:\Program Files [or (x86)]\Steam\steamapps\common\FTL Faster Than Light\resources" "C:\Program Files [or (x86)]\Steam\steamapps\common\FTL Faster Than Light\resources"
Start Steam and "verify game cache". Start Steam and "verify integrity of game files".
https://support.steampowered.com/kb_article.php?ref=2037-QEUH-3335 https://support.steampowered.com/kb_article.php?ref=2037-QEUH-3335
Standalone users: Standalone users:
Reinstall FTL. Reinstall FTL.
* UnmappableCharacterException during patching...
For FTL 1.01-1.5.13, Slipstream re-encodes text to windows-1252, which
restricts the set of characters that can be used in mods. Click the
Validate button to find any problematic characters. FTL 1.6.1 switched to
unicode and should not have this problem.

30
src/main/java/net/vhati/modmanager/ui/ManagerFrame.java
View file

@ -136,7 +136,7 @@ public class ManagerFrame extends JFrame implements ActionListener, ModsScanObse
private JMenuItem exitMenuItem; private JMenuItem exitMenuItem;
private JMenu helpMenu; private JMenu helpMenu;
private JMenuItem deleteBackupsMenuItem; private JMenuItem deleteBackupsMenuItem;
private JMenuItem steamVerifyCacheMenuItem; private JMenuItem steamVerifyIntegrityMenuItem;
private JMenuItem aboutMenuItem; private JMenuItem aboutMenuItem;
private JButton patchBtn; private JButton patchBtn;
@ -345,10 +345,10 @@ public class ManagerFrame extends JFrame implements ActionListener, ModsScanObse
deleteBackupsMenuItem.addMouseListener( new StatusbarMouseListener( this, "Delete backed up resources." ) ); deleteBackupsMenuItem.addMouseListener( new StatusbarMouseListener( this, "Delete backed up resources." ) );
deleteBackupsMenuItem.addActionListener( this ); deleteBackupsMenuItem.addActionListener( this );
helpMenu.add( deleteBackupsMenuItem ); helpMenu.add( deleteBackupsMenuItem );
steamVerifyCacheMenuItem = new JMenuItem( "Steam: Verify Game Cache" ); steamVerifyIntegrityMenuItem = new JMenuItem( "Steam: Verify integrity of game files" );
steamVerifyCacheMenuItem.addMouseListener( new StatusbarMouseListener( this, "Tell Steam to 'Verify Game Cache'." ) ); steamVerifyIntegrityMenuItem.addMouseListener( new StatusbarMouseListener( this, "Tell Steam to 'Verify integrity of game files'." ) );
steamVerifyCacheMenuItem.addActionListener( this ); steamVerifyIntegrityMenuItem.addActionListener( this );
helpMenu.add( steamVerifyCacheMenuItem ); helpMenu.add( steamVerifyIntegrityMenuItem );
helpMenu.add( new JSeparator() ); helpMenu.add( new JSeparator() );
aboutMenuItem = new JMenuItem( "About" ); aboutMenuItem = new JMenuItem( "About" );
aboutMenuItem.addMouseListener( new StatusbarMouseListener( this, "Show info about this application." ) ); aboutMenuItem.addMouseListener( new StatusbarMouseListener( this, "Show info about this application." ) );
@ -753,15 +753,13 @@ public class ManagerFrame extends JFrame implements ActionListener, ModsScanObse
} }
else if ( anyInvalid ) { else if ( anyInvalid ) {
resultBuf.append( "\n" ); resultBuf.append( "\n" );
resultBuf.append( "FTL itself can tolerate lots of XML typos and still run. " ); resultBuf.append( "FTL itself can tolerate lots of XML typos and still run. But malformed XML may " );
resultBuf.append( "But malformed XML may break tools that do proper parsing, " ); resultBuf.append( "break tools that do proper parsing, and it hinders the development of new " );
resultBuf.append( "and it hinders the development of new tools.\n" ); resultBuf.append( "tools.\n" );
resultBuf.append( "\n" ); resultBuf.append( "\n" );
resultBuf.append( "Since v1.2, Slipstream will try to parse XML while patching: " ); resultBuf.append( "Slipstream will try to parse XML while patching: first strictly, then failing " );
resultBuf.append( "first strictly, then failing over to a sloppy parser. " ); resultBuf.append( "over to a sloppy parser. The sloppy parser will tolerate similar errors, at the " );
resultBuf.append( "The sloppy parser will tolerate similar errors, at the risk " ); resultBuf.append( "risk of unforseen behavior, so satisfying the strict parser is advised.\n" );
resultBuf.append( "of unforseen behavior, so satisfying the strict parser " );
resultBuf.append( "is advised.\n" );
} }
infoArea.setDescription( "Results", resultBuf.toString() ); infoArea.setDescription( "Results", resultBuf.toString() );
} }
@ -849,7 +847,7 @@ public class ManagerFrame extends JFrame implements ActionListener, ModsScanObse
deleteBuf.append( "FTL *must be* in a working unmodded state *before* you click 'patch'.\n" ); deleteBuf.append( "FTL *must be* in a working unmodded state *before* you click 'patch'.\n" );
deleteBuf.append( "\n" ); deleteBuf.append( "\n" );
deleteBuf.append( "To get FTL into a working unmodded state, you may need to reinstall FTL\n" ); deleteBuf.append( "To get FTL into a working unmodded state, you may need to reinstall FTL\n" );
deleteBuf.append( "or use Steam's \"Verify Game Cache\" feature.\n" ); deleteBuf.append( "or use Steam's \"Verify integrity of game files\" feature.\n" );
deleteBuf.append( "\n" ); deleteBuf.append( "\n" );
deleteBuf.append( "Whenever FTL is updated, you will need to delete stale backups or the\n" ); deleteBuf.append( "Whenever FTL is updated, you will need to delete stale backups or the\n" );
deleteBuf.append( "game will break.\n" ); deleteBuf.append( "game will break.\n" );
@ -899,7 +897,7 @@ public class ManagerFrame extends JFrame implements ActionListener, ModsScanObse
} }
} }
} }
else if ( source == steamVerifyCacheMenuItem ) { else if ( source == steamVerifyIntegrityMenuItem ) {
String exePath = appConfig.getProperty( SlipstreamConfig.STEAM_EXE_PATH, "" ); String exePath = appConfig.getProperty( SlipstreamConfig.STEAM_EXE_PATH, "" );
File exeFile = null; File exeFile = null;
if ( exePath.length() == 0 || !(exeFile=new File( exePath )).exists() ) { if ( exePath.length() == 0 || !(exeFile=new File( exePath )).exists() ) {
@ -929,7 +927,7 @@ public class ManagerFrame extends JFrame implements ActionListener, ModsScanObse
FTLUtilities.verifySteamGameCache( exeFile, FTLUtilities.STEAM_APPID_FTL ); FTLUtilities.verifySteamGameCache( exeFile, FTLUtilities.STEAM_APPID_FTL );
} }
catch ( IOException f ) { catch ( IOException f ) {
log.error( "Couldn't tell Steam to 'verify game cache'", f ); log.error( "Couldn't tell Steam to 'verify integrity of game files'", f );
} }
} }