prex-aliya / rustycheckers

a small terminal based checkers game

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rusty Checkers

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
WARNING: Under Construction
\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\

image

This is a simple checkers game board written in rust for the Unix terminal, but may be ported to other terminals.

Name Pending

  1. Instillation
    1. install rust
    2. Build from source
  2. How to use
  3. Whats next

How to install rusty checkers.

It is currently not, since this is nowhere near production, in any repository, of my knowledge, and you will have to build this from scratch.

How to install rusty checkers.

installing rust

To install this program you will have to have Rust installed on your system. I suggest that you install via Rustup's convenient one liner:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

But you could just as easily download it from your distributions package manager and or by installing cargo, I bet there are other ways.

compiling

After the installation of rust, you can now compile this project. I will be demonstrating with the cargo rust compiler, now to compile you will need to run:

    cargo build --release

After which it it will save to target/release/rustycheckers.

Now you could stop here, or you could go further by moving it to your user binary file, so you do not have to navigate to this directory every time you want to use it in the terminal unaware. To accomplish this you will need to run a singular command, with the right privileges, to move or copy the binary to the correct directory.

To move it: mv target/release/rustycheckers /usr/local/bin/rustycheckers

To copy it: cp target/release/rustycheckers /usr/local/bin/rustycheckers

And now you have it, now you can play checkers in your terminal with or without you very real friends.

How to use rusty checkers.

To use rusty checkers you will first have to install it, and after that you can learn the nuances of using this terminal application.

I am not going to teach you to play the game but if you do not know you can look it up, or go here to find out.

To use the program you can move as many pieces as you want until you end your turn. To kill a piece just type its placement.

Keys

Keybindings
 Action
q Quit
h
prints out help (currently not working)
r
Reset Pieces
<SHIFT>-H
 Move Window Left
<SHIFT>-L
 Move Window In Rigth
<SHIFT>-J
 Move Window Down
<SHIFT>-K
 Move Window In Up
 1..8 move pieces col, then row
 <tab> / :
move to settings module
<enter> next turn

What To Implement.

  • Accept alphanumerics as input
  • Ability to play over a network - So needs a new function and creation functions
  • Clear binding to reset the board
  • Add help
  • Add key map show
  • Enforce Number of pieces, configurable.
  • Stop placement of pieces over or under other pieces
  • Ability to kill another piece - if piece true then false

About

a small terminal based checkers game


Languages

Language:Rust 100.0%