Skip to content

Commit b737cc1

Browse files
committed
Added license and readme
1 parent 1eb4a91 commit b737cc1

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

LICENSE.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Studio Cherno
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Walnut-Networking
2+
3+
Walnut-Networking an optional module for [Walnut](https://github.com/StudioCherno/Walnut) which provides networking capabilities.
4+
5+
## Getting Started
6+
Add this is a submodule to your [Walnut](https://github.com/StudioCherno/Walnut) application. If you need to make a new Walnut app, check out [WalnutAppTemplate](https://github.com/StudioCherno/WalnutAppTemplate).
7+
8+
If cloned into `Walnut/` directory, Walnut's build scripts should automatically pick this up and include it into your project if present. Otherwise, if doing this manually, include the `Build-Walnut-Networking.lua` file into your build scripts somewhere, eg:
9+
10+
``` lua
11+
include "Walnut/Walnut-Networking/Build-Walnut-Networking.lua"
12+
```
13+
14+
[Walnut Chat](https://github.com/TheCherno/Walnut-Chat) is an example app made using Walnut and this Walnut-Networking module, so check that out for a further example of how to get started. The server component of this project runs on a Linux server (headless) which is also a useful example.
15+
16+
## Features
17+
- Supports Windows and Linux (mostly)
18+
- Client/Server API for both reliable and unreliable data transmission, using Valve's [GameNetworkingSockets](https://github.com/ValveSoftware/GameNetworkingSockets) library
19+
- Easy and clean network event callbacks and connection management
20+
- DNS lookup utility function for translating domain names to IP addresses (`Walnut::Utils::ResolveDomainName`)
21+
- _[Planned]_ HTTP API for GET/POST requests
22+
23+
### 3rd Party Libraries
24+
- [GameNetworkingSockets](https://github.com/ValveSoftware/GameNetworkingSockets)

0 commit comments

Comments
 (0)