Note on RLTK
You can find the original C++ project here: [https://github.com/thebracket/rltk](https://github.com/thebracket/rltk).
-To use this, you will want to have a working `Rust` and `Cargo` setup. On Windows, [rustup](https://rustup.rs/) should get you going.
-
-If you'd like to see a functional roguelike that uses `rltk_rs`, check out [Rusty Roguelike](https://github.com/thebracket/rustyroguelike). It was built for the 2019 */r/roguelikedev does the complete roguelike tutorial* event, and implements the [TCOD Tutorial](http://rogueliketutorials.com/tutorials/tcod/) - but using RLTK. It started out as the home of this project, which was then spun off into a separate crate.
+> **Note**: `rltk_rs` is now a wrapper for `bracket-lib`. It maps all namespaces to work with the old `rltk` and `rltk::prelude` namespaces, including renaming `BTerm` and `BTermBuilder` for you. The Roguelike tutorial compiles unchanged with it.
You can read a tutorial series on writing a Roguelike with this library at: [http://bfnightly.bracketproductions.com/rustbook/](http://bfnightly.bracketproductions.com/rustbook/)
-## A note on 0.6.0: it breaks things, but I feel it's worth it.
-
-If you want to keep your code-base as-is, lock your version in `cargo.toml` to `0.5.17`. You can do this with:
-
-```toml
-[dependencies]
-rltk = "=0.5.17"
-```
-
-It's worth upgrading, however:
-
-* There's fixes for "sticky" ctrl/alt/shift modifiers (and you can now read them as a key - thanks to `bofh69`).
-* The `BaseMap2D` and `Algorithm2D` systems have been overhauled to require considerably less type casting in actual use. All of the traits that refer to a tile index now return a `usize` rather than an `i32`. That eliminates a whole class of `idx as usize` casting in most client code. Unfortunately, it will require that you update your code to match.
-* `Algorithm2D` now supports a `dimensions` function, returning a `Point`. (`fn dimensions(&self) -> Point`). If you implement this, the rest of the trait can automatically implement `point2d_to_index`, `index_to_point2d` and `in_bounds` for you - so long as you're okay with my preferred array striding (2D array, rows of X values). If you don't like it, you can implement them and use your preferred storage scheme.
-* Likewise, the path-finding functions that previously returned `i32` indices now return `usize`.
-* There's a bunch of `try_into` added into various functions to relax the types they require. I believe this needs one of the newer Rust setups, so make sure you update the language.
-* I've updated all the examples to use the new scheme. The [Roguelike Tutorial](http://bfnightly.bracketproductions.com/rustbook/) has also been updated to work with the new setup.
-
-0.6.1 additionally renamed the "specs" feature to `ecs` and the "serialization" feature `serde` in accordance with guidelines.
-
## Running the examples
The examples use Cargo's built-in support for example code. E.g. To run example 1, enter: `cargo run --example ex01-helloworld`.
