= UTFcrawler
image::utf-crawler.png[align="center", scalewidth="50%"]
[.align="center", cols="7*^.^"] |============================= |Language |Version |License |Platform |Pipeline
| image:https://img.shields.io/badge/rust-1.30.0-3b231b.svg?logo=rust&logoColor=rgb(247,209,187)&style=flat-square["Rust Version", link:https://blog.rust-lang.org/2018/10/25/Rust-1.30.0.html]
| image:https://img.shields.io/badge/version-0.1.1-222b0d.svg?style=flat-square[Current Version]
| image:https://img.shields.io/badge/license-ISC-1e272d.svg?style=flat-square["License", LICENSE-MIT]
| image:https://img.shields.io/badge/platform-shell-606060.svg?style=popout-square[]
| master: image:https://gitlab.com/utf-crawler/utf-crawler/badges/master/pipeline.svg[Master Pipeline]
|=============================
''' == About ''' This is a project that is designed to create an RPG game using Unicode characters as ASCII art, instead of using raw ASCII. This effectively makes the display ANSI art, rather than ASCII art.
Support for RGB colors is required for the best experience, but a plain terminal should do fine. + A monospaced font supporting a high number of Unicode characters is highly recommended, as that will allow the maps to render properly.
A QWERTY layout or similar keyboard/keymap is highly recommended for a proper experience A treminal size of 103 cols x 30 lines is recommended for the maps to display correctly.
'''
== Dependencies ''' For installation, the following dependencies are required:
rust, rustc, and cargo.
* This is supplied either via the rustup script available link:https://rustup.rs/[here].
Or it's supplied by your package managers for your Linux/Unix distro of choice.
* (It is highly recommended to unstall rust via the rustup script mentioned above.)git to fetch this repository'''
== Installation ''' ==== Compiling from Source Simple enough:
git clone \https://gitlab.com/utf-crawler/utf-crawler.gitcd utf-crawlercargo install
* Or for a more manual approach:
cargo build --release
and move/copy ./target/release to your $PATH.
** or add it to your $PATH in some form.'''
== How to Play
'''
|==============================
2+|In Dungeon
|Key |Action
|a |move left
|s |move down
|d |move right
|w |move up
2+|In Inventory
|i |switch to inventory menu
|u |use selected item
|j |move menu selection down
|k |move menu selection up
|m |switch back to the map
2+|In Combat
|a |standard attack
|s |low-level skill
|d |mid-level skill
|f |high-level skill
|g |guard
|==============================
== Licensing ''' This software is released under the link:LICENSE-ISC[ISC License]
'''