NeoSocket

A fast websocket room api
View Demo · Report Bug · Request Feature

About The Project

This project wants to be something similar to Lucko's ByteSocks but written in Rust, making it faster and more efficient.

In summary this project allows clients to create like rooms where they can send messages to all the clients in the room, making it a good option for people who want to recreate a viewer like spark or luckperms one

Built With

• Rust
• Actix-rs
• Serde
• Tokio

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• rust

Building

Here you have the instructions to build and run the server.

1. Clone the repo

   git clone https://github.com/Angelillo15/neosocket.git

2. Build the project

   # to do a debug build
   cargo build
   # to do a release build (recommended)
   cargo build --release

3. Run the project

   # to run the project in debug mode
   ./target/debug/neosocket
   # to run the project in release mode (recommended)
   ./target/release/neosocket

(back to top)

Usage

Just install the project and run it. It will start a server on 0.0.0.0:2022 by default. You can change the port by setting the PORT environment variable and the host by setting the HOST environment variable.

(back to top)

License

Distributed under the GNU GPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

• Discord
• Email

(back to top)