Giter Club home page Giter Club logo

easysteamsockets's Introduction

EasySteamSockets' Purpose

EasySteamSockets is a library that builds on the Steam socket server networking provided in Facepunch.Steamworks. The sample project is a lightweight WinForm app to demonstrate sending two types of payloads:

Payload Type Example Purpose
"JSON" ChatMessage "JSON" payloads that can easily support complex objects without the developer having to worry about how it is encoded
"Byte" PlayerPositionMessage "Byte" payloads that the developer has more control over how to read and write the bytes

Networking Milestone

How to use

Initial Setup

Note: that the library needs a one-time initialisation by providing it the assembly that has the payloads defined in it.

{
    EasySteamSockets.Initialiser.Initialise(Assembly.GetExecutingAssembly());
}

Sending a message

See FormClient.cs for a fully worked example. The code snippets below are taken from this class.

Note that for byte type payloads that might be sent often, it is possible to re-use messages.

{
    PlayerPositionUpdateMessage playerPositionUpdateMessage = new()
    {
        Id = 123,
        X = x,
        Y = y,
    };

    client?.SendMessage(playerPositionUpdateMessage, SendType.Reliable);
}

Receiving a message

Periodically call Receive on the client or server as appropriate e.g.

    client?.Receive();
    server?.Receive();

Note that the received messages are reused the next time the same type is received therefore don't keep a reference to it.

{   
    client?.Events.Subscribe<ChatMessage>(ChatMessageReceived);
}

private void ChatMessageReceived(ChatMessage chatMessage)
{
    // Consume chatMessage here.
}

easysteamsockets's People

Contributors

weesleekit avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.