https://github.com/jonathanhelianthicusdoe/shticker_book_unwritten
Minimal CLI launcher for the Toontown Rewritten MMORPG
https://github.com/jonathanhelianthicusdoe/shticker_book_unwritten
agpl agpl-v3 cli cli-app command-line gnu-linux launcher linux minimal minimalist mmorpg rust rust-lang shticker-book toontown toontown-rewritten toontownrewritten ttr
Last synced: 2 months ago
JSON representation
Minimal CLI launcher for the Toontown Rewritten MMORPG
- Host: GitHub
- URL: https://github.com/jonathanhelianthicusdoe/shticker_book_unwritten
- Owner: JonathanHelianthicusDoe
- License: gpl-3.0
- Created: 2019-09-07T18:25:14.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-24T12:27:58.000Z (over 1 year ago)
- Last Synced: 2024-04-24T18:42:11.868Z (over 1 year ago)
- Topics: agpl, agpl-v3, cli, cli-app, command-line, gnu-linux, launcher, linux, minimal, minimalist, mmorpg, rust, rust-lang, shticker-book, toontown, toontown-rewritten, toontownrewritten, ttr
- Language: Rust
- Homepage: https://crates.io/crates/shticker_book_unwritten
- Size: 346 KB
- Stars: 13
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shticker\_book\_unwritten
[](https://crates.io/crates/shticker_book_unwritten)
[](./LICENSE)
[](https://github.com/rust-secure-code/safety-dance/)
[](https://github.com/JonathanHelianthicusDoe/shticker_book_unwritten)
A minimal [CLI](https://en.wikipedia.org/wiki/Command-line_interface) launcher
for the [Toontown Rewritten](https://www.toontownrewritten.com/)
[MMORPG][mmorpg]. Inspired by [Shticker Book
Rewritten](https://github.com/madsciencecoder/Shticker-Book-Rewritten).
Currently builds and functions on GNU/Linux, Windows NT (using the MSVC
toolchain), and macOS (be sure to allow Terminal the ability to monitor
inputs).
**Mirror:**
## Installing
### From pre-compiled binary
You can get pre-compiled binaries from [the releases page][releases] on GitHub.
### From [crates\.io](https://crates.io/)
Requires a distribution of [Rust](https://www.rust-lang.org/)/cargo, which you
can get from [rustup](https://rustup.rs/).
`cargo install` works as normal. Linux users may opt into the use of a [Secret
Service](https://specifications.freedesktop.org/secret-service-spec/latest/)
keyring (e\.g. [KWallet](https://en.wikipedia.org/wiki/KWallet), [GNOME
Keyring](https://en.wikipedia.org/wiki/GNOME_Keyring), etc.) to save account
details by enabling the relevant feature flag with `-Fsecret-store`. If
you’ve already a version installed, and want to replace it with the
latest version, use `-f`.
Typically:
```bash
cargo install -Fsecret-store -f shticker_book_unwritten
```
### From GitHub git repository
Requires a distribution of [Rust](https://www.rust-lang.org/)/cargo, which you
can get from [rustup](https://rustup.rs/).
```bash
git clone https://github.com/JonathanHelianthicusDoe/shticker_book_unwritten.git
cd shticker_book_unwritten
cargo rustc -Fsecret-store --release -- -C target-cpu=native # Or just `cargo build -Fsecret-store --release`
./target/release/shticker_book_unwritten --help
```
The executable name is quite lengthy, so you will probably want to alias it (to
`sbu`, or something like that).
## Password management
When not on Linux, and/or when shticker\_book\_unwritten is built with the
default features, stored passwords are stored **in plain text** on your
filesystem. To avoid this security hazard, you may…:
- …Compile with `-Fsecret-store`, if on Linux. In this case,
shticker\_book\_unwritten will use your [Secret
Service](https://specifications.freedesktop.org/secret-service-spec/latest/)
keyring (e\.g. [KWallet](https://en.wikipedia.org/wiki/KWallet), [GNOME
Keyring](https://en.wikipedia.org/wiki/GNOME_Keyring), etc.).
- …Not use shticker\_book\_unwritten to store passwords, and instead use
a separate [password manager](https://en.wikipedia.org/wiki/Password_manager)
app.
By default, when not provided with a config file, shticker\_book\_unwritten
will ask you whether you want your passwords to be saved. Nonetheless, if
you’re uncertain, and you want to ensure that shticker\_book\_unwritten
is not managing any of your passwords, then you may:
1. Use shticker\_book\_unwritten’s command mode to run
`accounts savepws false`.
2. Use `accounts` to list all saved accounts.
3. Use `accounts forget` for each individual account that has an associated
password.
## Panicking
shticker\_book\_unwritten uses `#![forbid(unsafe_code)]`, so it should (barring
compiler bugs) be impossible for actual [undefined
behavior](https://en.wikipedia.org/wiki/Undefined_behavior) to occur unless
some dependency of shticker\_book\_unwritten is written using `unsafe` code in
an [unsound](https://en.wikipedia.org/wiki/Soundness) way. However, although
shticker\_book\_unwritten is written intentionally to avoid
[panicking](https://doc.rust-lang.org/std/macro.panic.html) for any reason
whatsoever, it is not (in general) possible in Rust to [statically
guarantee](https://en.wikipedia.org/wiki/Rice%27s_theorem) that a program is
[panic-free for all possible
inputs](https://en.wikipedia.org/wiki/Partial_function#Total_function).
If you find a way to make shticker\_book\_unwritten panic, **that is considered
a bug**, and you should [file an issue against the GitHub repository][issues]
and/or [submit a pull request][pulls] to fix it. Additionally, undefined
behavior is (obviously) also a bug, so similar steps should be taken if you
find UB, but that will necessarily require using external libraries in a
different way due to them being broken and/or fixing those external libraries
upstream.
## Legal
This entire work (including this document & all associated source code) is
licensed to anyone under the terms of the [GNU General Public License, version
3](https://www.gnu.org/licenses/gpl-3.0.html) (or any later version of the same
license, at the licensee’s option). For the relevant legal text, see the
[LICENSE](./LICENSE) file.
[](https://www.gnu.org/licenses/gpl-3.0.html)
This work contains ([Rust](https://www.rust-lang.org/)-ified) code from [bsdiff
4.3](http://www.daemonology.net/bsdiff/), which is licensed under a slightly
modified version of [the FreeBSD
license](https://www.freebsd.org/copyright/freebsd-license.html). For the
relevant legal text, see the [LICENSE.bsdiff4](./LICENSE.bsdiff4) file.
The shticker\_book\_unwritten logo is licensed to anyone under the terms of the
[Creative Commons Attribution-ShareAlike license, version
4.0](https://creativecommons.org/licenses/by-sa/4.0/) (or any later version of
the same license, at the licensee’s option). For the relevant legal text,
see [https://creativecommons.org/licenses/by-sa/4.0/legalcode][cc-by-sa], or
the [img/LICENSE.imgs](img/LICENSE.imgs) file for a plaintext version.
[](https://creativecommons.org/licenses/by-sa/4.0/)
Versions of shticker\_book\_unwritten prior to 1.0.0 were licensed under
the terms of the [GNU Affero General Public License, version
3](https://www.gnu.org/licenses/agpl-3.0.html) or later.
[mmorpg]: https://en.wikipedia.org/wiki/Massively_multiplayer_online_role-playing_game
[releases]: https://github.com/JonathanHelianthicusDoe/shticker_book_unwritten/releases
[issues]: https://github.com/JonathanHelianthicusDoe/shticker_book_unwritten/issues
[pulls]: https://github.com/JonathanHelianthicusDoe/shticker_book_unwritten/pulls
[cc-by-sa]: https://creativecommons.org/licenses/by-sa/4.0/legalcode
[cargo-deny]: https://github.com/EmbarkStudios/cargo-deny