chatty.github.io/help/help-guide_folders.html

231 lines
9.3 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<title>Chatty Help</title>
<link rel="stylesheet" type="text/css" href="style.css" />
2015-08-10 21:25:24 +02:00
<style type="text/css">
.fileComment {
color: gray;
}
.fileCommentFolder {
}
.filesT {
font-family: Monospace;
margin: 10px 0 14px 0;
}
.filesT td {
margin: 0;
padding: 0;
padding-right: 5px;
padding-top: 2px;
}
</style>
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Guide: Chatty directories and files</a></h1>
<p>
2015-08-10 21:25:24 +02:00
<a href="#files">Files/Directory structure</a> |
<a href="#backup">Backup</a>
</p>
<p>Learn what directories and files Chatty creates/uses.</p>
2015-08-10 21:25:24 +02:00
<h2><a name="files">Files/Directory structure</a></h2>
<h3>Settings Directory</h3>
2015-08-10 21:25:24 +02:00
<p>The settings directory by default is in your user home directory in a
subfolder called <code>.chatty</code>. If you use the <code>-cd</code>
commandline parameter, then the settings directory is the current Working
Directory.</p>
2015-08-10 21:25:24 +02:00
<p>You can use commandline parameters by <a href="help-guide_create_shortcut.html">creating a shortcut</a> and setting the
target to something like <code>javaw.exe -jar "D:\Chatty\Chatty.jar" -cd</code>.</p>
2015-08-10 21:25:24 +02:00
<p>Use the command <code>/dir</code> to display and <code>/openDir</code> to
open the Settings Directory.</p>
<table class="filesT">
<tr>
<td>&lt;settings directory&gt;</td>
<td></td>
</tr>
<tr>
<td>|-- backup</td>
<td class="fileCommentFolder">[Folder]</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- backup_x_&lt;filename&gt;</td>
<td class="fileComment">Setting backups</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- backup_meta</td>
<td class="fileComment">Backups meta (last backup, numbering)</td>
</tr>
<tr>
<td>|-- cache</td>
<td class="fileCommentFolder">[Folder]</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- &lt;various cache files&gt;</td>
<td class="fileComment">Cached emotes/image files</td>
</tr>
2016-04-26 21:14:25 +02:00
<tr>
<td>|-- debuglogs</td>
<td class="fileCommentFolder">[Folder] Files intended to be read
by the user</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- debug_session.log.x</td>
<td class="fileComment">Last session debug log (overwritten every run)</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- debugx.log.x</td>
<td class="fileComment">Rotating debug log</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- debug_ircx.log.x</td>
<td class="fileComment">Rotating raw IRC log (only if enabled)</td>
</tr>
2015-08-10 21:25:24 +02:00
<tr>
<td>|-- exported</td>
<td class="fileCommentFolder">[Folder] Files intended to be read
by the user</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- stream_highlights.txt</td>
<td class="fileComment">Recorded stream highlights</td>
</tr>
<tr>
<td>|-- logs</td>
<td class="fileCommentFolder">[Folder]</td>
</tr>
<tr>
<td>|&nbsp; &nbsp;|-- &lt;channel&gt;.log</td>
<td class="fileComment">Chat log files</td>
</tr>
<tr>
<td>|-- addressbook</td>
<td class="fileComment">[Settings] Addressbook entries</td>
</tr>
<tr>
2015-08-10 21:25:24 +02:00
<td>|-- login</td>
<td class="fileComment">[Settings] Your login data (keep this secure)</td>
</tr>
<tr>
2015-08-10 21:25:24 +02:00
<td>|-- favoritesAndHistory</td>
<td class="fileComment">[Settings] Channel History/Favorites</td>
</tr>
<tr>
2015-08-10 21:25:24 +02:00
<td>|-- settings</td>
<td class="fileComment">[Settings] Main Settings File</td>
</tr>
<tr>
2015-08-10 21:25:24 +02:00
<td>|-- statusPresets</td>
<td class="fileComment">[Settings] Stream Title/Game presets (Admin Dialog)</td>
</tr>
2015-08-10 21:25:24 +02:00
</table>
2015-08-10 21:25:24 +02:00
<h3><a name="wdir">Working Directory</a></h3>
<p>This directory is associated with Chatty when you start it. This is usually
the directory the program is started from. If you created a shortcut to start
Chatty with, this may point to the Java-executable instead of Chatty itself,
which can lead to errors. In Windows, you can change the Working Directory
in the shortcut settings by changing what is defined under <code>Run in</code>.
Make sure this points to the same folder the <code>Chatty.jar</code> is in
(or something else if you want to customize it, just make sure the files you
need are there).</p>
<p>Use the command <code>/wdir</code> to display and <code>/openWdir</code>
to open the Working Directory.</p>
<table class="filesT">
<tr>
<td>&lt;working directory&gt;</td>
<td></td>
</tr>
<tr>
2015-08-10 21:25:24 +02:00
<td>|-- sounds</td>
<td class="fileCommentFolder">[Folder] Sound files</td>
</tr>
<tr>
2015-08-10 21:25:24 +02:00
<td>|&nbsp; &nbsp;|-- &lt;sound&gt;.wav</td>
<td class="fileComment">.wav files</td>
</tr>
<tr>
2015-08-10 21:25:24 +02:00
<td>|-- img</td>
<td class="fileCommentFolder">[Folder] Image files for custom usericons</td>
</tr>
<tr>
2015-08-10 21:25:24 +02:00
<td>|&nbsp;&nbsp;&nbsp;|--&nbsp;&lt;various&nbsp;images&gt;</td>
<td class="fileComment">.png files</td>
</tr>
<tr>
<td>|-- JIntellitype.dll</td>
<td class="fileComment">DLL for global hotkey support</td>
</tr>
</table>
2015-08-10 21:25:24 +02:00
<h3>JAR Location</h3>
<p>This is where the Chatty.jar is located and is used for loading libraries
that Chatty uses.</p>
<h2><a name="backup">Backup</a></h2>
<p>Chatty performs an automatic backup (enabled by default) everytime it is
started (if at least the number of days as defined in the settings have passed,
by default one). It copies the setting files (except login) to the backup folder
in the settings directory, increasing the numbering of the files with every
backup. It only makes as many backups as defined in the settings and then
starts over with the first number, rotating the files.</p>
<p>This is supposed to make recovery of settings easier in case they are not
read or written correctly and thus lost (which shouldn't usually
happen). In that case you can manually copy/rename the lost files from
a backup (just looks for the most recent one based on the change date
that looks fine).</p>
<p><em>If some settings are important to you this can help, but you
shouldn't rely on it. Always make your own backups, best on a
different device!</em></p>
2015-08-10 21:25:24 +02:00
<h3>Restore backup</h3>
<p>If you lost your setting files (or some of them) but still have
a backup, you can manually copy the backup to restore it.</p>
<ol>
<li>Prepare & Locate Backup Folder
<ul>
<li>Make sure Chatty is not running. Settings are saved when
Chatty is closed, so if you change setting files manually
while it is running your manual changes would just be
overwritten once you close Chatty.</li>
<li>Enter <code>/openBackupDir</code> to open the Backup folder
(or enter <code>/dir</code> and navigate to the Backup folder
manually).</li>
<li>There should be several files in the format <code>backup_x_&lt;name&gt;</code>,
these represent the separate batches of backups.</li>
</ul>
</li>
<li>Find latest backup and rename
<ul>
<li>Sort the files by modification date in your file browser and
choose the latest batch that seems like it might work (e.g.
files that are not 0KB, although the addressbook might be if
you never used it).</li>
<li>Rename the files you want to restore from <code>backup_x_&lt;name&gt;</code>
to <code>&lt;name&gt;</code> (for example <code>backup_2_settings</code>
to <code>settings</code>). You can ignore the <code>backup_meta</code> file.</li>
</ul>
</li>
<li>Move renamed files
<ul>
<li>Copy or move the renamed files to the parent folder (the one
you get from <code>/dir</code> or <code>/openDir</code> commands),
overwriting any existing setting files.</li>
</ul>
</li>
<li>After you are done, start Chatty again and the settings
should be restored.</li>
</ol>
</body>
</html>