https://github.com/dhruvikdonga/simplysocket

Simple golang package to push messages to clients , handle rooms and events .
https://github.com/dhruvikdonga/simplysocket

events real-time websocket wrapper

Last synced: 1 day ago
JSON representation

Simple golang package to push messages to clients , handle rooms and events .

• Host: GitHub
• URL: https://github.com/dhruvikdonga/simplysocket
• Owner: DhruvikDonga
• License: mit
• Created: 2023-12-06T05:16:23.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-15T04:35:41.000Z (3 months ago)
• Last Synced: 2025-01-14T10:06:19.636Z (about 1 month ago)
• Topics: events, real-time, websocket, wrapper
• Language: Go
• Homepage: https://bit.ly/simplysocket-docs
• Size: 44.9 KB
• Stars: 28
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SimplySocket

SimplySocket is a Golang package designed for pushing messages to clients and managing rooms and events. This package is a part of the Words Battle game project.

Checkout documentation :- [here](https://github.com/DhruvikDonga/simplysocket/wiki)

Checkout [wordsbattle multiplayer game](https://github.com/DhruvikDonga/wordsbattle) which uses simplysocket

- [SimplySocket](#simplysocket)

  - [Introduction](#introduction)

    - [Features](#features)

    - [Project Architecture](#project-architecture)

    - [Contributing](#contributing)

    - [License](#license)

  - [Documentation](#documentation)

## Introduction

SimplySocket is built for real-time communication with clients, efficiently managing message broadcasting, room creation, and event handling. It's designed to scale well for multiplayer games and similar applications that require synchronized messaging across clients.

### Features

- **Message Broadcasting:** Efficiently push messages to multiple clients.

- **Room Management:** Create, delete, and manage rooms for organized communication.

- **Event Handling:** Trigger and handle various events seamlessly.

### Project Architecture

check the [Project Architecure](projectstructure.md) file.

### Contributing

We welcome contributions! Please feel free to submit issues, pull requests, or suggestions.

### License

This project is licensed under the MIT License - see the LICENSE file for details.

## Documentation

For more detailed information, check the [Documentation](documentation.md) file.