Skip to content

wlim33/rust-spades

Repository files navigation

Spades · MIT Licence · Build Status

Spades is a four person trick-taking card game. For the complete rules of spades, click here.

Getting Started

Add this line to your Cargo.toml:

[dependencies]
spades = "1.0"

Server Mode (NEW!)

Now includes an optional server mode for hosting multiple concurrent games via a REST API! Perfect for building web-based or multiplayer spades applications.

To run the server:

cargo run --features server --bin spades-server

See SERVER.md for complete documentation on the server API and usage.

Bidding Features

Currently allows bidding nil by placing a bet of zero (the bonus is +100 points, and penalty is -100 points), but blind bets are not yet supported.

How to use

extern crate spades;
extern crate uuid;

use spades::{Game, GameTransition};
use spades::result::{TransitionSuccess, TransitionError, GetError};

let mut g = Game::new(uuid::Uuid::new_v4(), 
        [uuid::Uuid::new_v4(), 
         uuid::Uuid::new_v4(), 
         uuid::Uuid::new_v4(), 
         uuid::Uuid::new_v4()], 
         500);

g.play(GameTransition::Start);

//Each round starts with a round of betting

assert_eq!(g.play(GameTransition::Bet(3)), TransitionSuccess::Bet);
g.play(GameTransition::Bet(4));
g.play(GameTransition::Bet(4));
g.play(GameTransition::Bet(2));

//The game is now in the card playing stage
assert_eq!(g.play(GameTransition::Bet(3)), TransitionFailure::Bet);


let hand = g.get_hand(g.current_player).clone();

let valid_card = g.last().unwrap().clone();
g.play(GameTransition::Card(valid_card));

//...

Documentation

For a complete description of the crate, check the docs.rs page.

Contributing

If there is a feature you would like to see added, please feel free to make an open an issue or pull request!

About

A popular four person card game implemented in Rust.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages