Formatting and cleanup

Yudi
2019-11-16 17:06:40 -03:00
parent 5fde065f07
commit 9dfbdb6116

@@ -1,26 +1,33 @@
# General
### I can't find my Token
The steps to find your Token are [here](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs). If your token is disappearing before you're able to copy it, [try this instead](https://github.com/Tyrrrz/DiscordChatExporter/issues/76#issuecomment-412349261).
Check the following page:
* [Obtaining Token](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs)
### Where are the 'Channel IDs'?
The steps to find Channel IDs are [here](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs).
Check the following page:
* [Obtaining Channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs)
### How do I run this tool on Mac/Linux?
You can find the instructions to run DiscordChatExporter on [macOS here](https://github.com/Tyrrrz/DiscordChatExporter/wiki/macOS-usage-instructions), and on [Linux here](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Linux-usage-instructions).
Check the following pages:
* [macOS usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/macOS-usage-instructions)
* [Linux usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Linux-usage-instructions)
### How do I set DCE to export automatically at certain times?
You can find the instructions on how to schedule **DiscordChatExporter CLI** runs on [Windows here](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Scheduling-exports-on-Windows), on [macOS here](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Scheduling-exports-on-macOS), and on [Linux here](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Scheduling-exports-with-Mono-&-Crontab).
Check the following pages to learn how to schedule **DiscordChatExporter.CLI** runs:
* [Windows scheduling](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Scheduling-exports-on-Windows)
* [macOS scheduling](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Scheduling-exports-on-macOS)
* [Linux scheduling](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Scheduling-exports-with-Mono-&-Crontab)
### It crashes/fails
Please check the version of your .NET Framework:<br/>
Windows 7 - 'Control Panel > Programs and Features'<br/>
Windows 10 - 'Start > Settings > Apps > Apps & Features'<br/>
Or [follow alternative instructions here](https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed).
Please **check the version of your .NET Framework**:<br/>
* **Windows 7** - 'Control Panel > Programs and Features'<br/>
* **Windows 10** - 'Start > Settings > Apps > Apps & Features'<br/>
* Or [follow alternative instructions here](https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed).
If your **.NET Framework is older than 4.6**, [please upgrade](https://dotnet.microsoft.com/download/dotnet-framework).
<br/>
If your **.NET is older than 4.6**, [please upgrade](https://dotnet.microsoft.com/download/dotnet-framework).
<br/>
If your .**NET is up-to-date**, please check if the solution to your problem is on this page.
If your .**NET Framework is up-to-date**, please check if the solution to your problem is on this page.
### System.OutOfMemoryException
Try using date ranges or partitioning. (Issue [#125](https://github.com/Tyrrrz/DiscordChatExporter/issues/125))
@@ -28,27 +35,18 @@ Try using date ranges or partitioning. (Issue [#125](https://github.com/Tyrrrz/D
# CLI
### How do I use the CLI?
Just run the CLI with the `-h` parameter when you need help, it should output the usage instructions:
```
DiscordChatExporter.Cli.exe -h
```
Check the following page:
* [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-the-cli).
If you're using Docker, please refer to the [Docker Usage Instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions).
### How do I export to TXT, CSV or Light HTML?
The file format can be changed with the `-f` option. The available formats are PlainText, HtmlDark, HtmlLight and Csv.
### How can I change the date format?
Date formats can be changed with the `--dateformat` option. The default one is `dd-MMM-yyyy hh:mm tt`.
<br/>
More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
If you're using **Docker**, please refer to the [Docker Usage Instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions).
### I can't find Docker exported chats
Please refer to the [Docker Usage Instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions#file-output)
Check the following page:
* [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions#file-output)
### Option '-b' parse error: could not parse 'BOTTOKEN' to 'System.Boolean'
`-b` does not require a value, it just tells that the token is a bot token. The correct usage is:
```
```powershell
DiscordChatExporter.Cli.exe export -t BOTTOKEN -b -c CHANNEL
```
@@ -58,8 +56,11 @@ Run `su` on Terminal, then `adduser USER sudo`, replacing `USER` with your usern
### Mono command not found
If you're trying to execute Mono within a script on macOS, make sure you include the PATH variable.
<br/>
Adding `PATH=/Library/Frameworks/Mono.framework/Versions/Current/bin/:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin` before the command should solve this.
Adding the following text before the command should solve this:
```
PATH=/Library/Frameworks/Mono.framework/Versions/Current/bin/:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
```
### Unhandled Exception
```
@@ -67,7 +68,7 @@ Unhandled Exception:
DiscordChatExporter.Core.Exceptions.HttpErrorStatusCodeException: Error HTTP status code: Unauthorized - UNAUTHORIZED
...
```
Make sure the token is correct. If it is a bot token, don't forget to use `-b`.
Make sure the token is correct. If it is a bot token, don't forget to use `-b`.
<br/>
@@ -76,7 +77,7 @@ Unhandled Exception:
System.ArgumentOutOfRangeException: Specified argument was out of the range of valid values.
...
```
Make sure the arguments and the options (-t, -b, -c...) are correct.
Make sure the arguments and the options (-t, -b, -c...) are correct.
<br/>
The command should be like:
@@ -88,7 +89,17 @@ The command should be like:
Unhandled Exception:
System.TypeLoadException: Could not load type of field 'DiscordChatExporter.Cli.Program+<>c__DisplayClass1_0:container' (0) due to: Could not load file or assembly 'Stylet ...
```
The `Stylet.dll` file is missing. Keep the `.exe` and the `.dll` files together. If you didn't move the `.exe`, try unzipping again.
The `Stylet.dll` file is missing. Keep the `.exe` and the `.dll` files together. If you didn't move the `.exe`, try unzipping again.
<br/>
```
Unhandled Exception:
System.MissingMethodException: Method 'System.Net.Logging.get_Http' not found.
...
```
↳ Make sure Mono is correctly installed if you're running [macOS](https://github.com/Tyrrrz/DiscordChatExporter/wiki/macOS-usage-instructions) or [Linux](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Linux-usage-instructions).
<br/>
@@ -97,7 +108,7 @@ Unhandled Exception:
System.Net.WebException: Error: TrustFailure ... Invalid certificate received from server.
...
```
Try running cert-sync.
Try running cert-sync.
<br/>
Debian/Ubuntu: `cert-sync /etc/ssl/certs/ca-certificates.crt`
<br/>
@@ -107,17 +118,6 @@ If it still doesn't work, try mozroots: `mozroots --import --ask-remove`
<br/>
Further reading: [(3) Verify Installation](https://www.mono-project.com/download/stable/#download-lin).
<br/>
```
Unhandled Exception:
System.MissingMethodException: Method 'System.Net.Logging.get_Http' not found.
...
```
Make sure Mono is correctly installed if you're running [macOS](https://github.com/Tyrrrz/DiscordChatExporter/wiki/macOS-usage-instructions) or [Linux](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Linux-usage-instructions).
***
If the solution to your problem isn't here and it's not a [known issue](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue), please [open a new issue](https://github.com/Tyrrrz/DiscordChatExporter/issues/new).