From b65e6af93adad301f0d04f462400736408d9ec63 Mon Sep 17 00:00:00 2001 From: MeexReay Date: Thu, 17 Apr 2025 00:41:55 +0300 Subject: [PATCH 1/4] todo in args --- src/config.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/config.rs b/src/config.rs index 7a6aed2..40c711a 100644 --- a/src/config.rs +++ b/src/config.rs @@ -151,6 +151,8 @@ pub fn get_config_path() -> PathBuf { config_dir.join("config.yml") } + +// TODO: make args exactly match to config except --config-path and --configure, example: change from `disable_formatting: bool` to `formatting: Option`` #[derive(Parser, Debug)] #[command(version, about, long_about = None)] pub struct Args { From 08c8a259660a92cabe2179c61a89935af2c969c7 Mon Sep 17 00:00:00 2001 From: MeexReay Date: Thu, 17 Apr 2025 00:43:50 +0300 Subject: [PATCH 2/4] oops --- src/config.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/config.rs b/src/config.rs index 40c711a..5b17689 100644 --- a/src/config.rs +++ b/src/config.rs @@ -152,7 +152,7 @@ pub fn get_config_path() -> PathBuf { } -// TODO: make args exactly match to config except --config-path and --configure, example: change from `disable_formatting: bool` to `formatting: Option`` +// TODO: make args exactly match to config except --config-path and --configure, example: change from `disable_formatting: bool` to `formatting: Option` #[derive(Parser, Debug)] #[command(version, about, long_about = None)] pub struct Args { From ee86ec8cfeda658e8b8fa56d7345a1a411ecc7a6 Mon Sep 17 00:00:00 2001 From: MeexReay <127148610+MeexReay@users.noreply.github.com> Date: Thu, 17 Apr 2025 20:05:59 +0300 Subject: [PATCH 3/4] Update README.md --- README.md | 98 ++++++++++++------------------------------------------- 1 file changed, 20 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index d6b841d..b435124 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,14 @@ better RAC client ## features - gtk4 GUI -- cheat commands (type /help) -- no ip and date visible -- uses TOR proxy server by default (meex.lol:11234) -- plays sound when users receive your messages -- coloring usernames by their clients (CRAB, clRAC, Mefidroniy, etc) -- configurable message format +- fancy TUI version - RACv1.99.x and RACv2.0 compatible +- chat commands (type /help) +- no ip and date visible for anyone +- uses TOR proxy server by default (meex.lol:11234) +- coloring usernames by their clients (CRAB, clRAC, Mefidroniy, etc) +- many command-line options (--help) +- rich configuration (--config-path to get file path and --configure to edit) - RACS compatible (--enable-ssl or in --configure enable SSL) - chunked reading messages @@ -38,24 +39,13 @@ git clone https://github.com/MeexReay/bRAC.git cd bRAC ``` -3. Build or run with Cargo +3. Run with Cargo ```bash -cargo build -r # build release (target/release/bRAC) -cargo run -r # run (builds and runs bRAC itself) -``` +cargo run -r # run GUI version +cargo run -r --no-default-features -F tui # run TUI version +cargo run -r --no-default-features # run minimal version -TUI version: - -```bash -cargo build -r --no-default-features -F tui -cargo run -r --no-default-features -F tui -``` - -Minimal version: - -```bash -cargo build -r --no-default-features -cargo run -r --no-default-features +# change "cargo run" to "cargo build" to just build (target/release/bRAC) ``` ### nix package @@ -63,69 +53,21 @@ cargo run -r --no-default-features If you have Nix package manager installed, you can use: ```bash -nix build github:MeexReay/bRAC # build binary (result/bin/bRAC) -nix run github:MeexReay/bRAC # run (builds and runs bRAC) +nix run github:MeexReay/bRAC # run GUI version +nix run github:MeexReay/bRAC#bRAC-tui # run TUI version +nix run github:MeexReay/bRAC#bRAC-minimal # run minimal version + +# change "nix run" to "nix build" to just build (result/bin/bRAC) ``` -Minimal version: - -```bash -nix build github:MeexReay/bRAC#bRAC-minimal -nix run github:MeexReay/bRAC#bRAC-minimal -``` - -TUI version: - -```bash -nix build github:MeexReay/bRAC#bRAC-tui -nix run github:MeexReay/bRAC#bRAC-tui -``` - -## default config - -get config path - `bRAC --config-path` \ -reconfigure client - `bRAC --configure` - -```yml -host: meex.lol:11234 # server host -name: null # user name (null - ask every time) -message_format: 리㹰<{name}> {text} # message format -update_time: 50 # update chat interval -max_messages: 200 # chat messages limit -enable_ip_viewing: true # enable users' ip viewing -disable_ip_hiding: false # disable your ip hiding -enable_auth: true # enable auth-mode -enable_ssl: false # enable ssl connection -enable_chunked: true # enable chunked reading -``` - -## command-line options - -``` --p, --config-path Print config path --H, --host Use specified host --n, --name Use specified name --F, --message-format Use specified message format --r, --read-messages Print unformatted messages from chat and exit --s, --send-message Send unformatted message to chat and exit --f, --disable-formatting Disable message formatting and sanitizing --c, --disable-commands Disable slash commands --i, --disable-ip-hiding Disable ip hiding --v, --enable-users-ip-viewing Enable users IP viewing --C, --configure Configure client --a, --enable-auth Enable authentication --S, --enable-ssl Enable SSL --u, --enable-chunked Enable chunked reading --h, --help Print help --V, --version Print version -``` - -## cheat commands +## chat commands commands are any messages that start with a slash `/` \ messages starting with a slash are sent to chat only if the `--disable-commands` option is specified - `/help` - show help message +- `/register password` - try to register account +- `/login password` - login to account - `/clear` - clear chat - `/spam *args` - spam with text - `/ping` - get server ping (send + read) From 7af3cd11f392372c6255affb220f38659bfd8ec7 Mon Sep 17 00:00:00 2001 From: MeexReay <127148610+MeexReay@users.noreply.github.com> Date: Thu, 17 Apr 2025 20:11:06 +0300 Subject: [PATCH 4/4] brac logo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b435124..eaeca79 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# bRAC +# ![logo](https://raw.githubusercontent.com/MeexReay/bRAC/refs/heads/main/logo.gif)