https://github.com/passeriform/nukeship
A battleship-inspired game made in go
https://github.com/passeriform/nukeship
Last synced: 11 months ago
JSON representation
A battleship-inspired game made in go
- Host: GitHub
- URL: https://github.com/passeriform/nukeship
- Owner: Passeriform
- License: mit
- Created: 2025-01-15T23:18:44.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-20T00:08:26.000Z (11 months ago)
- Last Synced: 2025-07-20T02:50:20.567Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 6.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NukeShip
[](https://app.koyeb.com/deploy?name=nukeship&repository=Passeriform%2FNukeShip&branch=master&instance_type=free)
NukeShip is a cyberpunk twist on the classic game of Battleship. Engage in a high-stakes battle to destroy your opponent's ships by strategically targeting their weak points.
## How to Play
1. Launch the game and connect with an opponent.
2. Strategically target your opponent's ships and destroy them.
3. First player to destroy the opponent's ships wins!
## Features
- **Cross-Platform Support:** Run the game seamlessly on multiple platforms.
## Download Latest Release (1.0)
To download the latest pre-built binary, visit the [Releases](https://github.com/Passeriform/NukeShip/releases) page on GitHub and select the version compatible with your system.
## Getting Started
### Prerequisites
Ensure you have the following installed on your system:
- [Go](https://go.dev/doc/install)
- [Node.js](https://nodejs.org/en/download)
- [Protoc](https://grpc.io/docs/protoc-installation/)
### Build Source
1. Clone the repository:
```bash
git clone https://github.com/Passeriform/NukeShip.git
cd NukeShip
```
2. Install Wails:
```bash
go install github.com/wailsapp/wails/v2/cmd/wails@latest
```
3. Generate Go code:
```bash
go generate ./...
```
4. Build the project:
```bash
wails build -clean
```
5. Run the game:
```bash
./pkg/client/build/bin/NukeShip
```
## VSCode Support
This project uses VSCode tooling. Supporting tasks, debugger configurations and editor settings are provided to ease the development:
### Tasks
- `Build App`
- `Run App`
- `Run Server`
- `Build App [Local Server]`
- `Run App [Local Server]`
- `Run Server [Docker]`
### Debugging Configurations
- `Debug App`
- `Debug Server`
## Contributing
Contributions are welcome! To contribute:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Submit a pull request with a clear description of your changes.
## License
This project is licensed under the [MIT License](LICENSE).
---
Feel free to open issues or reach out if you encounter any problems or have suggestions for improvements.
Enjoy the game and good luck, Admiral!