You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

89 lines
3.3 KiB

3 months ago
# Box Brawl
[![Donate via LiberaPay](](
[![Donate via Patreon](](
2 months ago
Multiplayer [fighting]( video game featuring [rollback]( networking
3 months ago
2 months ago
This game was created for the [Fighting Jam #001]( game jam.
3 months ago
## Play
2 months ago
### Browser
[**Play in your browser**](
Networking is not available in the browser version.
### Download
[**Download for Windows and Linux**](
To play against remote opponents, you will need to ensure UDP traffic is
allowed between both of your computers.
This usually involves port forwarding and ensuring firewalls are disabled on
both computers.
You can also use programs like [ZeroTier]( and [Hamachi](
to create virtual networks between you and an opponent. The network will appear
to the system as a local network. Because of this, most security restrictions
are bypassed, and port forwarding is usually not required.
Only multiplayer over a local network (whether truly local or virtual) has been
tested successfully.
2 months ago
#### Multiplayer guide
You and your opponent will need to choose a port on which you will accept UDP
traffic from the other person. This is referred to as your local port,
which can specified when playing Box Brawl using the `--local` argument.
In the following examples, user A has the IP address `` and user B has
the IP address ``. User A will listen for a connection on port `17000`.
User B will listen for a connection on port `19000`.
Simply replace the example IP addresses and ports with actual IP addresses and
ports, and run the command specified (depending on whether you are the host or
the guest).
User A (who has IP ``) should run the following command:
boxbrawl --local 17000 --host
User B (who has IP ``) should run the following command:
boxbrawl --local 19000 --connect
In the above commands, each user first specifies which port to listen for
connections from the opponent, then specifies the IP address and port where
their opponent is listening for connections.
3 months ago
### Compile
Install the dependencies listed for [your platform](,
then run the following command:
`go install`
Run `~/go/bin/boxbrawl` to play.
## Support
Please share issues and suggestions [here](
## Credits
- [Trevor Slocum]( - Game design and programming
- [node punk]( - Music
3 months ago
## Dependencies
- [ebitengine]( - Game engine
- [ggpo-go]( - Rollback networking library
3 months ago
- [gohan]( - Entity Component System framework