Rockingcool/netpong
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Updated README

Browse Source
This commit is contained in:
Aadhavan Srinivasan
2024-03-09 12:46:52 -05:00
parent 9a12edcdb1
commit e9405b69e7
1 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -4,16 +4,21 @@ __Netpong__ is a network-enabled Pong game, written in C++. It enables two playe
## How it works ## How it works
The game has only one runtime dependency: The [raylib](https://www.raylib.com/) graphics system. In order to write idiomatic C++, I chose to use the [raylib-cpp](https://robloach.github.io/raylib-cpp/) wrapper, which provides an object-oriented interface to the Raylib library. However, this wrapper is bundled with the project, and is thus not required to be installed. The game has only one runtime dependency: The [raylib](https://www.raylib.com/) graphics library. In order to write idiomatic C++, I chose to use the [raylib-cpp](https://robloach.github.io/raylib-cpp/) wrapper, which provides an object-oriented interface to the Raylib library.
## Building ## Building
This application uses [Meson](https://mesonbuild.com/) as a build system. To build the application: This application uses [Meson](https://mesonbuild.com/) as a build system. To build the application:
1. Install __meson__ from the link above. 1. Install __meson__ from the link above.
2. Install __raylib__ from the link above (THIS IS OPTIONAL, SEE STEP 5) 2. Set up the build directory.
3. Set up the build directory with the `meson setup build` command. ```
4. Compile the application, with the existing raylib installation, using `meson compile -C build`. meson setup build
5. If you don't have raylib installed, you can create a statically linked version of the library on Linux by running the following commands: ```
3. Compile the application. Meson should use a system installation of raylib, if it exists. If not, it falls back to a bundled version.
```
meson compile -C build
```
4. You can also create a statically-linked version of the game (with no runtime dependencies) on Linux by running the following commands:
``` ```
meson configure -Ddefault_library=static build/ meson configure -Ddefault_library=static build/
@@ -30,3 +35,7 @@ This application uses [Meson](https://mesonbuild.com/) as a build system. To bui
- One player runs the application in Server mode, specifying their IP address and a port: `build/pong -S <ip_address> <port>` - One player runs the application in Server mode, specifying their IP address and a port: `build/pong -S <ip_address> <port>`
- The other player connects to the first player by running in Client mode, specifying the first player's IP address and port: `build/pong -C <ip_address> <port>`. - The other player connects to the first player by running in Client mode, specifying the first player's IP address and port: `build/pong -C <ip_address> <port>`.
- The server controls the left paddle by default (WIP to allow the user to modify this), and the client controls the right paddle. - The server controls the left paddle by default (WIP to allow the user to modify this), and the client controls the right paddle.
## TODO
See todo.txt.