Compare commits

...

20 Commits

Author SHA1 Message Date
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
e760bcbe33 Handle better small screens
All checks were successful
continuous-integration/drone/push Build is passing
2022-10-17 09:42:24 +02:00
ccb3d36fae Complete previous test
All checks were successful
continuous-integration/drone/push Build is passing
2022-10-17 08:38:03 +02:00
fcc7f30e10 Test strike timeout 2022-10-17 08:35:49 +02:00
171c88f303 Move result structures to a more appropriate location 2022-10-17 08:24:40 +02:00
9162c5eb24 Display timeout in game UI 2022-10-17 08:21:42 +02:00
b4772aa88e Fix automatic fire 2022-10-17 08:03:13 +02:00
42b0d84f9d Implement strike timeout on server side 2022-10-17 07:59:42 +02:00
ba1ed84b33 Add strike timeout setting 2022-10-17 07:42:17 +02:00
8c1a3f2c5f Fix typo 2022-10-16 20:29:34 +02:00
25871de084 Add a message to explain why connection are closed in case of invalid player names 2022-10-16 20:23:12 +02:00
45 changed files with 548 additions and 141 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)

50
rust/Cargo.lock generated
View File

@@ -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"
@@ -1564,6 +1539,31 @@ dependencies = [
"uuid",
]
[[package]]
name = "sea_battle_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 = "security-framework"
version = "2.7.0"

View File

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

View File

@@ -2,6 +2,12 @@
name = "sea_battle_backend"
version = "0.1.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

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

@@ -24,3 +24,6 @@ pub const INVITE_CODE_LENGTH: usize = 5;
pub const MIN_PLAYER_NAME_LENGTH: usize = 1;
pub const MAX_PLAYER_NAME_LENGTH: usize = 10;
pub const MIN_STRIKE_TIMEOUT: u64 = 5;
pub const MAX_STRIKE_TIMEOUT: u64 = 90;

View File

@@ -489,6 +489,7 @@ mod test {
boats_str: "1,1".to_string(),
boats_can_touch: false,
player_continue_on_hit: false,
strike_timeout: None,
bot_type: BotType::Random,
};

View File

@@ -78,6 +78,7 @@ impl PrintableMap for PrintableCurrentGameMapStatus {
#[derive(Debug, serde::Serialize, serde::Deserialize, Clone, Default)]
pub struct CurrentGameStatus {
pub remaining_time_for_strike: Option<u64>,
pub rules: GameRules,
pub your_map: CurrentGameMapStatus,
pub opponent_map: CurrentGameMapStatus,

View File

@@ -1,6 +1,6 @@
use crate::consts::*;
use crate::data::{BotType, PlayConfiguration};
use serde_with::{serde_as, DisplayFromStr};
use serde_with::{serde_as, DisplayFromStr, NoneAsEmptyString};
#[serde_as]
#[derive(serde::Serialize, serde::Deserialize, Debug, Clone, Eq, PartialEq)]
@@ -15,6 +15,8 @@ pub struct GameRules {
pub boats_can_touch: bool,
#[serde_as(as = "DisplayFromStr")]
pub player_continue_on_hit: bool,
#[serde_as(as = "NoneAsEmptyString")]
pub strike_timeout: Option<u64>,
pub bot_type: BotType,
}
@@ -36,6 +38,7 @@ impl GameRules {
.join(","),
boats_can_touch: MULTI_PLAYER_BOATS_CAN_TOUCH,
player_continue_on_hit: MULTI_PLAYER_PLAYER_CAN_CONTINUE_AFTER_HIT,
strike_timeout: Some(30),
bot_type: BotType::Smart,
}
}
@@ -50,6 +53,11 @@ impl GameRules {
self
}
pub fn with_strike_timeout(mut self, timeout: u64) -> Self {
self.strike_timeout = Some(timeout);
self
}
/// Set the list of boats for this configuration
pub fn set_boats_list(&mut self, boats: &[usize]) {
self.boats_str = boats
@@ -121,6 +129,16 @@ impl GameRules {
}
}
if let Some(timeout) = self.strike_timeout {
if timeout < config.min_strike_timeout {
errors.push("Strike timeout is too short!");
}
if timeout > config.max_strike_timeout {
errors.push("Strike timeout is too long!");
}
}
errors
}

View File

@@ -59,6 +59,8 @@ pub struct PlayConfiguration {
pub ordinate_alphabet: &'static str,
pub min_player_name_len: usize,
pub max_player_name_len: usize,
pub min_strike_timeout: u64,
pub max_strike_timeout: u64,
}
impl Default for PlayConfiguration {
@@ -76,6 +78,8 @@ impl Default for PlayConfiguration {
ordinate_alphabet: ALPHABET,
min_player_name_len: MIN_PLAYER_NAME_LENGTH,
max_player_name_len: MAX_PLAYER_NAME_LENGTH,
min_strike_timeout: MIN_STRIKE_TIMEOUT,
max_strike_timeout: MAX_STRIKE_TIMEOUT,
}
}
}

View File

@@ -1,4 +1,5 @@
use std::sync::Arc;
use std::time::Duration;
use actix::prelude::*;
use actix::{Actor, Context, Handler};
@@ -6,6 +7,7 @@ use uuid::Uuid;
use crate::bot_player::BotPlayer;
use crate::data::*;
use crate::utils::time_utils::time;
pub trait Player {
fn get_name(&self) -> &str;
@@ -51,6 +53,9 @@ pub trait Player {
fn opponent_replaced_by_bot(&self);
}
/// How often strike timeout controller is run
const STRIKE_TIMEOUT_CONTROL: Duration = Duration::from_secs(1);
fn opponent(index: usize) -> usize {
match index {
0 => 1,
@@ -85,6 +90,7 @@ pub struct Game {
map_0: Option<GameMap>,
map_1: Option<GameMap>,
turn: usize,
curr_strike_request_started: u64,
}
impl Game {
@@ -96,6 +102,7 @@ impl Game {
map_0: None,
map_1: None,
turn: 0,
curr_strike_request_started: 0,
}
}
@@ -130,10 +137,14 @@ impl Game {
self.turn
);
self.request_fire();
self.request_fire(true);
}
fn request_fire(&self) {
fn request_fire(&mut self, reset_counter: bool) {
if reset_counter {
self.curr_strike_request_started = time();
}
self.players[self.turn].request_fire(self.get_game_status_for_player(self.turn));
self.players[opponent(self.turn)]
.opponent_must_fire(self.get_game_status_for_player(opponent(self.turn)));
@@ -148,6 +159,27 @@ impl Game {
.unwrap()
}
/// Replace user for a fire in case of timeout
fn force_fire_in_case_of_timeout(&mut self) {
if self.status != GameStatus::Started || self.rules.strike_timeout.is_none() {
return;
}
let timeout = self.rules.strike_timeout.unwrap_or_default();
if time() <= self.curr_strike_request_started + timeout {
return;
}
// Determine target of fire
let target = self
.get_game_status_for_player(self.turn)
.find_fire_coordinates_for_bot_type(self.rules.bot_type);
// Fire as player
self.handle_fire(target);
}
fn player_map_mut(&mut self, id: usize) -> &mut GameMap {
match id {
0 => self.map_0.as_mut(),
@@ -166,7 +198,7 @@ impl Game {
// Easiest case : player missed his fire
if result == FireResult::Missed {
self.turn = opponent(self.turn);
self.request_fire();
self.request_fire(true);
return;
}
@@ -188,7 +220,9 @@ impl Game {
self.turn = opponent(self.turn);
}
self.request_fire();
self.request_fire(
result != FireResult::AlreadyTargetedPosition && result != FireResult::Rejected,
);
}
fn handle_request_rematch(&mut self, player_id: Uuid) {
@@ -223,6 +257,9 @@ impl Game {
/// Get current game status for a specific player
fn get_game_status_for_player(&self, id: usize) -> CurrentGameStatus {
CurrentGameStatus {
remaining_time_for_strike: self.rules.strike_timeout.map(|v| {
((self.curr_strike_request_started + v) as i64 - time() as i64).max(0) as u64
}),
rules: self.rules.clone(),
your_map: self.player_map(id).current_map_status(false),
opponent_map: self
@@ -234,6 +271,14 @@ impl Game {
impl Actor for Game {
type Context = Context<Self>;
fn started(&mut self, ctx: &mut Self::Context) {
if self.rules.strike_timeout.is_some() {
ctx.run_interval(STRIKE_TIMEOUT_CONTROL, |act, _ctx| {
act.force_fire_in_case_of_timeout();
});
}
}
}
#[derive(Message)]
@@ -387,7 +432,7 @@ impl Handler<PlayerLeftGame> for Game {
// Re-do current action
if self.status == GameStatus::Started {
self.request_fire();
self.request_fire(true);
} else if self.status == GameStatus::WaitingForBoatsDisposition {
self.players[offline_player].query_boats_layout(&self.rules);
}

View File

@@ -152,6 +152,7 @@ impl Actor for HumanPlayerWS {
fn started(&mut self, ctx: &mut Self::Context) {
// Check player name length
if self.name.len() < MIN_PLAYER_NAME_LENGTH || self.name.len() > MAX_PLAYER_NAME_LENGTH {
log::error!("Close connection due to invalid user name!");
ctx.stop();
return;
}

View File

@@ -163,6 +163,7 @@ pub async fn start_server(args: Args) -> std::io::Result<()> {
#[cfg(test)]
mod test {
use crate::data::GameRules;
use crate::server::BotPlayQuery;
#[test]
@@ -177,4 +178,20 @@ mod test {
assert_eq!(query, des)
}
#[test]
fn simple_bot_request_serialize_deserialize_no_timeout() {
let query = BotPlayQuery {
rules: GameRules {
strike_timeout: None,
..Default::default()
},
player_name: "Player".to_string(),
};
let string = serde_urlencoded::to_string(&query).unwrap();
let des = serde_urlencoded::from_str(&string).unwrap();
assert_eq!(query, des)
}
}

View File

@@ -39,7 +39,7 @@ pub struct BotClient {
requested_rules: GameRules,
layout: Option<BoatsLayout>,
number_plays: usize,
server_msg_callback: Option<Box<dyn FnMut(&ServerMessage)>>,
server_msg_callback: Option<Box<dyn FnMut(&mut ServerMessage)>>,
play_as_bot_type: BotType,
}
@@ -81,7 +81,7 @@ impl BotClient {
pub fn with_server_msg_callback<F>(mut self, cb: F) -> Self
where
F: FnMut(&ServerMessage) + 'static,
F: FnMut(&mut ServerMessage) + 'static,
{
self.server_msg_callback = Some(Box::new(cb));
self
@@ -152,7 +152,7 @@ impl BotClient {
};
while let Some(chunk) = socket.next().await {
let message = match chunk? {
let mut message = match chunk? {
Message::Text(message) => {
log::trace!("TEXT message from server: {}", message);
@@ -182,7 +182,7 @@ impl BotClient {
};
if let Some(cb) = &mut self.server_msg_callback {
(cb)(&message)
(cb)(&mut message)
}
match message {

View File

@@ -9,7 +9,7 @@ use crate::test::play_utils::check_no_replay_on_hit;
use crate::test::{bot_client, TestPort};
use crate::utils::network_utils::wait_for_port;
fn check_strikes_are_linear(msg: &ServerMessage) {
fn check_strikes_are_linear(msg: &mut ServerMessage) {
if let ServerMessage::RequestFire { status } = msg {
let mut in_fire_location = true;
for y in 0..status.rules.map_height {

View File

@@ -1,13 +1,16 @@
use tokio::task;
use crate::args::Args;
use crate::consts::MIN_STRIKE_TIMEOUT;
use crate::data::{BoatsLayout, GameRules};
use crate::human_player_ws::ServerMessage;
use crate::server::start_server;
use crate::test::bot_client;
use crate::test::bot_client::ClientEndResult;
use crate::test::play_utils::check_no_replay_on_hit;
use crate::test::TestPort;
use crate::utils::network_utils::wait_for_port;
use crate::utils::time_utils::time;
#[tokio::test]
async fn invalid_port() {
@@ -201,3 +204,37 @@ async fn full_game_no_replay_on_hit() {
})
.await;
}
#[tokio::test]
async fn check_fire_time_out() {
let _ = env_logger::builder().is_test(true).try_init();
let local_set = task::LocalSet::new();
local_set
.run_until(async move {
task::spawn_local(start_server(Args::for_test(TestPort::RandomCheckTimeout)));
wait_for_port(TestPort::RandomCheckTimeout.port()).await;
let start = time();
let mut did_skip_one = false;
let res = bot_client::BotClient::new(TestPort::RandomCheckTimeout.as_url())
.with_rules(
GameRules::random_players_rules().with_strike_timeout(MIN_STRIKE_TIMEOUT),
)
.with_server_msg_callback(move |msg| {
if matches!(msg, ServerMessage::RequestFire { .. }) && !did_skip_one {
*msg = ServerMessage::OpponentReplacedByBot;
did_skip_one = true;
}
})
.run_client()
.await
.unwrap();
assert!(matches!(res, ClientEndResult::Finished { .. }));
assert!(time() - start >= MIN_STRIKE_TIMEOUT);
})
.await;
}

View File

@@ -10,6 +10,7 @@ enum TestPort {
RandomBotInvalidBoatsLayoutLenOfABoat,
RandomBotFullGameMultipleRematch,
RandomBotNoReplayOnHit,
RandomCheckTimeout,
LinearBotFullGame,
LinearBotNoReplayOnHit,
IntermediateBotFullGame,

View File

@@ -1,7 +1,7 @@
use crate::human_player_ws::ServerMessage;
/// Make sure player can not replay after successful hit
pub fn check_no_replay_on_hit(msg: &ServerMessage) {
pub fn check_no_replay_on_hit(msg: &mut ServerMessage) {
if let ServerMessage::OpponentMustFire { status } | ServerMessage::RequestFire { status } = msg
{
let diff =

View File

@@ -1,12 +1,4 @@
use std::error::Error;
use std::fmt::Display;
use std::io::ErrorKind;
pub mod network_utils;
pub mod res_utils;
pub mod string_utils;
pub type Res<E = ()> = Result<E, Box<dyn Error>>;
pub fn boxed_error<D: Display>(msg: D) -> Box<dyn Error> {
Box::new(std::io::Error::new(ErrorKind::Other, msg.to_string()))
}
pub mod time_utils;

View File

@@ -0,0 +1,9 @@
use std::error::Error;
use std::fmt::Display;
use std::io::ErrorKind;
pub type Res<E = ()> = Result<E, Box<dyn Error>>;
pub fn boxed_error<D: Display>(msg: D) -> Box<dyn Error> {
Box::new(std::io::Error::new(ErrorKind::Other, msg.to_string()))
}

View File

@@ -0,0 +1,9 @@
use std::time::{SystemTime, UNIX_EPOCH};
/// Get the current time since epoch
pub fn time() -> u64 {
SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap()
.as_secs()
}

View File

@@ -1,12 +1,18 @@
[package]
name = "cli_player"
name = "sea_battle_cli_player"
version = "0.1.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" }
sea_battle_backend = { path = "../sea_battle_backend", version = "0.1.0" }
clap = { version = "4.0.15", features = ["derive"] }
log = "0.4.17"
env_logger = "0.9.0"
@@ -24,4 +30,4 @@ 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"] }

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

@@ -5,8 +5,10 @@ use futures::{SinkExt, StreamExt};
use hyper_rustls::ConfigBuilderExt;
use sea_battle_backend::data::GameRules;
use sea_battle_backend::human_player_ws::{ClientMessage, ServerMessage};
use sea_battle_backend::server::{BotPlayQuery, PlayRandomQuery};
use sea_battle_backend::utils::{boxed_error, Res};
use sea_battle_backend::server::{
AcceptInviteQuery, BotPlayQuery, CreateInviteQuery, PlayRandomQuery,
};
use sea_battle_backend::utils::res_utils::{boxed_error, Res};
use std::fmt::Display;
use std::sync::mpsc::TryRecvError;
use std::sync::{mpsc, Arc};
@@ -61,6 +63,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_uri,
&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_uri,
&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

@@ -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;
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;
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>(
@@ -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();
@@ -103,29 +107,49 @@ async fn run_app<B: Backend>(terminal: &mut Terminal<B>) -> Res {
let choice = SelectPlayModeScreen::default().show(terminal)?;
if let ScreenResult::Ok(c) = choice {
if c.need_user_name() && username.is_empty() {
username = query_username(terminal)?;
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?
}
// 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(()),

View File

@@ -5,6 +5,9 @@ use std::time::{Duration, Instant};
use crossterm::event;
use crossterm::event::{Event, KeyCode};
use sea_battle_backend::consts::{
MAX_BOATS_NUMBER, MAX_MAP_HEIGHT, MAX_MAP_WIDTH, MAX_STRIKE_TIMEOUT,
};
use tui::backend::Backend;
use tui::layout::{Constraint, Direction, Layout, Margin};
use tui::style::{Color, Style};
@@ -14,6 +17,7 @@ use tui::{Frame, Terminal};
use sea_battle_backend::data::GameRules;
use crate::constants::{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;
use crate::ui_screens::ScreenResult;
@@ -26,6 +30,7 @@ enum EditingField {
MapWidth = 0,
MapHeight,
BoatsList,
StrikeTimeout,
BoatsCanTouch,
PlayerContinueOnHit,
BotType,
@@ -58,7 +63,7 @@ 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()? {
@@ -114,24 +119,46 @@ impl GameRulesConfigurationScreen {
{
self.rules.remove_last_boat();
}
if self.curr_field == EditingField::StrikeTimeout {
match self.rules.strike_timeout.unwrap_or(0) / 10 {
0 => self.rules.strike_timeout = None,
v => self.rules.strike_timeout = Some(v),
}
}
}
KeyCode::Char(c) if ('0'..='9').contains(&c) => {
let val = c.to_string().parse::<usize>().unwrap_or_default();
if self.curr_field == EditingField::MapWidth {
if self.curr_field == EditingField::MapWidth
&& self.rules.map_width <= MAX_MAP_WIDTH
{
self.rules.map_width *= 10;
self.rules.map_width += val;
}
if self.curr_field == EditingField::MapHeight {
if self.curr_field == EditingField::MapHeight
&& self.rules.map_height <= MAX_MAP_HEIGHT
{
self.rules.map_height *= 10;
self.rules.map_height += val;
}
if self.curr_field == EditingField::BoatsList {
if self.curr_field == EditingField::BoatsList
&& self.rules.boats_list().len() < MAX_BOATS_NUMBER
{
self.rules.add_boat(val);
}
if self.curr_field == EditingField::StrikeTimeout {
let mut timeout = self.rules.strike_timeout.unwrap_or(0);
if timeout <= MAX_STRIKE_TIMEOUT {
timeout *= 10;
timeout += val as u64;
self.rules.strike_timeout = Some(timeout);
}
}
}
_ => {}
@@ -153,19 +180,29 @@ impl GameRulesConfigurationScreen {
}
fn ui<B: Backend>(&mut self, f: &mut Frame<B>) {
let area = centered_rect_size(50, 20, &f.size());
let (w, h) = (50, 23);
let block = Block::default().title("Game rules").borders(Borders::ALL);
if f.size().width < w || f.size().height < h {
show_screen_too_small_popup(f);
return;
}
let area = centered_rect_size(w, h, &f.size());
let block = Block::default()
.title("📓 Game rules")
.borders(Borders::ALL);
f.render_widget(block, area);
let chunks = Layout::default()
.direction(Direction::Vertical)
.constraints([
Constraint::Length(3),
Constraint::Length(3),
Constraint::Length(3),
Constraint::Length(1),
Constraint::Length(1),
Constraint::Length(3), // Map width
Constraint::Length(3), // Map height
Constraint::Length(3), // Boats list
Constraint::Length(3), // Strike timeout
Constraint::Length(1), // Boats can touch
Constraint::Length(1), // Player continue on hit
Constraint::Length(3), // Bot type
Constraint::Length(1), // Margin
Constraint::Length(1), // Buttons
@@ -203,6 +240,13 @@ impl GameRulesConfigurationScreen {
);
f.render_widget(editor, chunks[EditingField::BoatsList as usize]);
let editor = TextEditorWidget::new(
"Strike timeout (0 to disable)",
&self.rules.strike_timeout.unwrap_or(0).to_string(),
self.curr_field == EditingField::StrikeTimeout,
);
f.render_widget(editor, chunks[EditingField::StrikeTimeout as usize]);
let editor = CheckboxWidget::new(
"Boats can touch",
self.rules.boats_can_touch,

View File

@@ -12,14 +12,17 @@ use tui::{Frame, Terminal};
use sea_battle_backend::data::{Coordinates, CurrentGameMapStatus, CurrentGameStatus};
use sea_battle_backend::human_player_ws::{ClientMessage, ServerMessage};
use sea_battle_backend::utils::Res;
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::ui_screens::confirm_dialog_screen::confirm;
use crate::ui_screens::popup_screen::PopupScreen;
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};
@@ -52,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 won the game!",
GameStatus::LostGame => "### won 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!",
}
}
}
@@ -82,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",
}
}
}
@@ -95,6 +98,7 @@ pub struct GameScreen {
invite_code: Option<String>,
status: GameStatus,
opponent_name: Option<String>,
game_last_update: u64,
game: CurrentGameStatus,
curr_shoot_position: Coordinates,
last_opponent_fire_position: Coordinates,
@@ -108,6 +112,7 @@ impl GameScreen {
invite_code: None,
status: GameStatus::Connecting,
opponent_name: None,
game_last_update: 0,
game: Default::default(),
curr_shoot_position: Coordinates::new(0, 0),
last_opponent_fire_position: Coordinates::invalid(),
@@ -133,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
@@ -238,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(()));
}
@@ -288,11 +293,13 @@ impl GameScreen {
ServerMessage::OpponentMustFire { status } => {
self.status = GameStatus::OpponentMustFire;
self.game_last_update = time();
self.game = status;
}
ServerMessage::RequestFire { status } => {
self.status = GameStatus::MustFire;
self.game_last_update = time();
self.game = status;
}
@@ -303,11 +310,13 @@ impl GameScreen {
}
ServerMessage::LostGame { status } => {
self.game_last_update = time();
self.game = status;
self.status = GameStatus::LostGame;
}
ServerMessage::WonGame { status } => {
self.game_last_update = time();
self.game = status;
self.status = GameStatus::WonGame;
}
@@ -357,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);
}
@@ -468,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));
}
}
@@ -476,6 +486,17 @@ impl GameScreen {
return HashMap::default();
}
// Add timeout (if required)
let mut timeout_str = String::new();
if self.status == GameStatus::MustFire || self.status == GameStatus::OpponentMustFire {
if let Some(remaining) = self.game.remaining_time_for_strike {
let timeout = self.game_last_update + remaining;
if time() < timeout {
timeout_str = format!(" {} seconds left", timeout - time());
}
}
}
// Draw main ui (default play UI)
let player_map = self
.player_map(&self.game.your_map, false)
@@ -519,19 +540,22 @@ impl GameScreen {
let buttons_width = buttons.iter().fold(0, |a, b| a + b.estimated_size().0 + 4);
let max_width = max(maps_width, status_text.len() as u16).max(buttons_width);
let total_height = 3 + maps_height + 3;
let max_width = max(maps_width, status_text.len() as u16)
.max(buttons_width)
.max(timeout_str.len() as u16);
let total_height = 3 + 1 + maps_height + 3;
// Check if frame is too small
if max_width > f.size().width || total_height > f.size().height {
PopupScreen::new("Screen too small!").show_in_frame(f);
show_screen_too_small_popup(f);
return HashMap::default();
}
let chunks = Layout::default()
.direction(Direction::Vertical)
.constraints([
Constraint::Length(3),
Constraint::Length(2),
Constraint::Length(2),
Constraint::Length(maps_height),
Constraint::Length(3),
])
@@ -541,25 +565,31 @@ impl GameScreen {
let paragraph = Paragraph::new(status_text.as_str());
f.render_widget(paragraph, centered_text(&status_text, &chunks[0]));
// Render timeout
let paragraph = Paragraph::new(timeout_str.as_str());
f.render_widget(paragraph, centered_text(&timeout_str, &chunks[1]));
// Render maps
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),
])
.split(chunks[1]);
.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() {
f.render_widget(opponent_map, chunks[1]);
f.render_widget(opponent_map, chunks[2]);
} else {
f.render_widget(player_map, chunks[1]);
f.render_widget(player_map, chunks[2]);
drop(opponent_map);
}
}
@@ -573,7 +603,7 @@ impl GameScreen {
.map(|_| Constraint::Percentage(100 / buttons.len() as u16))
.collect::<Vec<_>>(),
)
.split(chunks[2]);
.split(chunks[3]);
for (idx, b) in buttons.into_iter().enumerate() {
let target = centered_rect_size(

View File

@@ -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

@@ -14,6 +14,12 @@ use crate::ui_screens::utils::centered_rect_size;
use crate::ui_screens::ScreenResult;
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)
}
pub struct PopupScreen<'a> {
title: &'a str,
msg: &'a str,

View File

@@ -17,14 +17,22 @@ 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
}
}
#[derive(Debug, Clone)]
@@ -33,17 +41,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,
},
];
@@ -92,7 +108,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

@@ -14,7 +14,7 @@ use sea_battle_backend::data::*;
use crate::constants::*;
use crate::ui_screens::confirm_dialog_screen::confirm;
use crate::ui_screens::popup_screen::PopupScreen;
use crate::ui_screens::popup_screen::show_screen_too_small_popup;
use crate::ui_screens::utils::{centered_rect_size, centered_text};
use crate::ui_screens::ScreenResult;
use crate::ui_widgets::game_map_widget::{ColoredCells, GameMapWidget};
@@ -229,8 +229,9 @@ impl<'a> SetBoatsLayoutScreen<'a> {
let (w, h) = game_map_widget.estimated_size();
if f.size().width < w || f.size().height + 3 < h {
PopupScreen::new("Screen too small!").show_in_frame(f);
if f.size().width < w || f.size().height < h + 3 {
// +3 = for errors
show_screen_too_small_popup(f);
drop(game_map_widget);
return coordinates_mapper;
}

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

@@ -77,8 +77,8 @@ impl<'a> GameMapWidget<'a> {
}
pub fn grid_size(&self) -> (u16, u16) {
let w = self.rules.map_width as u16 * 2 + 1;
let h = self.rules.map_height as u16 * 2 + 1;
let w = (self.rules.map_width as u16 * 2) + 2;
let h = (self.rules.map_height as u16 * 2) + 2;
(w, h)
}