Compare commits

..

19 Commits

Author SHA1 Message Date
e88d64ff63 Bump to version 0.1.0 -> 0.2.0
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2022-10-18 09:39:54 +02:00
3ca6c43c9a Add additional routes for the future clients of SeaBattle 2022-10-18 09:34:26 +02:00
d4223be8b4 Improve test 2022-10-18 09:24:08 +02:00
83d0780954 Add a route to get default rules 2022-10-18 09:17:15 +02:00
6be3eae863 Clear terminal before returning to main menu
All checks were successful
continuous-integration/drone/push Build is passing
2022-10-18 09:13:59 +02:00
c763a24ca9 Can press 'Esc' key to close windows 2022-10-18 09:11:08 +02:00
10c099e03b Handle connection errors in a better way 2022-10-18 09:04:25 +02:00
eea2ecbf63 Add version check system 2022-10-18 08:58:36 +02:00
915426849b Rename variable 2022-10-18 08:13:25 +02:00
be454cce03 Update READMEs
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2022-10-17 20:29:41 +02:00
a91a4c5ef6 Improve READMEs
All checks were successful
continuous-integration/drone/push Build is passing
2022-10-17 20:25:19 +02:00
02477e6728 Specify crate version
Some checks reported errors
continuous-integration/drone/push Build was killed
2022-10-17 19:18:13 +02:00
e389b59ab9 Add information to crates 2022-10-17 19:16:16 +02:00
dfaa5ce30b Rename crate 2022-10-17 19:13:16 +02:00
cf1d77f445 Fix appearance issues of game maps
All checks were successful
continuous-integration/drone/push Build is passing
2022-10-17 19:04:27 +02:00
0280daf6d2 Fix appearance issues
All checks were successful
continuous-integration/drone/push Build is passing
2022-10-17 19:00:13 +02:00
38656661b4 Fix appearance issues
All checks were successful
continuous-integration/drone/push Build is passing
2022-10-17 18:54:03 +02:00
5b228de285 Fix issue on rematch request screen 2022-10-17 18:49:52 +02:00
d8f96f732a Can play using invites 2022-10-17 18:47:33 +02:00
35 changed files with 581 additions and 140 deletions

View File

@@ -1,5 +1,17 @@
# SeaBattle
[![Build Status](https://drone.communiquons.org/api/badges/pierre/SeaBattle/status.svg)](https://drone.communiquons.org/pierre/SeaBattle)
Full stack sea battle game.
Current status: working on backend, and then building web ui...
## Implementations
Current implementations:
- [x] Rust shell implementations ([server](rust/sea_battle_backend) and [client](rust/sea_battle_cli_player))
- [ ] web implementation
- [ ] mobile implementation
## Screenshots
### Shell implementation
![Shell implementation example](rust/sea_battle_cli_player/img/SeaBattleCli.png)

134
rust/Cargo.lock generated
View File

@@ -421,9 +421,9 @@ dependencies = [
[[package]]
name = "clap"
version = "4.0.15"
version = "4.0.16"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6bf8832993da70a4c6d13c581f4463c2bdda27b9bf1c5498dc4365543abe6d6f"
checksum = "2ef582e2c00a63a0c0aa1fb4a4870781c4f5729f51196d3537fa7c1c1992eaa3"
dependencies = [
"atty",
"bitflags",
@@ -456,31 +456,6 @@ dependencies = [
"os_str_bytes",
]
[[package]]
name = "cli_player"
version = "0.1.0"
dependencies = [
"clap",
"crossterm",
"env_logger",
"futures",
"hostname",
"hyper-rustls",
"lazy_static",
"log",
"num",
"num-derive",
"num-traits",
"rustls",
"sea_battle_backend",
"serde_json",
"serde_urlencoded",
"textwrap",
"tokio",
"tokio-tungstenite",
"tui",
]
[[package]]
name = "codespan-reporting"
version = "0.11.1"
@@ -965,6 +940,7 @@ dependencies = [
"futures-channel",
"futures-core",
"futures-util",
"h2",
"http",
"http-body",
"httparse",
@@ -1044,6 +1020,12 @@ dependencies = [
"serde",
]
[[package]]
name = "ipnet"
version = "2.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "879d54834c8c76457ef4293a689b2a8c59b076067ad77b15efafbb05f92a592b"
[[package]]
name = "itoa"
version = "1.0.4"
@@ -1446,6 +1428,45 @@ version = "0.6.27"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a3f87b73ce11b1619a3c6332f45341e0047173771e8b8b73f87bfeefb7b56244"
[[package]]
name = "reqwest"
version = "0.11.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "431949c384f4e2ae07605ccaa56d1d9d2ecdb5cadd4f9577ccfab29f2e5149fc"
dependencies = [
"base64",
"bytes",
"encoding_rs",
"futures-core",
"futures-util",
"h2",
"http",
"http-body",
"hyper",
"hyper-rustls",
"ipnet",
"js-sys",
"log",
"mime",
"once_cell",
"percent-encoding",
"pin-project-lite",
"rustls",
"rustls-pemfile",
"serde",
"serde_json",
"serde_urlencoded",
"tokio",
"tokio-rustls",
"tower-service",
"url",
"wasm-bindgen",
"wasm-bindgen-futures",
"web-sys",
"webpki-roots",
"winreg",
]
[[package]]
name = "ring"
version = "0.16.20"
@@ -1543,7 +1564,7 @@ dependencies = [
[[package]]
name = "sea_battle_backend"
version = "0.1.0"
version = "0.2.0"
dependencies = [
"actix",
"actix-cors",
@@ -1555,6 +1576,7 @@ dependencies = [
"futures",
"log",
"rand",
"semver",
"serde",
"serde_json",
"serde_urlencoded",
@@ -1564,6 +1586,32 @@ dependencies = [
"uuid",
]
[[package]]
name = "sea_battle_cli_player"
version = "0.2.0"
dependencies = [
"clap",
"crossterm",
"env_logger",
"futures",
"hostname",
"hyper-rustls",
"lazy_static",
"log",
"num",
"num-derive",
"num-traits",
"reqwest",
"rustls",
"sea_battle_backend",
"serde_json",
"serde_urlencoded",
"textwrap",
"tokio",
"tokio-tungstenite",
"tui",
]
[[package]]
name = "security-framework"
version = "2.7.0"
@@ -2111,6 +2159,18 @@ dependencies = [
"wasm-bindgen-shared",
]
[[package]]
name = "wasm-bindgen-futures"
version = "0.4.33"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "23639446165ca5a5de86ae1d8896b737ae80319560fbaa4c2887b7da6e7ebd7d"
dependencies = [
"cfg-if",
"js-sys",
"wasm-bindgen",
"web-sys",
]
[[package]]
name = "wasm-bindgen-macro"
version = "0.2.83"
@@ -2160,6 +2220,15 @@ dependencies = [
"untrusted",
]
[[package]]
name = "webpki-roots"
version = "0.22.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "368bfe657969fb01238bb756d351dcade285e0f6fcbd36dcb23359a5169975be"
dependencies = [
"webpki",
]
[[package]]
name = "winapi"
version = "0.3.9"
@@ -2234,6 +2303,15 @@ version = "0.36.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c811ca4a8c853ef420abd8592ba53ddbbac90410fab6903b3e79972a631f7680"
[[package]]
name = "winreg"
version = "0.10.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "80d0f4e272c85def139476380b12f9ac60926689dd2e01d4923222f40580869d"
dependencies = [
"winapi",
]
[[package]]
name = "zstd"
version = "0.11.2+zstd.1.5.2"

View File

@@ -2,5 +2,5 @@
members = [
"sea_battle_backend",
"cli_player"
"sea_battle_cli_player"
]

View File

@@ -1,12 +1,18 @@
[package]
name = "sea_battle_backend"
version = "0.1.0"
version = "0.2.0"
edition = "2021"
license = "GPL-2.0-or-later"
description = "A Sea Battle game backend server"
repository = "https://gitea.communiquons.org/pierre/SeaBattle"
readme = "README.md"
authors = ["Pierre Hubert <pierre.git@communiquons.org>"]
categories = [ "games" ]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
clap = { version = "4.0.15", features = ["derive"] }
clap = { version = "4.0.16", features = ["derive"] }
log = "0.4.17"
env_logger = "0.9.0"
serde = { version = "1.0.145", features = ["derive"] }
@@ -20,6 +26,7 @@ uuid = { version = "1.1.2", features = ["v4"] }
rand = "0.8.5"
serde_with = "2.0.1"
tokio = { version = "1", features = ["full"] }
semver = "1.0.14"
[dev-dependencies]
#reqwest = { version = "0.11.11", default-features = false, features = ["json", "rustls-tls"] }

View File

@@ -0,0 +1,30 @@
# Sea battle backend
[![Build Status](https://drone.communiquons.org/api/badges/pierre/SeaBattle/status.svg)](https://drone.communiquons.org/pierre/SeaBattle)
[![Crate](https://img.shields.io/crates/v/sea_battle_backend.svg)](https://crates.io/crates/sea_battle_backend)
[![Documentation](https://docs.rs/sea_battle_backend/badge.svg)](https://docs.rs/sea_battle_backend/)
A backend HTTP server for the Sea Battle game. The binary included in
this crate can be used to deploy a server that will allow players to
connect to play together.
The `actix-web` library is used to spawn HTTP server. The games are encapsulated
inside websockets.
An official server is running at https://seabattleapi.communiquons.org/
## Installation
You can install the backend using the following command:
```bash
cargo install sea_battle_backend
```
## Usage
```bash
sea_battle_backend -l 0.0.0.0:7000
```
> Note: a reverse-proxy must be used to protect
## Client
A command-line client is available in the [sea_battle_cli_player](https://crates.io/crates/sea_battle_cli_player) crate.

View File

@@ -12,3 +12,14 @@ pub struct Args {
#[clap(short, long, value_parser)]
pub cors: Option<String>,
}
#[cfg(test)]
mod test {
use crate::args::Args;
#[test]
fn verify_cli() {
use clap::CommandFactory;
Args::command().debug_assert()
}
}

View File

@@ -1,5 +1,8 @@
//! # Project constants
pub const MIN_REQUIRED_VERSION: &str = "0.1.0";
pub const CURRENT_VERSION: &str = env!("CARGO_PKG_VERSION");
pub const MIN_BOATS_NUMBER: usize = 1;
pub const MAX_BOATS_NUMBER: usize = 10;

View File

@@ -361,7 +361,7 @@ impl BoatsLayout {
mod test {
use crate::data::boats_layout::{BoatDirection, BoatPosition, BoatsLayout, Coordinates};
use crate::data::game_map::GameMap;
use crate::data::{BotType, GameRules, PlayConfiguration, PrintableMap};
use crate::data::*;
#[test]
fn dist_coordinates_eq() {
@@ -488,9 +488,7 @@ mod test {
map_height: 5,
boats_str: "1,1".to_string(),
boats_can_touch: false,
player_continue_on_hit: false,
strike_timeout: None,
bot_type: BotType::Random,
..Default::default()
};
let mut boats = BoatsLayout(vec![

View File

@@ -4,6 +4,7 @@ pub use game_map::*;
pub use game_rules::*;
pub use play_config::*;
pub use printable_map::*;
pub use version::*;
mod boats_layout;
mod current_game_status;
@@ -11,3 +12,4 @@ mod game_map;
mod game_rules;
mod play_config;
mod printable_map;
mod version;

View File

@@ -0,0 +1,32 @@
//! # Version Info
//!
//! Contains server version requirements information
use crate::consts;
use crate::utils::res_utils::Res;
use semver::Version;
#[derive(serde::Serialize, serde::Deserialize)]
pub struct VersionInfo {
current: String,
min_required: String,
}
impl VersionInfo {
pub fn load_static() -> Self {
Self {
current: consts::CURRENT_VERSION.to_string(),
min_required: consts::MIN_REQUIRED_VERSION.to_string(),
}
}
/// Check if builtin version is compatible with a remote version or not
pub fn is_compatible_with_static_version(&self) -> Res<bool> {
let static_version = Self::load_static();
let local_current = Version::parse(&static_version.current)?;
let min_required = Version::parse(&self.min_required)?;
Ok(min_required <= local_current)
}
}

View File

@@ -4,7 +4,7 @@ use actix_web::{web, App, HttpRequest, HttpResponse, HttpServer, Responder};
use actix_web_actors::ws;
use crate::args::Args;
use crate::data::{GameRules, PlayConfiguration};
use crate::data::{BoatsLayout, GameRules, PlayConfiguration, VersionInfo};
use crate::dispatcher_actor::DispatcherActor;
use crate::human_player_ws::{HumanPlayerWS, StartMode};
@@ -18,11 +18,45 @@ async fn not_found() -> impl Responder {
HttpResponse::NotFound().json("You missed your strike lol")
}
/// Get bot configuration
/// Get version information
async fn version_information() -> impl Responder {
HttpResponse::Ok().json(VersionInfo::load_static())
}
/// Get game configuration
async fn game_configuration() -> impl Responder {
HttpResponse::Ok().json(PlayConfiguration::default())
}
/// Get default game rules
async fn default_game_rules() -> impl Responder {
HttpResponse::Ok().json(GameRules::random_players_rules())
}
/// Validate game rules
async fn validate_game_rules(rules: web::Json<GameRules>) -> impl Responder {
HttpResponse::Ok().json(rules.get_errors())
}
/// Generate random boats layout
async fn gen_boats_layout(rules: web::Json<GameRules>) -> impl Responder {
let errors = rules.get_errors();
if !errors.is_empty() {
return HttpResponse::BadRequest().json(errors);
}
match BoatsLayout::gen_random_for_rules(&rules) {
Ok(l) => HttpResponse::Ok().json(l),
Err(e) => {
log::error!(
"Failed to generate boats layout for valid game rules: {} ! / Rules: {:?}",
e,
rules
);
HttpResponse::InternalServerError().json("Failed to generate random layout!")
}
}
}
#[derive(serde::Serialize, serde::Deserialize, Eq, PartialEq, Debug)]
pub struct BotPlayQuery {
#[serde(flatten)]
@@ -130,6 +164,7 @@ async fn start_random(
log::info!("New random play");
resp
}
pub async fn start_server(args: Args) -> std::io::Result<()> {
log::info!("Start to listen on {}", args.listen_address);
@@ -148,7 +183,11 @@ pub async fn start_server(args: Args) -> std::io::Result<()> {
App::new()
.app_data(web::Data::new(dispatcher_actor.clone()))
.wrap(cors)
.route("/version", web::get().to(version_information))
.route("/config", web::get().to(game_configuration))
.route("/game_rules/default", web::get().to(default_game_rules))
.route("/game_rules/validate", web::post().to(validate_game_rules))
.route("/generate_boats_layout", web::post().to(gen_boats_layout))
.route("/play/bot", web::get().to(start_bot_play))
.route("/play/create_invite", web::get().to(start_create_invite))
.route("/play/accept_invite", web::get().to(start_accept_invite))

View File

@@ -1,13 +1,19 @@
[package]
name = "cli_player"
version = "0.1.0"
name = "sea_battle_cli_player"
version = "0.2.0"
edition = "2021"
license = "GPL-2.0-or-later"
description = "A Sea Battle game shell client"
repository = "https://gitea.communiquons.org/pierre/SeaBattle"
readme = "README.md"
authors = ["Pierre Hubert <pierre.git@communiquons.org>"]
categories = [ "games" ]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
sea_battle_backend = { path = "../sea_battle_backend" }
clap = { version = "4.0.15", features = ["derive"] }
sea_battle_backend = { path = "../sea_battle_backend", version = "0.2.0" }
clap = { version = "4.0.16", features = ["derive"] }
log = "0.4.17"
env_logger = "0.9.0"
tui = "0.19.0"
@@ -24,4 +30,5 @@ futures = "0.3.23"
serde_json = "1.0.85"
hostname = "0.3.1"
rustls = "0.20.6"
hyper-rustls = { version = "0.23.0", features = ["rustls-native-certs"] }
hyper-rustls = { version = "0.23.0", features = ["rustls-native-certs"] }
reqwest = { version = "0.11", features = ["json", "rustls-tls"], default-features = false }

View File

@@ -0,0 +1,41 @@
# Sea battle cli player
[![Build Status](https://drone.communiquons.org/api/badges/pierre/SeaBattle/status.svg)](https://drone.communiquons.org/pierre/SeaBattle)
[![Crate](https://img.shields.io/crates/v/sea_battle_cli_player.svg)](https://crates.io/crates/sea_battle_cli_player)
[![Documentation](https://docs.rs/sea_battle_cli_player/badge.svg)](https://docs.rs/sea_battle_cli_player/)
![](img/SeaBattleCli.png)
A sea battle shell client player for the [sea_battle_backend](https://crates.io/crates/sea_battle_backend) crate, based on the [tui](https://crates.io/crates/tui) library.
## Available play modes
* 🤖 Play against bot (this mode does not require any Internet connection, a local server is automatically spawn)
* 🎲 Play against a random player
* Create play invite (online). In this mode, the server returns an invitation code to give to the opponent
* 🎫 Accept play invite (online)
For the 🤖 bot and create invite modes, game rules can be customized before starting the game.
## Installation
You can install the backend using the following command:
```bash
cargo install sea_battle_cli_player
```
## Usage
Simply launch using:
```bash
sea_battle_cli_player
```
## Offline LAN
If you want to run a local server to play offline LAN games, the cli player can also act as the server:
```bash
RUST_LOG=info sea_battle_cli_player -s -l 0.0.0.0:7000
```
Then all the players must specify the address of this server to use it instead of the default official one:
```bash
sea_battle_cli_player -r http://IP_OF_TARGET:7000
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

View File

@@ -20,7 +20,7 @@ pub struct CliArgs {
value_parser,
default_value = "https://seabattleapi.communiquons.org"
)]
pub remote_server_uri: String,
pub remote_server: String,
/// Local server listen address
#[clap(short, long, default_value = "127.0.0.1:5679")]
@@ -61,3 +61,14 @@ lazy_static::lazy_static! {
pub fn cli_args() -> &'static CliArgs {
&ARGS
}
#[cfg(test)]
mod test {
use crate::cli_args::CliArgs;
#[test]
fn verify_cli() {
use clap::CommandFactory;
CliArgs::command().debug_assert()
}
}

View File

@@ -3,10 +3,13 @@ use crate::server;
use futures::stream::{SplitSink, SplitStream};
use futures::{SinkExt, StreamExt};
use hyper_rustls::ConfigBuilderExt;
use sea_battle_backend::data::GameRules;
use sea_battle_backend::data::*;
use sea_battle_backend::human_player_ws::{ClientMessage, ServerMessage};
use sea_battle_backend::server::{BotPlayQuery, PlayRandomQuery};
use sea_battle_backend::server::{
AcceptInviteQuery, BotPlayQuery, CreateInviteQuery, PlayRandomQuery,
};
use sea_battle_backend::utils::res_utils::{boxed_error, Res};
use std::error::Error;
use std::fmt::Display;
use std::sync::mpsc::TryRecvError;
use std::sync::{mpsc, Arc};
@@ -16,6 +19,11 @@ use tokio_tungstenite::{MaybeTlsStream, WebSocketStream};
type WsStream = WebSocketStream<MaybeTlsStream<TcpStream>>;
pub enum GetRemoteVersionError {
ConnectionFailed,
Other(Box<dyn Error>),
}
/// Connection client
///
/// This structure acts as a wrapper around websocket connection that handles automatically parsing
@@ -26,6 +34,24 @@ pub struct Client {
}
impl Client {
/// Get remote server version
pub async fn get_server_version() -> Result<VersionInfo, GetRemoteVersionError> {
let url = format!("{}/version", cli_args().remote_server);
log::debug!("Getting remote information from {} ...", url);
let res = match reqwest::get(url).await {
Ok(r) => r,
Err(e) if e.is_timeout() || e.is_connect() => {
return Err(GetRemoteVersionError::ConnectionFailed)
}
Err(e) => return Err(GetRemoteVersionError::Other(Box::new(e))),
};
res.json()
.await
.map_err(|e| GetRemoteVersionError::Other(Box::new(e)))
}
/// Start to play against a bot
///
/// When playing against a bot, local server is always used
@@ -49,7 +75,7 @@ impl Client {
/// Start to play against a random player
pub async fn start_random_play<D: Display>(player_name: D) -> Res<Self> {
Self::connect_url(
&cli_args().remote_server_uri,
&cli_args().remote_server,
&format!(
"/play/random?{}",
serde_urlencoded::to_string(&PlayRandomQuery {
@@ -61,6 +87,38 @@ impl Client {
.await
}
/// Start a play by creating an invite
pub async fn start_create_invite<D: Display>(rules: &GameRules, player_name: D) -> Res<Self> {
Self::connect_url(
&cli_args().remote_server,
&format!(
"/play/create_invite?{}",
serde_urlencoded::to_string(&CreateInviteQuery {
rules: rules.clone(),
player_name: player_name.to_string()
})
.unwrap()
),
)
.await
}
/// Start a play by accepting an invite
pub async fn start_accept_invite<D: Display>(code: String, player_name: D) -> Res<Self> {
Self::connect_url(
&cli_args().remote_server,
&format!(
"/play/accept_invite?{}",
serde_urlencoded::to_string(&AcceptInviteQuery {
code,
player_name: player_name.to_string()
})
.unwrap()
),
)
.await
}
/// Do connect to a server, returning
async fn connect_url(server: &str, uri: &str) -> Res<Self> {
let mut ws_url = server.replace("http", "ws");

View File

@@ -2,7 +2,7 @@ extern crate core;
pub mod cli_args;
pub mod client;
pub mod constants;
pub mod consts;
pub mod server;
pub mod ui_screens;
pub mod ui_widgets;

View File

@@ -12,18 +12,22 @@ use env_logger::Env;
use tui::backend::{Backend, CrosstermBackend};
use tui::Terminal;
use cli_player::cli_args::{cli_args, TestDevScreen};
use cli_player::client::Client;
use cli_player::server::run_server;
use cli_player::ui_screens::configure_game_rules::GameRulesConfigurationScreen;
use cli_player::ui_screens::game_screen::GameScreen;
use cli_player::ui_screens::input_screen::InputScreen;
use cli_player::ui_screens::popup_screen::PopupScreen;
use cli_player::ui_screens::select_play_mode_screen::{SelectPlayModeResult, SelectPlayModeScreen};
use cli_player::ui_screens::*;
use sea_battle_backend::consts::{MAX_PLAYER_NAME_LENGTH, MIN_PLAYER_NAME_LENGTH};
use sea_battle_backend::consts::{
INVITE_CODE_LENGTH, MAX_PLAYER_NAME_LENGTH, MIN_PLAYER_NAME_LENGTH,
};
use sea_battle_backend::data::GameRules;
use sea_battle_backend::utils::res_utils::Res;
use sea_battle_cli_player::cli_args::{cli_args, TestDevScreen};
use sea_battle_cli_player::client::{Client, GetRemoteVersionError};
use sea_battle_cli_player::server::run_server;
use sea_battle_cli_player::ui_screens::configure_game_rules::GameRulesConfigurationScreen;
use sea_battle_cli_player::ui_screens::game_screen::GameScreen;
use sea_battle_cli_player::ui_screens::input_screen::InputScreen;
use sea_battle_cli_player::ui_screens::popup_screen::PopupScreen;
use sea_battle_cli_player::ui_screens::select_play_mode_screen::{
SelectPlayModeResult, SelectPlayModeScreen,
};
use sea_battle_cli_player::ui_screens::*;
/// Test code screens
async fn run_dev<B: Backend>(
@@ -31,10 +35,10 @@ async fn run_dev<B: Backend>(
d: TestDevScreen,
) -> Result<(), Box<dyn Error>> {
let res = match d {
TestDevScreen::Popup => popup_screen::PopupScreen::new("Welcome there!!")
TestDevScreen::Popup => PopupScreen::new("Welcome there!!")
.show(terminal)?
.as_string(),
TestDevScreen::Input => input_screen::InputScreen::new("What it your name ?")
TestDevScreen::Input => InputScreen::new("What it your name ?")
.set_title("A custom title")
.show(terminal)?
.as_string(),
@@ -46,9 +50,9 @@ async fn run_dev<B: Backend>(
TestDevScreen::SelectBotType => select_bot_type_screen::SelectBotTypeScreen::default()
.show(terminal)?
.as_string(),
TestDevScreen::SelectPlayMode => select_play_mode_screen::SelectPlayModeScreen::default()
.show(terminal)?
.as_string(),
TestDevScreen::SelectPlayMode => {
SelectPlayModeScreen::default().show(terminal)?.as_string()
}
TestDevScreen::SetBoatsLayout => {
let rules = GameRules {
boats_can_touch: true,
@@ -60,7 +64,7 @@ async fn run_dev<B: Backend>(
.as_string()
}
TestDevScreen::ConfigureGameRules => {
configure_game_rules::GameRulesConfigurationScreen::new(GameRules::default())
GameRulesConfigurationScreen::new(GameRules::default())
.show(terminal)?
.as_string()
}
@@ -72,8 +76,8 @@ async fn run_dev<B: Backend>(
))?
}
/// Ask the user to specify its username
fn query_username<B: Backend>(terminal: &mut Terminal<B>) -> Res<String> {
/// Ask the user to specify the name he should be identified with
fn query_player_name<B: Backend>(terminal: &mut Terminal<B>) -> Res<String> {
let mut hostname = hostname::get()?.to_string_lossy().to_string();
if hostname.len() > MAX_PLAYER_NAME_LENGTH {
hostname = hostname[0..MAX_PLAYER_NAME_LENGTH].to_string();
@@ -95,44 +99,99 @@ async fn run_app<B: Backend>(terminal: &mut Terminal<B>) -> Res {
return run_dev(terminal, d).await;
}
let mut checked_online_compatibility = false;
let mut rules = GameRules::default();
let mut username = "".to_string();
loop {
terminal.clear()?;
let choice = SelectPlayModeScreen::default().show(terminal)?;
if let ScreenResult::Ok(c) = choice {
if c.need_user_name() && username.is_empty() {
username = query_username(terminal)?;
// Check compatibility
if c.is_online_play_mode() && !checked_online_compatibility {
PopupScreen::new("🖥 Checking remote server version...").show_once(terminal)?;
let valid_version = match Client::get_server_version().await {
Ok(v) => v.is_compatible_with_static_version().unwrap_or(false),
Err(GetRemoteVersionError::ConnectionFailed) => {
PopupScreen::new("❌ Could not connect to remote server!")
.show(terminal)?;
continue;
}
Err(GetRemoteVersionError::Other(e)) => {
log::error!("Could not load remote server information! {:?}", e);
false
}
};
if !valid_version {
PopupScreen::new("❌ Unfortunately, it seems that your version of Sea Battle Cli player is too old to be used online...\n\nPlease update it before trying to play online...").show(terminal)?;
continue;
}
checked_online_compatibility = true;
}
if c.need_player_name() && username.is_empty() {
username = query_player_name(terminal)?;
}
if c.need_custom_rules() {
rules = match GameRulesConfigurationScreen::new(rules.clone()).show(terminal)? {
ScreenResult::Ok(r) => r,
ScreenResult::Canceled => continue,
}
}
}
PopupScreen::new("🔌 Connecting...").show_once(terminal)?;
let client = match choice {
ScreenResult::Ok(SelectPlayModeResult::PlayRandom) => {
PopupScreen::new("Connecting...").show_once(terminal)?;
Client::start_random_play(&username).await?
Client::start_random_play(&username).await
}
// Play against bot
ScreenResult::Ok(SelectPlayModeResult::PlayAgainstBot) => {
// First, ask for custom rules
rules = match GameRulesConfigurationScreen::new(rules.clone()).show(terminal)? {
ScreenResult::Ok(r) => r,
ScreenResult::Canceled => continue,
Client::start_bot_play(&rules).await
}
// Create invite
ScreenResult::Ok(SelectPlayModeResult::CreateInvite) => {
Client::start_create_invite(&rules, &username).await
}
// Join invite
ScreenResult::Ok(SelectPlayModeResult::AcceptInvite) => {
let code = match InputScreen::new("Invite code")
.set_min_length(INVITE_CODE_LENGTH)
.set_max_length(INVITE_CODE_LENGTH)
.show(terminal)?
.value()
{
None => continue,
Some(v) => v,
};
// Then connect to server
PopupScreen::new("Connecting...").show_once(terminal)?;
Client::start_bot_play(&rules).await?
PopupScreen::new("🔌 Connecting...").show_once(terminal)?;
Client::start_accept_invite(code, &username).await
}
ScreenResult::Canceled | ScreenResult::Ok(SelectPlayModeResult::Exit) => return Ok(()),
};
// Display game screen
GameScreen::new(client).show(terminal).await?;
match client {
Ok(client) => {
// Display game screen
GameScreen::new(client).show(terminal).await?;
}
Err(e) => {
log::error!("Failed to connect to server: {}", e);
PopupScreen::new("❌ Failed to connect to server!").show(terminal)?;
}
};
}
}

View File

@@ -16,7 +16,7 @@ use tui::{Frame, Terminal};
use sea_battle_backend::data::GameRules;
use crate::constants::{HIGHLIGHT_COLOR, TICK_RATE};
use crate::consts::{HIGHLIGHT_COLOR, TICK_RATE};
use crate::ui_screens::popup_screen::show_screen_too_small_popup;
use crate::ui_screens::select_bot_type_screen::SelectBotTypeScreen;
use crate::ui_screens::utils::centered_rect_size;
@@ -63,13 +63,13 @@ impl GameRulesConfigurationScreen {
.checked_sub(last_tick.elapsed())
.unwrap_or_else(|| Duration::from_secs(0));
if crossterm::event::poll(timeout)? {
if event::poll(timeout)? {
let mut cursor_pos = self.curr_field as i32;
if let Event::Key(key) = event::read()? {
match key.code {
// Quit app
KeyCode::Char('q') => return Ok(ScreenResult::Canceled),
KeyCode::Char('q') | KeyCode::Esc => return Ok(ScreenResult::Canceled),
// Navigate between fields
KeyCode::Up | KeyCode::Left => cursor_pos -= 1,
@@ -189,7 +189,9 @@ impl GameRulesConfigurationScreen {
let area = centered_rect_size(w, h, &f.size());
let block = Block::default().title("Game rules").borders(Borders::ALL);
let block = Block::default()
.title("📓 Game rules")
.borders(Borders::ALL);
f.render_widget(block, area);
let chunks = Layout::default()

View File

@@ -9,7 +9,7 @@ use tui::text::*;
use tui::widgets::*;
use tui::{Frame, Terminal};
use crate::constants::*;
use crate::consts::*;
use crate::ui_screens::utils::centered_rect_size;
use crate::ui_screens::ScreenResult;
use crate::ui_widgets::button_widget::ButtonWidget;
@@ -18,6 +18,7 @@ use crate::ui_widgets::button_widget::ButtonWidget;
pub fn confirm<B: Backend>(terminal: &mut Terminal<B>, msg: &str) -> bool {
matches!(
ConfirmDialogScreen::new(msg)
.set_can_escape(true)
.show(terminal)
.unwrap_or(ScreenResult::Canceled),
ScreenResult::Ok(true)
@@ -28,7 +29,7 @@ pub struct ConfirmDialogScreen<'a> {
title: &'a str,
msg: &'a str,
is_confirm: bool,
can_cancel: bool,
can_escape: bool,
}
impl<'a> ConfirmDialogScreen<'a> {
@@ -37,10 +38,15 @@ impl<'a> ConfirmDialogScreen<'a> {
title: "Confirmation Request",
msg,
is_confirm: true,
can_cancel: false,
can_escape: false,
}
}
pub fn set_can_escape(mut self, v: bool) -> Self {
self.can_escape = v;
self
}
pub fn show<B: Backend>(
mut self,
terminal: &mut Terminal<B>,
@@ -56,7 +62,7 @@ impl<'a> ConfirmDialogScreen<'a> {
if event::poll(timeout)? {
if let Event::Key(key) = event::read()? {
match key.code {
KeyCode::Esc | KeyCode::Char('q') if self.can_cancel => {
KeyCode::Esc | KeyCode::Char('q') if self.can_escape => {
return Ok(ScreenResult::Canceled)
}

View File

@@ -16,11 +16,13 @@ use sea_battle_backend::utils::res_utils::Res;
use sea_battle_backend::utils::time_utils::time;
use crate::client::Client;
use crate::constants::*;
use crate::consts::*;
use crate::ui_screens::confirm_dialog_screen::confirm;
use crate::ui_screens::popup_screen::{show_screen_too_small_popup, PopupScreen};
use crate::ui_screens::set_boats_layout_screen::SetBoatsLayoutScreen;
use crate::ui_screens::utils::{centered_rect_size, centered_text};
use crate::ui_screens::utils::{
centered_rect_size, centered_rect_size_horizontally, centered_text,
};
use crate::ui_screens::ScreenResult;
use crate::ui_widgets::button_widget::ButtonWidget;
use crate::ui_widgets::game_map_widget::{ColoredCells, GameMapWidget};
@@ -53,21 +55,21 @@ impl GameStatus {
pub fn status_text(&self) -> &str {
match self {
GameStatus::Connecting => "Connecting...",
GameStatus::WaitingForAnotherPlayer => "Waiting for another player...",
GameStatus::OpponentConnected => "Opponent connected!",
GameStatus::WaitingForOpponentBoatsConfig => "Waiting for ### boats configuration",
GameStatus::OpponentReady => "### is ready!",
GameStatus::Starting => "Game is starting...",
GameStatus::MustFire => "You must fire!",
GameStatus::OpponentMustFire => "### must fire!",
GameStatus::WonGame => "You win the game!",
GameStatus::LostGame => "### wins the game. You loose.",
GameStatus::RematchRequestedByOpponent => "Rematch requested by ###",
GameStatus::RematchRequestedByPlayer => "Rematch requested by you",
GameStatus::RematchAccepted => "Rematch accepted!",
GameStatus::RematchRejected => "Rematch rejected!",
GameStatus::OpponentLeftGame => "Opponent left game!",
GameStatus::Connecting => "🔌 Connecting...",
GameStatus::WaitingForAnotherPlayer => "🕑 Waiting for another player...",
GameStatus::OpponentConnected => "Opponent connected!",
GameStatus::WaitingForOpponentBoatsConfig => "🕑 Waiting for ### boats configuration",
GameStatus::OpponentReady => "### is ready!",
GameStatus::Starting => "🕑 Game is starting...",
GameStatus::MustFire => "🚨 You must fire!",
GameStatus::OpponentMustFire => "💣 ### must fire!",
GameStatus::WonGame => "🎉 You win the game!",
GameStatus::LostGame => "😿 ### wins the game. You loose.",
GameStatus::RematchRequestedByOpponent => "Rematch requested by ###",
GameStatus::RematchRequestedByPlayer => "Rematch requested by you",
GameStatus::RematchAccepted => "Rematch accepted!",
GameStatus::RematchRejected => "Rematch rejected!",
GameStatus::OpponentLeftGame => "Opponent left game!",
}
}
}
@@ -83,10 +85,10 @@ enum Buttons {
impl Buttons {
pub fn text(&self) -> &str {
match self {
Buttons::RequestRematch => "Request rematch",
Buttons::AcceptRematch => "Accept rematch",
Buttons::RejectRematch => "Reject rematch",
Buttons::QuitGame => "Quit game",
Buttons::RequestRematch => "Request rematch",
Buttons::AcceptRematch => "Accept rematch",
Buttons::RejectRematch => "Reject rematch",
Buttons::QuitGame => "Quit game",
}
}
}
@@ -136,7 +138,7 @@ impl GameScreen {
.unwrap_or_else(|| Duration::from_secs(0));
// Handle terminal events
if crossterm::event::poll(timeout)? {
if event::poll(timeout)? {
let event = event::read()?;
// Keyboard event
@@ -145,7 +147,7 @@ impl GameScreen {
match key.code {
// Leave game
KeyCode::Char('q')
KeyCode::Char('q') | KeyCode::Esc
if confirm(terminal, "Do you really want to leave game?") =>
{
self.client.close_connection().await;
@@ -241,7 +243,7 @@ impl GameScreen {
}
ServerMessage::InvalidInviteCode => {
PopupScreen::new("Invalid invite code!").show(terminal)?;
PopupScreen::new("Invalid invite code!").show(terminal)?;
return Ok(ScreenResult::Ok(()));
}
@@ -364,6 +366,7 @@ impl GameScreen {
buttons.push(Buttons::RejectRematch);
} else if self.status != GameStatus::OpponentLeftGame
&& self.status != GameStatus::RematchRejected
&& self.status != GameStatus::RematchRequestedByPlayer
{
buttons.push(Buttons::RequestRematch);
}
@@ -475,7 +478,7 @@ impl GameScreen {
if !self.status.can_show_game_maps() {
if self.status == GameStatus::WaitingForAnotherPlayer {
if let Some(code) = &self.invite_code {
status_text.push_str(&format!("\n Invite code: {}", code));
status_text.push_str(&format!("\n\n🎫 Invite code: {}", code));
}
}
@@ -570,15 +573,17 @@ impl GameScreen {
if show_both_maps {
let maps_chunks = Layout::default()
.direction(Direction::Horizontal)
.constraints([
Constraint::Length(player_map_size.0),
Constraint::Length(3),
Constraint::Length(opponent_map_size.0),
])
.constraints([Constraint::Percentage(50), Constraint::Percentage(50)])
.split(chunks[2]);
f.render_widget(player_map, maps_chunks[0]);
f.render_widget(opponent_map, maps_chunks[2]);
f.render_widget(
player_map,
centered_rect_size_horizontally(player_map_size.0, &maps_chunks[0]),
);
f.render_widget(
opponent_map,
centered_rect_size_horizontally(opponent_map_size.0, &maps_chunks[1]),
);
} else {
// Render a single map
if self.can_fire() {

View File

@@ -10,7 +10,7 @@ use tui::layout::*;
use tui::widgets::*;
use tui::{Frame, Terminal};
use crate::constants::*;
use crate::consts::*;
use crate::ui_screens::utils::*;
use crate::ui_screens::ScreenResult;
use crate::ui_widgets::button_widget::ButtonWidget;
@@ -125,7 +125,7 @@ impl<'a> InputScreen<'a> {
fn ui<B: Backend>(&mut self, f: &mut Frame<B>) {
let area = centered_rect_size(
(self.msg.len() + 4).max(self.max_len + 4) as u16,
(self.msg.len() + 4).max(self.max_len + 4).max(25) as u16,
7,
&f.size(),
);

View File

@@ -9,7 +9,7 @@ use tui::text::*;
use tui::widgets::*;
use tui::{Frame, Terminal};
use crate::constants::*;
use crate::consts::*;
use crate::ui_screens::utils::centered_rect_size;
use crate::ui_screens::ScreenResult;
use crate::ui_widgets::button_widget::ButtonWidget;
@@ -17,7 +17,7 @@ use crate::ui_widgets::button_widget::ButtonWidget;
/// Convenience function to inform user that his terminal window is too small to display the current
/// screen
pub fn show_screen_too_small_popup<B: Backend>(f: &mut Frame<B>) {
PopupScreen::new("Screen too small!").show_in_frame(f)
PopupScreen::new("🖵 Screen too small!").show_in_frame(f)
}
pub struct PopupScreen<'a> {
@@ -52,7 +52,7 @@ impl<'a> PopupScreen<'a> {
if event::poll(timeout)? {
if let Event::Key(key) = event::read()? {
match key.code {
KeyCode::Char('q') => return Ok(ScreenResult::Canceled),
KeyCode::Char('q') | KeyCode::Esc => return Ok(ScreenResult::Canceled),
KeyCode::Enter => {
return Ok(ScreenResult::Ok(()));
}

View File

@@ -11,7 +11,7 @@ use tui::{Frame, Terminal};
use sea_battle_backend::data::{BotDescription, BotType, PlayConfiguration};
use crate::constants::{HIGHLIGHT_COLOR, TICK_RATE};
use crate::consts::{HIGHLIGHT_COLOR, TICK_RATE};
use crate::ui_screens::utils::centered_rect_size;
use crate::ui_screens::ScreenResult;
@@ -49,7 +49,7 @@ impl SelectBotTypeScreen {
if event::poll(timeout)? {
if let Event::Key(key) = event::read()? {
match key.code {
KeyCode::Char('q') => return Ok(ScreenResult::Canceled),
KeyCode::Char('q') | KeyCode::Esc => return Ok(ScreenResult::Canceled),
KeyCode::Enter => {
return Ok(ScreenResult::Ok(self.types[self.curr_selection].r#type));
}

View File

@@ -1,7 +1,7 @@
use std::io;
use std::time::{Duration, Instant};
use crate::constants::{HIGHLIGHT_COLOR, TICK_RATE};
use crate::consts::{HIGHLIGHT_COLOR, TICK_RATE};
use crate::ui_screens::utils::centered_rect_size;
use crate::ui_screens::ScreenResult;
use crossterm::event;
@@ -17,12 +17,25 @@ pub enum SelectPlayModeResult {
#[default]
PlayAgainstBot,
PlayRandom,
CreateInvite,
AcceptInvite,
Exit,
}
impl SelectPlayModeResult {
/// Specify whether a selected play mode requires a user name or not
pub fn need_user_name(&self) -> bool {
pub fn need_player_name(&self) -> bool {
self != &SelectPlayModeResult::PlayAgainstBot && self != &SelectPlayModeResult::Exit
}
/// Specify whether a selected play mode requires a the user to specify its own game rules or
/// not
pub fn need_custom_rules(&self) -> bool {
self == &SelectPlayModeResult::PlayAgainstBot || self == &SelectPlayModeResult::CreateInvite
}
/// Specify whether a play mode is to be played online or not
pub fn is_online_play_mode(&self) -> bool {
self != &SelectPlayModeResult::PlayAgainstBot && self != &SelectPlayModeResult::Exit
}
}
@@ -33,17 +46,25 @@ struct PlayModeDescription {
value: SelectPlayModeResult,
}
const AVAILABLE_PLAY_MODES: [PlayModeDescription; 3] = [
const AVAILABLE_PLAY_MODES: [PlayModeDescription; 5] = [
PlayModeDescription {
name: "Play against bot (offline)",
name: "🤖 Play against bot (offline)",
value: SelectPlayModeResult::PlayAgainstBot,
},
PlayModeDescription {
name: "Play against random player (online)",
name: "🎲 Play against random player (online)",
value: SelectPlayModeResult::PlayRandom,
},
PlayModeDescription {
name: "Exit app",
name: " Create play invite (online)",
value: SelectPlayModeResult::CreateInvite,
},
PlayModeDescription {
name: "🎫 Accept play invite (online)",
value: SelectPlayModeResult::AcceptInvite,
},
PlayModeDescription {
name: "❌ Exit app",
value: SelectPlayModeResult::Exit,
},
];
@@ -71,7 +92,7 @@ impl SelectPlayModeScreen {
if crossterm::event::poll(timeout)? {
if let Event::Key(key) = event::read()? {
match key.code {
KeyCode::Char('q') => return Ok(ScreenResult::Canceled),
KeyCode::Char('q') | KeyCode::Esc => return Ok(ScreenResult::Canceled),
KeyCode::Enter => {
return Ok(ScreenResult::Ok(
AVAILABLE_PLAY_MODES[self.curr_selection].value,
@@ -92,7 +113,7 @@ impl SelectPlayModeScreen {
}
fn ui<B: Backend>(&mut self, f: &mut Frame<B>) {
let area = centered_rect_size(50, 5, &f.size());
let area = centered_rect_size(50, 2 + AVAILABLE_PLAY_MODES.len() as u16, &f.size());
// Create a List from all list items and highlight the currently selected one
let items = AVAILABLE_PLAY_MODES

View File

@@ -12,7 +12,7 @@ use tui::{Frame, Terminal};
use sea_battle_backend::data::*;
use crate::constants::*;
use crate::consts::*;
use crate::ui_screens::confirm_dialog_screen::confirm;
use crate::ui_screens::popup_screen::show_screen_too_small_popup;
use crate::ui_screens::utils::{centered_rect_size, centered_text};
@@ -66,7 +66,7 @@ impl<'a> SetBoatsLayoutScreen<'a> {
let event = event::read()?;
if let Event::Key(key) = &event {
match key.code {
KeyCode::Char('q') => {
KeyCode::Char('q') | KeyCode::Esc => {
if !self.confirm_on_cancel
|| confirm(terminal, "Do you really want to quit?")
{

View File

@@ -46,6 +46,25 @@ pub fn centered_rect_size(width: u16, height: u16, parent: &Rect) -> Rect {
}
}
/// helper function to create a centered rect using up certain container size, only horizontally
pub fn centered_rect_size_horizontally(width: u16, parent: &Rect) -> Rect {
if parent.width < width {
return Rect {
x: parent.x,
y: parent.y,
width: parent.width,
height: parent.height,
};
}
Rect {
x: parent.x + (parent.width - width) / 2,
y: parent.y,
width,
height: parent.height,
}
}
/// Get coordinates to render centered text
pub fn centered_text(text: &str, container: &Rect) -> Rect {
if text.len() > container.width as usize {

View File

@@ -1,6 +1,6 @@
use std::fmt::Display;
use crate::constants::HIGHLIGHT_COLOR;
use crate::consts::HIGHLIGHT_COLOR;
use tui::buffer::Buffer;
use tui::layout::Rect;
use tui::style::{Color, Style};

View File

@@ -1,4 +1,4 @@
use crate::constants::HIGHLIGHT_COLOR;
use crate::consts::HIGHLIGHT_COLOR;
use std::fmt::Display;
use tui::buffer::Buffer;
use tui::layout::Rect;

View File

@@ -1,6 +1,6 @@
use std::fmt::Display;
use crate::constants::HIGHLIGHT_COLOR;
use crate::consts::HIGHLIGHT_COLOR;
use tui::buffer::Buffer;
use tui::layout::Rect;
use tui::style::*;