gamesserver / gophergameserver

Gopher Game Server is a full featured, fast, and fully customizable game server written in Go. Comes with a client API for JavaScript and soon Java.

Gopher Game Server

Gopher Game Server is designed to provide all necessary tools to greatly ease developments of any type of online game (or any real-time app/chat). Gopher will handle all server-side synchronizing and data type conversions, therefore, client actions receiving, variable setting, messaging, and other functionalities are unproblematic.

Moreover, Gopher has a built-in, fully customizable SQL client authentication mechanism that creates and manages users' accounts for you. It even ties in a friending tool, so users can befriend and invite one another to groups, check each other's status, and more. All components are easily configurable and customizable for specific project's needs.

Main features:

• Super easy and flexible APIs for server, database, and client coding
• Chat, private messaging, and voice chat
• Customizable client authentication (*)
• Built-in Friending (*)
• Supports multiple connections on the same User
• Server saves state on shut-down and restores on reboot
• Tools provided for administrating server while running

(*) A MySQL (or similar SQL) database is required for the authentication/friending feature, but is an optional (like most) feature that can be enabled or disabled to use your own implementations.

Client APIs

• JavaScript: GopherClientJS
• Java: GopherClientJava

If you want to make a client API in an unsupported language and want to know where to start and/or have any questions, feel free to email me!

Installing

Gopher Game Server requires at least Go v1.8+ (and MySQL v5.7+ for the authentication and friending features).

First, install the dependencies:

go get github.com/gorilla/websocket
go get github.com/go-sql-driver/mysql
go get golang.org/x/crypto/bcrypt

Then install the server:

go get github.com/hewiefreeman/GopherGameServer

Usage

Table of Contents

1. Getting Started
   • Set-Up
   • Core Server Settings
   • Server Callbacks
   • Macro Commands
2. Rooms
   • Room Types
   • Room Broadcasts
   • Room Callbacks
   • Creating & Deleting Rooms
   • Room Variables
   • Messaging
3. Users
   • Login & Logout
   • Joining & Leaving Rooms
   • User Variables
   • Initiating and Revoking Room Invites
   • User Status
   • Messaging
4. Custom Client Actions
   • Creating a Custom Client Action
   • Responding to a Custom Client Action
5. Saving & Restoring
   • Set-Up
6. SQL Features
   • Set-Up
   • Authenticating Clients
   • Custom Account Info
   • Customizing Authentication Features
   • Auto-Login (Remember Me)
   • Friending

Documentation

Package gopher - Main server package for startup and settings

Package rooms - Package for using the Room, RoomType, and RoomUser types

Package users - Package for using the User type

Package actions - Package for making custom client actions

Package database - Package for customizing your database

Contributions

Contributions are open and welcomed! Help is needed for everything from documentation, cleaning up code, performance enhancements, client APIs and more. Don't forget to show your support by starring or following the project!

If you want to make a client API in an unsupported language and want to know where to start and/or have any questions, feel free to email me!

Please read the following articles before submitting any contributions or filing an Issue:

• Contribution Guidlines
• Code of Conduct