Skip to content

Commit ae45243

Browse files
authored
Update README.md
1 parent 23229af commit ae45243

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
1-
# GChat
1+
# GChat - Global Chat
22
GChat is a multi-client chat application with a login system. Packets are sent using a TCP connection.
33
It supports 2 types of clients, a chat client and a SAMP (0.3.7 R1) client. Every message that starts with a dot '.' will be forwarded to the GChat Server.
44

55
It includes GNet library which is a wrapper around system's sockets.
6+
7+
## FEATURES
8+
- Login system (local SQLite database)
9+
- Privilege system (Admin(2), Moderator(1), Default(0))
10+
- Commands based on privilege
11+
*) default commands: help, list, logout, login, disconnect
12+
*) staff commands: adduser, removeuser, kick
13+
- Chat between gameservers, games, operating systems
14+
- Chat competely private, only visible to those on the same GServer! Ideal for groups and clans, and communities spanning on different servers
15+
16+
## SERVER SETUP
17+
*) If LAN server go to step 2)
18+
1) Open 9920 port for TCP connections
19+
2) Run the server, it will prompt you to enter the first user (you) and it'll be given Admin privilege.
20+
3) You may login using the crediantals you provided, using the /adduser command you may add new users
21+
22+
## SAMP CLIENT SETUP ( 0.3.7 R1 supported only )
23+
1) Place .asi file in your SAMP directory. Once you run the game a gc-config.ini file will be created, in this config file you will put the ip, port, your username, your password, if the server is using a hostname (URL - google.com) you will change useHostname to true.
24+
2) Run the game, it should say "GChat initialized"
25+
3) Use dot ('.') before your messages to forward them to the GServer you're connected on

0 commit comments

Comments
 (0)