This commit is contained in:
		@@ -1,5 +1,30 @@
 | 
			
		||||
# Sea battle backend
 | 
			
		||||
[](https://drone.communiquons.org/pierre/SeaBattle)
 | 
			
		||||
[](https://crates.io/crates/sea_battle_backend)
 | 
			
		||||
[](https://docs.rs/sea_battle_backend/)
 | 
			
		||||
 | 
			
		||||
A backend server for the Sea Battle game.
 | 
			
		||||
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.
 | 
			
		||||
 | 
			
		||||
A command-line client is available in the `sea_battle_cli_player` crate.
 | 
			
		||||
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.
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user