Skip to content

Commit d5e6aad

Browse files
Fixed License/Readme location.
1 parent 822380d commit d5e6aad

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

LICENSE

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) 2021 TiToMoskito
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: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# FishyFacepunch
2+
3+
A Facepunch implementation for Fish-Net.
4+
5+
This is an improved fork from https://github.com/Chykary/FizzyFacepunch and https://github.com/FirstGearGames/FishySteamworks/.
6+
7+
FishyFacepunch brings together **[Steam](https://store.steampowered.com)** and **[Fish-Net](https://github.com/FirstGearGames/FishNet)** . It supports only the new SteamSockets.
8+
9+
## Dependencies
10+
Both of these projects need to be installed and working before you can use this transport.
11+
1. **[Facepunch](https://github.com/Facepunch/Facepunch.Steamworks)** FishyFacepunch relies on Facepunch to communicate with the **[Steamworks API](https://partner.steamgames.com/doc/sdk)**. **Requires .Net 4.x**
12+
2. **[Fish-Net](https://github.com/FirstGearGames/FishNet)**
13+
14+
## Setting Up
15+
16+
1. Install Fish-Net from the **[official repo](https://github.com/FirstGearGames/FishNet/releases)** or **[Asset Store](https://assetstore.unity.com/packages/tools/network/fish-net-networking-evolved-207815)**.
17+
2. Install FishyFacepunch **[unitypackage](https://github.com/TiToMoskito/FishyFacepunch/releases)** from the release section.
18+
3. In your **"NetworkManager"** object add a **"Transport Manager"** script and the **"FishyFacepunch"** script.
19+
4. Enter your Steam App ID in the **"FishyFacepunch"** script and set all settings to your needs.
20+
21+
## Host
22+
To be able to have your game working you need to make sure you have Steam running in the background.
23+
24+
## Client
25+
1. Send the game to your buddy.
26+
2. Your buddy needs your **steamID64** to be able to connect. The transport shows your Steam User ID after you have started a server.
27+
3. Place the **steamID64** into **"Client Address"** on the **"FishyFacepunch"** script
28+
5. Then they will be connected to you.
29+
30+
## Sample
31+
I made a sample script **"SteamManager"** to create a dedicated server.
32+
33+
## Testing your game locally
34+
You cant connect to yourself locally while using **FishyFacepunch** since it's using steams P2P. If you want to test your game locally you'll have to use default transport instead of **FishyFacepunch**.

0 commit comments

Comments
 (0)