sysvoid / talky Goto Github PK

#Welcome to Talky Talky is a C# project that I started. It is a part of my C# learning process. Please don't hate it. It's nice.

Here's a screenshot of the server and client.

#Client Use my Amazing Client to connect to this server.

#MySQL Upon initial connection, a MySQL configuration file is stored at C:\Talky\database.tcfg

#Configuration Here's the config format:

key:value

Don't put a space before or after the :.

##Adding Channels Configuration File: C:\Talky\channels.tcfg

The channel format is as follows:

NAME:LOBBY:LOCKED
==================
+NAME:true/false,true/false

Lobbies cannot be locked.

Normal channels can be locked.

Examples:

+CoolLobbyBro:true,false
+CoolChannelBro:false,true

Note that there can only be one lobby.

#Authentication This server comes with some sexy authentication.

Here's the MySQL table CREATE SQL thingy:

CREATE TABLE `users` (
  `id` bigint(30) unsigned NOT NULL AUTO_INCREMENT,
  `username` varchar(16) NOT NULL,
  `password` varchar(128) NOT NULL,
  `created_at` datetime NOT NULL,
  `last_login` datetime NOT NULL,
  `role` enum('admin','user') NOT NULL DEFAULT 'user',
  PRIMARY KEY (`id`),
  UNIQUE KEY `username_UNIQUE` (`username`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

Here are the commands:

/register <username> <password>
/auth <username> <password>

#Protocol Welcome to the Talky Protocol. It's so difficult, you might have a hard time learning it.

##Messages:

M:Message

##Commands:

M:/command args

##Ping (TBI):

P:PING

Response:

P:PING

Ping pong is boring, sorry.

##STAT: Stat returns information about whatever you request. It's that simple, really.

Here's how you get channels:

S:ChannelList

Here's the response:

S:ChannelList:channel1;channel2;channel3

Nice and simple.

Here's how you get channel clients:

S:ChannelClientList

Here's the response:

S:ChannelClientList:dude1;dude2;dudet1;dudet2

Nice and simple.

Here's how you get information about the currently connected client:

S:Client

Here's what it spits back:

S:Client:USERNAME;True/False;+Channel

You're probably sat there wondering about the True/False. It's simple. True = muted. Work out the False.

Here's how you get account information about the currently connected client:

S:Account

Here's the response if they are not authenticated:

... What are you expecting?

Here's the response if they are authenticated:

S:Account:ID;Username;Role

##Watch me make it maybe. I sometimes stream on Twitch.TV. Feel free to watch me there if I happen to be streaming or something.

##Contributing Follow my fucking code style or go away. Thanks. <3