-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
16 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,20 @@ | ||
# RustCON | ||
![rust-logo](https://img.shields.io/badge/Rust-2018-red?logo=rust) | ||
![license](https://img.shields.io/github/license/cblanken/rustcon?label=License) | ||
|
||
RustCON is an [RCON](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) client written in Rust for game server administration. | ||
|
||
|
||
## Installation | ||
```console | ||
$ cargo install rustcon | ||
``` | ||
|
||
## Usage | ||
TODO: binary usage / argument description | ||
|
||
## Demo | ||
TODO: gif demo using client | ||
|
||
## Feature goals | ||
- [x] Authentication | ||
- [x] Send/receive commands | ||
- [x] Basic RCON command prompt | ||
- [ ] Correctly receive large (4096+ B) packets that are split | ||
- [ ] Maintain command history | ||
- [ ] Configs | ||
- [x] Optionally read password from RCON_PASS env variable | ||
- [ ] Provide autocomplete | ||
- [ ] Robust Error Handling | ||
- [x] Re-ask for password when getting invalid auth response | ||
- [x] Handle invalid password and command inputs | ||
- [x] Automatcially retry lost connection | ||
- [ ] Signal handling (Ctrl+c) etc. | ||
- [ ] TUI | ||
- [x] CLI | ||
- [ ] Help menu | ||
- [ ] Description / more info popup | ||
- [ ] Autofill | ||
- [ ] Autocomplete | ||
- [ ] Commands | ||
- [ ] Subcommands | ||
- [ ] Users | ||
## License | ||
All files MIT © Cameron Blankenkenbuehler per the [license](./LICENSE.md). |