Battleship TUI
Battleship TUI is an implementation of the popular paper-and-pen Battleship game for your terminal. You can play against the computer or a real player via the Internet, customize game options and appearance, keep track of your achievements, and more.
[!NOTE] Please consider this an alpha-version software. You can still use it and enjoy it but note that things may break and data might get lost. Feel free to fill in an issue if you've found a bug or have a question.
Features
- Singleplayer mode
- Multiplayer mode (via Internet)
- Customizable game rules
- Customizable UI
- Launch via CLI
- Game statistics
Planned features
- Ranking system
- Account management
Requirements
- A terminal (Windows PowerShell is fine too, see below)
- Python 3.10 or higher
[!NOTE] If you're on Windows, make sure to install the newer Windows Terminal. The older Windows PowerShell can't properly display some symbols.
Installation
If you're on Linux or macOS, most probably you already have Python installed. You can verify it by
running $ python --version. If your Python version is lower than required, try installing the
latest operating system updates.
If you're on Windows, you can download and install the latest Python release from the official site.
The recommended way to install and update the game is via pipx (especially if you don't know anything about virtual environments).
Install pipx, then install the game.
pipx install battleship-tui[client]
battleship-tui is merely a Python package and is distributed via PyPI. You can
install it via pip too, but make sure it installs into a venv so that you're not
messing with the system interpreter.
Play
Once the game is installed you can use the battleship command to run it. This
command will launch the user interface and present you with the main menu.
Play via CLI
You can launch the game via CLI subcommands too, especially if you want to skip some in-game menus.
For example, if your favorite game mode is singleplayer, salvo variant, you can
quickly get into battle by running battleship play single --salvo.
Run battleship play --help to discover available options.
Multiplayer
You can play Battleship TUI with your friends or colleagues via the Internet. Choose Multiplayer option in the main menu to do this.
Game account
You may sign up for a multiplayer account or try multiplayer with guest access.
To sign up, run battleship account signup. You'll be prompted with your email,
desired nickname, and a password. Your nickname will be displayed in-game. It should
contain 7 to 20 characters and be unique. Your password should contain at least 9
characters.
[!NOTE] Guests given an autogenerated nickname, their game statistics isn't saved. Guest access will work until you log off.
[!NOTE] At the moment, the user management is handled by Auth0. The game serve doesn't store your credentials.
Screenshots
1 maintainer
Metadata
1 maintainer
Release files for battleship-tui 0.25.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| battleship_tui-0.25.0.tar.gz | 68.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| battleship_tui-0.25.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 163.2 kB
Release files / battleship_tui-0.25.0.tar.gz
| Download URL | battleship_tui-0.25.0.tar.gz |
|---|---|
| Size | 68.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a608a56eb066a594ab5af84a9af18dca3d4f94231690122da06fb436beb53bbf
|
|
BLAKE2b-256 checksum How to use checksums |
9305ed4e7dea495ac0500a57b71184d0bb7614cecbb62c064ff5cecd3412ae0f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-1017-azure
|
Release files / battleship_tui-0.25.0-py3-none-any.whl
| Download URL | battleship_tui-0.25.0-py3-none-any.whl |
|---|---|
| Size | 94.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bd396f7d1ae0dd081d6ec4c659c67f2a623d2c337a640f879c5da7ce26967489
|
|
BLAKE2b-256 checksum How to use checksums |
bc912dc721d84dbc5c0ea673242c390168d5a29492dad7eeed66addca4b66663
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-1017-azure
|
