Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Commit

Permalink
Added documentation for JARs files.
Browse files Browse the repository at this point in the history
  • Loading branch information
lorenzo-cmyk committed Jun 27, 2024
1 parent 4ece1e7 commit ce3998d
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
31 changes: 31 additions & 0 deletions deliverables/JARs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Deployment

## Server

It is required to put the correct server IPv4 address in the Config.json file in order to let RMI work properly.

Here is an example of the Config.json file:

```json
{
"socketPort": 30000,
"rmiPort": 30001,
"pingTimePeriod": 5000,
"socketReadTimeout": 100,
"maxPingCount": 3,
"serverIp": "192.168.178.20",
"endGameDueToDisconnectionTimeout": 120000
}
```

## Client

If the client is running on a Windows machine it is required to enable UTF-8 encoding in the terminal to let the client display the special characters correctly for TUI.

To enable UTF-8 encoding in the terminal, run the following command:

```powershell
PS C:\> $OutputEncoding = [System.Console]::OutputEncoding = [System.Console]::InputEncoding = [System.Text.Encoding]::UTF8
PS C:\> $PSDefaultParameterValues['*:Encoding'] = 'utf8'
PS C:\> java -jar .\IS24-AM32-0.1-CLIENT.jar
```
3 changes: 2 additions & 1 deletion deliverables/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
- ☑️ InitialUML: This folder contains the high-level UML diagram of the project.
- ☑️ FinalUML: This folder contains the detailed UML diagrams of the project. Generated using IntelliJ IDEA.
- ☑️ PeerReview: This folder contains the peer review documents. In the second peer review it is also explained the communication protocol between Client and Server.
- ☑️ JavaDoc: This folder contains the JavaDoc of the project exported in HTML format.
- ☑️ JavaDoc: This folder contains the JavaDoc of the project exported in HTML format.
- ☑️ JARs: This folder contains the JAR files of the project.

0 comments on commit ce3998d

Please sign in to comment.