A minimal CLI launcher for the Toontown Rewritten MMORPG. Inspired by Shticker Book Rewritten.
Currently only built to support GNU/Linux, because I don’t know much about Windows NT nor about macOS. If you know something about either of those platforms and want to help out, feel very free to submit a PR or to file an issue with a description of what can be done to support the platform(s).
You can get pre-compiled binaries from the releases page on GitHub.
Requires a distribution of Rust/cargo, which you can get from rustup.
bash
cargo install shticker_book_unwritten
If you already have a version installed and want the latest version to replace it, you can run:
bash
cargo install -f shticker_book_unwritten
Requires a distribution of Rust/cargo, which you can get from rustup.
bash
git clone https://github.com/JonathanHelianthicusDoe/shticker_book_unwritten.git
cd shticker_book_unwritten
cargo rustc --release -- -C target-cpu=native # Or just `cargo build --release`
strip ./target/release/shticker_book_unwritten # Optional
./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).
shticker_book_unwritten uses #![forbid(unsafe_code)], so it should (barring
compiler bugs) be impossible for actual undefined
behavior to occur unless
some dependency of shticker_book_unwritten is written using unsafe code in
an unsound way. However, although
shticker_book_unwritten is written intentionally to avoid
panicking for any reason
whatsoever, it is not (in general) possible in Rust to statically
guarantee that a program is
panic-free for all possible
inputs.
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 and/or submit a pull request 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.
This entire work (including this document & all associated source code) is licensed to anyone under the terms of the GNU Affero General Public License, version 3 (or any higher version, at your option). For the relevant legal text, see the LICENSE file.
This work contains (Rust-ified) code from bsdiff 4.3, which is licensed under a slightly modified version of the FreeBSD license. For the relevant legal text, see the 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 (or any higher version, at your option). For the relevant legal text, see https://creativecommons.org/licenses/by-sa/4.0/legalcode, or the img/LICENSE.imgs file for a plaintext version.
