Skip to content

Commit

Permalink
Merge, update workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
nulldg committed Apr 28, 2024
2 parents c4bb52d + 9b3421e commit 9c6b5af
Show file tree
Hide file tree
Showing 23 changed files with 191 additions and 485 deletions.
6 changes: 1 addition & 5 deletions .docs/Dotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,8 @@ For other distros, please check the _'Install on Linux'_ menu on the left of [th
You can check which version of **.NET Runtime** is installed by running the following command in a terminal:

```console
dotnet --info
```
$ dotnet --info

If the **.NET Runtime** is correctly installed, the command will output something similar to the following:

```console
.NET runtimes installed:
Microsoft.NETCore.App 7.0.x [C:\path\to\dotnet\shared\Microsoft.NETCore.App]
Microsoft.WindowsDesktop.App 7.0.x [C:\path\to\dotnet\shared\Microsoft.WindowsDesktop.App]
Expand Down
9 changes: 3 additions & 6 deletions .docs/Getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,9 @@ The information presented on this page is valid for **all** platforms.
**DCEp** has two different versions:

- **Graphical User Interface** (**GUI**) - it's the preferred version for newcomers as it is easy to use.
You can get it by [downloading](https://github.com/nulldg/DiscordChatExporterPlus/releases/latest) the `DiscordChatExporterPlus.zip` file.
- **Command-Line Interface** (**CLI**) - offers greater flexibility and more features for advanced users, such as export scheduling, ID lists, and more specific date ranges.
You can get it by [downloading](https://github.com/nulldg/DiscordChatExporterPlus/releases/latest) the `DiscordChatExporterPlus.CLI.zip` file.

If you're not comfortable with **Windows'** Command-line (cmd), please choose the GUI.
[**macOS**](MacOS.md), [**Linux**](Linux.md) and [**Docker**](Docker.md) users can only use the CLI version.
You can get it by [downloading](https://github.com/nulldg/DiscordChatExporterPlus/releases/latest) the `DiscordChatExporterPlus.*.zip` file.
- **Command-line Interface** (**CLI**) - offers greater flexibility and more features for advanced users, such as export scheduling, ID lists, and more specific date ranges.
You can get it by [downloading](https://github.com/nulldg/DiscordChatExporterPlus/releases/latest) the `DiscordChatExporterPlus.Cli.*.zip` file.

There are dedicated guides for each version:

Expand Down
32 changes: 0 additions & 32 deletions .docs/Linux.md

This file was deleted.

34 changes: 0 additions & 34 deletions .docs/MacOS.md

This file was deleted.

6 changes: 3 additions & 3 deletions .docs/Message-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,17 +89,17 @@ from:96\-LB
In most cases, you will need to enclose your filter in quotes (`"`) to escape characters that may have special meaning in your shell:

```console
DiscordChatExporter.Cli export [...] --filter "from:Tyrrrz has:image"
$ ./DiscordChatExporterPlus.Cli export [...] --filter "from:Tyrrrz has:image"
```

If you need to include quotes inside the filter itself as well, use single quotes (`'`) for those instead:

```console
DiscordChatExporter.Cli export [...] --filter "from:Tyrrrz 'hello world'"
$ ./DiscordChatExporterPlus.Cli export [...] --filter "from:Tyrrrz 'hello world'"
```

Additionally, negated filters (those that start with `-`) may cause parsing issues even when enclosed in quotes. To avoid this, use the tilde (`~`) character instead of the dash (`-`):

```console
DiscordChatExporter.Cli export [...] --filter ~from:Tyrrrz
$ ./DiscordChatExporterPlus.Cli export [...] --filter ~from:Tyrrrz
```
3 changes: 1 addition & 2 deletions .docs/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

## Installation & Usage

- [Get .NET Core Runtime](Dotnet.md) (Required for CLI; Installed automatically for GUI)
- [Windows](Getting-started.md#gui-or-cli) | [macOS](MacOS.md) | [Linux](Linux.md) | [Docker](Docker.md)
- [Get .NET Runtime](Dotnet.md)
- Getting started:
- [Using the GUI](Using-the-GUI.md)
- [Using the CLI](Using-the-CLI.md)
Expand Down
8 changes: 4 additions & 4 deletions .docs/Scheduling-Linux.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Scheduling exports with Cron

Make sure you already have **DiscordChatExporter.CLI** and **.NET Core** properly installed ([instructions here](Linux.md)).
Make sure you already have **DiscordChatExporterPlus.CLI** downloaded and **.NET Runtime** installed.

## Creating the script

1. Open Terminal and create a new text file with `nano /path/to/DiscordChatExporter/cron.sh`
1. Open Terminal and create a new text file with `nano /path/to/DiscordChatExporterPlus/cron.sh`

> **Note**:
> You can't use your mouse in nano, use the arrow keys to control the cursor (caret).
Expand Down Expand Up @@ -45,7 +45,7 @@ fi
cd $DLLFOLDER || exit 1

# This will export your chat
dotnet DiscordChatExporter.Cli.dll export -t $TOKEN -c $CHANNELID -f $EXPORTFORMAT -o $FILENAME.tmp
./DiscordChatExporterPlus.Cli export -t $TOKEN -c $CHANNELID -f $EXPORTFORMAT -o $FILENAME.tmp

# This sets the current time to a variable
CURRENTTIME=$(date +"%Y-%m-%d-%H-%M-%S")
Expand Down Expand Up @@ -78,7 +78,7 @@ exit 0
> To save, hold down CTRL and then press O, if asked for a filename, type it and press ENTER. Hit CTRL+X to exit the text editor.
> [Check out this page](https://wiki.gentoo.org/wiki/Nano/Basics_Guide) if you want to know more about nano.
4. Make your script executable with `chmod +x /path/to/DiscordChatExporter/cron.sh`
4. Make your script executable with `chmod +x /path/to/DiscordChatExporterPlus/cron.sh`

5. Let's edit the cron file. If you want to run the script with your user privileges, edit it by running `crontab -e`. If you want to run the script as root, edit it with `sudo crontab -e`. If this is your first time running this command, you might be asked to select a text editor. Nano is easier for beginners.

Expand Down
Loading

0 comments on commit 9c6b5af

Please sign in to comment.