Update READMEs

This commit is contained in:
Layla 2020-05-05 03:20:58 -04:00
parent c980235726
commit bf546793e2
No known key found for this signature in database
GPG Key ID: A494D9357BA1BE31
3 changed files with 50 additions and 15 deletions

View File

@ -1,9 +1,29 @@
# ludum-dare-46
![Build Stage](https://github.com/josephbmanley/defend-together/workflows/Build%20Stage/badge.svg)
![Run Server Tests](https://github.com/josephbmanley/defend-together/workflows/Run%20Server%20Tests/badge.svg)
## Client
# Defend Together
The client is build via Godot v3.2.1
![Header Image](https://static.cloudsumu.com/dt/header.png)
## Server
Defend Together is a mutiplayer demo game project created in C++ with the [ENet Library](http://enet.bespin.org/) and [Godot v3.2.1](https://godotengine.org/)
The server is a C++ app built using ENet
See the [wiki](https://github.com/josephbmanley/defend-together/wiki) for project documentation
Checkout the project on [Itch.io](https://josephbmanley.itch.io/defend-together)
View nested `ReadMe.md` files:
- [Client](blob/master/client)
- [Server](blob/master/server)
---
This project highlights the following:
- Continous Intergration & Continous Deployment
- UDP Server Networking
- Utilization of Cloud Services in development
## Screenshots
![Screenshot0](https://static.cloudsumu.com/dt/dt-screenshot0.png)

View File

@ -1,4 +1,4 @@
# LD46 Client
# Defend Together Client
## Build Requirements
@ -6,4 +6,4 @@ Godot 3.2.1-stable
### Godot Modules
- [GDNet3](https://github.com/perdugames/gdnet3)
- [GDNet3](https://github.com/josephbmanley/gdnet3)

View File

@ -1,16 +1,31 @@
# LD46 Server
# Defend Together Server
Here are the instructions below for running the server locally on linux.
## Build Requirements
Enet development files:
_Instructions are for Fedora Linux_
`dnf install enet-devel`
Install dependencies:
G++
`dnf install g++`
`dnf install enet-devel g++`
For testing:
`dnf install gtest gmock gmock-devel gtest-devel`
`dnf install gtest gmock gmock-devel gtest-devel`
## Building Server
Within the server directory run: `bash build.sh`
## Running Tests
Within the server directory run: `bash run_tests.sh`
## Running Server
If you have already built the server, you can run the binary location at `builds/server.out`, otherwise within the server directory, you can run `run_build.sh` to build and run the server.
# Running in Docker
A `Dockerfile` is provided in this project. So you can run `docker build -t defend-together .` and then `docker run -p 7777:7777 defend-together` to run locally on port `7777` in docker.