back to scratko.xyz
aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorscratko <m@scratko.xyz>2024-08-30 16:04:43 +0300
committerscratko <m@scratko.xyz>2024-08-30 21:01:53 +0300
commitbedb024261f6539d0517430e88cfaa1e78e6e955 (patch)
tree35cf5a44b8e555de4b241653be5b5b2736a6726d /README.md
parent831f9f01fbe4088eb6bd378c0e417d9996b676fd (diff)
downloaddurak-master.tar.gz
durak-master.tar.bz2
durak-master.zip
Changed readmeHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 33 insertions, 14 deletions
diff --git a/README.md b/README.md
index a7d1a5a..da73c73 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,17 @@
## Description
-Network game. Client and server are written in pure C.
-For network communication the socket system with TCP/IP protocol is used. Due to this it is possible to use streaming through read and write system calls, and there is a guarantee that the data will arrive in strict order.
-The client and server are written in an event-driven programming model. Events are selected using the select system call, thus multiplexing I/O.
+Network game. Client and server are written in pure C.
+For network communication the socket system with TCP/IP protocol is used. Due to this it is possible to use streaming through read
+and write system calls, and there is a guarantee that the data will arrive in strict order.
+The client and server are written in an event-driven programming model. Events are selected using the select system call, thus
+multiplexing I/O.
GUI: console version.
Card suits are labeled as %, #, v, ^.
Card ranks: 2, 3, 4, 5, 6, 7, 8, 9, 9, 10, J, Q, K, A.
-There are several stages: attacking, defending, and tossing cards. Unlike classic Fool's game, here you can toss cards depending on the reaction of the players --- whoever has time to toss a card, that card goes on the table.
+There are several stages: attacking, defending, and tossing cards. Unlike classic Fool's game, here you can toss cards depending on
+the reaction of the players --- whoever has time to toss a card, that card goes on the table.
There are hints to help players.
@@ -19,8 +22,13 @@ There are hints to help players.
* When defending: those cards that can be used to beat back the attacking card on the table (higher rank, or with a trump suit).
* When tossing: those cards that have the same rank.
-It is possible to give up defense and accept attacking cards -- then press enter. It is also possible to discard the toss -- also press enter.
-The server analyzes whether the defender can fight back. If so, the server analyzes whether the defender can fight back. The defender is shown one card at a time (the others see all cards), which he must defeat. If the server decides that the defender does not have any cards that can be used to fight off the attacking cards, then the tossing phase is analyzed. If the other players (except the defender, of course) have cards with the same rank as on the table, then the player moves to the tossing phase, otherwise the player moves to a new attack phase.
+It is possible to give up defense and accept attacking cards -- then press enter. It is also possible to discard the toss -- also
+press enter.
+The server analyzes whether the defender can fight back. If so, the server analyzes whether the defender can fight back.
+The defender is shown one card at a time (the others see all cards), which he must defeat. If the server decides that the defender
+does not have any cards that can be used to fight off the attacking cards, then the tossing phase is analyzed.
+If the other players (except the defender, of course) have cards with the same rank as on the table, then the player moves to
+the tossing phase, otherwise the player moves to a new attack phase.
## Building
@@ -28,19 +36,30 @@ The server analyzes whether the defender can fight back. If so, the server analy
```
git clone https://git.scratko.xyz/durak
-cd client
-```
-
-To connect to the current game server (scratko.xyz), do the following:
- - open the client.c file with any text editor.
- - In line 14, change the ip from `127.0.0.1` to `109.107.161.30`
-
-```
+cd durak/linux_client
make
./client
```
+Note: for Android, you need to use a terminal like Termux. After installing it, you should to install packages:
+clang, make, git. Then follow the steps above.
+
### On Windows
You can download the built version for the Windows platform (it already contains the IP address for connecting to this server).
Windows version: <a href="https://scratko.xyz/games/durak.exe" target="_blank">Download</a>
+
+### Use for your server
+
+ * Build the server executable file.
+Run the file on the command line, specify a free port to be used by the server (from 1024 to 65535) as the second argument.
+Example: `./server 1025`
+ * Open the linux_client/client.c (or windows_client/client.c) file with any text editor.
+ * On line 14, change the ip from `109.107.161.30` to `%server ip-address%` (either `127.0.0.1` if you want to test on a local
+computer).
+ * On line 15 in the same file, correct the port to the one specified above.
+ * Build the client file and run it without arguments.
+
+---
+
+If you have any questions, please contact me: m@scratko.xyz \ No newline at end of file