byop

command module
v0.0.0-...-4a967fc Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 31, 2018 License: BSD-2-Clause Imports: 6 Imported by: 0

README

Bring Your Own Playground (BYOP)

BYOP is a Go implementation of a host it yourself private chat server where you can chat and challenge your friends for a quick game.

Status
Installation
go get github.com/gorilla/websocket

go get github.com/anthonyho007/BYOP
Usage

After cloning / downloading the repository, you can start the server by:

export PORT=8000

go run main.go

then open http://localhost:8000 to access the chat server

Chating

In the chat, you can use the following commands to perform different actions:

Show the name of the current chatroom and all the users in the chatroom:
    /show

List all available chatrooms:
    /list-chats

List all online users:
    /online

Enter a chatroom:
    /enter-chat <Chatroom_Name>

Create a chatroom:
    /create-chat <Chatroom_Name>

Invite friends into a private chatroom:
    /talk <username1> <username2> <username3>
Ideas

The idea came from when me and a bunch of friends staying over at a place with no internet. At that moment, we have no cards nor board games. Then I realize that its a good idea to have host a private server for a LAN party LOL ...

Development Status
  • Chat Server : Done

  • UI phase 1 : Done

  • Mini game on Chat server : Working hard / in progress

  • UI phase 2 : Not yet implemented

  • Persistent message broker : Not yet implemented

  • P2P game challenge : Not yet implemented

  • New Features: TBD

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL