-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README with instruction on how to start Paw
- Loading branch information
Showing
1 changed file
with
32 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,37 @@ | ||
# Pal | ||
Command-line chess interface in C++ | ||
# Paw | ||
Command-line chess interface in Java | ||
|
||
**P**layers | ||
**a**re | ||
**w**inners | ||
|
||
A program to play chess on the command line. It supports algebraic notation for only normal moves (i.e. anything that's not castling, en passant, and promotions) | ||
right now. | ||
A program to play chess on the command line locally or over a network. | ||
|
||
**Java 8** is required to run this software. | ||
|
||
The build is distributed as a `.jar` named `Paw.jar`. Look in releases for the latest build. | ||
|
||
## Local Play | ||
Using a terminal, navigate to the `Paw.jar` file and execute it like so: | ||
|
||
java -jar Paw.jar | ||
|
||
The prompts will guide you through the steps to start and play the game. | ||
|
||
## Remote Play | ||
Player 1 and Player 2 must be on the same network with the appropriate ports and security | ||
permissions open. | ||
Player 1 (acting as the server) starts the program with this command: | ||
|
||
java -jar Paw.jar -s | ||
|
||
Player 1 follows the prompt to establish the listening server. Once Player 1 has completed that | ||
step, Player 2 starts the program with this command: | ||
|
||
java -jar Paw.jar -c <Player 1 IP address> | ||
|
||
`<Player 1 IP address>` refers to the IP address that Player 1 selected in her prompt. | ||
|
||
From there, both players follow the prompts to start and play the game. | ||
|
||
|