From a8b6641b53dd5789846131548567b9d569357348 Mon Sep 17 00:00:00 2001 From: Jafea7 Date: Wed, 2 Apr 2025 20:52:37 +1100 Subject: [PATCH] Typos, new defaults, minor updates --- common/src/main/java/ctbrec/Settings.java | 4 ++-- common/src/main/resources/docs/ConfigurationFile.md | 6 +++--- common/src/main/resources/docs/QuestionsAndAnswers.md | 6 ++++-- common/src/main/resources/docs/RunningTheServer.md | 6 +++--- common/src/main/resources/docs/header.html | 2 +- 5 files changed, 13 insertions(+), 11 deletions(-) diff --git a/common/src/main/java/ctbrec/Settings.java b/common/src/main/java/ctbrec/Settings.java index 8a5e2167..71e29fe4 100644 --- a/common/src/main/java/ctbrec/Settings.java +++ b/common/src/main/java/ctbrec/Settings.java @@ -121,7 +121,7 @@ public class Settings { public List modelsIgnored = new ArrayList<>(); public boolean monitorClipboard = false; public int onlineCheckIntervalInSecs = 60; - public boolean onlineCheckSkipsPausedModels = false; + public boolean onlineCheckSkipsPausedModels = true; public int overviewUpdateIntervalInSecs = 10; @Deprecated public String password = ""; @@ -153,7 +153,7 @@ public class Settings { public String recordingsTableSortColumn = ""; public String recordingsTableSortType = ""; public String recordingsDir = System.getProperty("user.home") + File.separator + "ctbrec"; - public DirectoryStructure recordingsDirStructure = DirectoryStructure.FLAT; + public DirectoryStructure recordingsDirStructure = DirectoryStructure.ONE_PER_MODEL; public List recordLater = new ArrayList<>(); public boolean recordSingleFile = false; public long recordUntilDefaultDurationInMinutes = 24 * 60L; diff --git a/common/src/main/resources/docs/ConfigurationFile.md b/common/src/main/resources/docs/ConfigurationFile.md index c78d76a7..f5f80245 100644 --- a/common/src/main/resources/docs/ConfigurationFile.md +++ b/common/src/main/resources/docs/ConfigurationFile.md @@ -43,7 +43,7 @@ ignored. This is a collection of the most interesting values: - **httpUserAgent** - The user agent, which is used in the HTTP header, when ctbrec connects to a camsite. This is used to disguise, that it actually is a recording software :) -- **httpUserAgentMobile** - Same as *httpUserAgent*, but in s0me cases we have to pretend to be a mobile phone :) +- **httpUserAgentMobile** - Same as *httpUserAgent*, but in some cases we have to pretend to be a mobile phone :) - **key** - Key for the HMAC based authentication. If this is set in server config and contains values, the HMAC authentication is automatically active. @@ -75,8 +75,8 @@ ignored. This is a collection of the most interesting values: - **recordingsDir** - Where ctbrec saves the recordings. -- **recordingsDirStructure** (server only) - [`FLAT`, `ONE_PER_MODEL`, `ONE_PER_RECORDING`] How recordings are stored in the file system. `FLAT` - all - recordings in one directory; `ONE_PER_MODEL` - one directory per model; `ONE_PER_RECORDING` - each recordings ends up in its own directory. Change this only, +- **recordingsDirStructure** (server only) - [`FLAT`, `ONE_PER_MODEL`, `ONE_PER_GROUP`, `ONE_PER_RECORDING`] How recordings are stored in the file system. `FLAT` - all + recordings in one directory; `ONE_PER_MODEL` - one directory per model; `ONE_PER_GROUP` - one directory per model group; `ONE_PER_RECORDING` - each recordings ends up in its own directory. Change this only, if you have `recordSingleFile` set to `true` - **recordSingleFile** (server only) - [`true`,`false`] - How recordings are stored in the file system. `true` means, each recording is saved in one large diff --git a/common/src/main/resources/docs/QuestionsAndAnswers.md b/common/src/main/resources/docs/QuestionsAndAnswers.md index de5d7f80..79247648 100644 --- a/common/src/main/resources/docs/QuestionsAndAnswers.md +++ b/common/src/main/resources/docs/QuestionsAndAnswers.md @@ -8,7 +8,7 @@ them, but you have to figure it out yourself. To convert the files to another format, you have to remux them. You don't have to reencode them, since the files (usually, have not seen an exception yet) already contain H.264 video and AAC audio. You can remux the files manually with tools like [Avidemux](Avidemux.md), [MKVToolNix](MKVToolNix.md) or -[FFmpeg](FFmpeg.md) or use one of the [post-processing](PostProcessing.md) scripts. +[FFmpeg](FFmpeg.md) or use the `remux/transcode` step in [post-processing](PostProcessing.md). #### Streams are not getting recorded even though the model is online @@ -24,6 +24,8 @@ Use one of the following players: - [mpv](https://mpv.io/installation/) - [VLC](https://www.videolan.org/vlc/) +Enable hardware acceleration in your player otherwise playback may lag. + #### How can I playback the server recordings? Use one of the following players: @@ -47,7 +49,7 @@ exists. #### It takes a long time until a recording starts for a model You probably have a lot of models in the "Recording" list. CTB Recorder checks the models one after the other. This is done on -purpose to not fire too many requests in a short amount of time, because this can cause blocks by the camsites. +purpose to not fire too many requests in a short amount of time because this can cause blocks by the camsites. #### Can I run several instances of CTB Recorder diff --git a/common/src/main/resources/docs/RunningTheServer.md b/common/src/main/resources/docs/RunningTheServer.md index 76adc2e5..00fb4349 100644 --- a/common/src/main/resources/docs/RunningTheServer.md +++ b/common/src/main/resources/docs/RunningTheServer.md @@ -7,11 +7,11 @@ If you expose the server to the internet, I highly recommend enabling authentica The archive you downloaded contains a `server.bat` or `server.sh`, which can be used to start the server. On the first start, the server uses a default configuration. Once you terminate the server by pressing ctrl + c, the config is stored in your user home. -On Windows that is `C:\Users\{your user name}\AppData\Roaming\ctbrec\server.json` +On Windows that is `C:\Users\{your user name}\AppData\Roaming\ctbrec\\server.json` -On Linux it is `~/.config/ctbrec/server.json` +On Linux it is `~/.config/ctbrec//server.json` -On macOS it is `/Users/{your user name}/Library/Preferences/ctbrec` +On macOS it is `/Users/{your user name}/Library/Preferences/ctbrec//server.json` You can open this file in a text editor and change it to your likings. You probably only want to change `httpPort` and `recordingsDir`. Most of the other stuff is irrelevant since the server and CTB Recorder use the same config file format. When the server is running, you can connect to it with CTB Recorder by changing the setting "Record location" to "Remote". diff --git a/common/src/main/resources/docs/header.html b/common/src/main/resources/docs/header.html index 22b8146c..6f0c6b45 100644 --- a/common/src/main/resources/docs/header.html +++ b/common/src/main/resources/docs/header.html @@ -47,7 +47,7 @@ -