OpenCraft is not Warcraft III, but for those who's been waiting for Warcraft IV for many years, this project is for you. Targeting Next Generation RTS games while learning from Blizzard's design.
Fenix is part of OpenCraft project, a distributed server designed for https://github.com/sekkit/OpenCraft
A distributed game server featuring asynchronous event-driven networking, KCP/TCP/Websockets support. From MMORPG to small projects, Fenix is designed to be stable, simple, and super easy to scale. With the power of .NetCore, Fenix can be run on MacOS/Linux/Windows.
Fenix is in a early stage of development, but is also being used in commercial Game projects.
· 
·
·
· 
-
Run Unity3D and open Unity project at root path
-
Open Fenix.sln with Visual Studio 2019(.NetCore 3.1+ SDK installed)
-
Build solution
-
Go to ./bin folder, run start_redis.bat and start_server.bat
-
(Unity3d) Press play button in Unity OR (Native) Now build and run Client.App
- RPC decleration
//to tag a funtion with ServerApi, ServerOnly, ClientOnly you can create a RPC protocol without effort.
[RuntimeData(typeof(MatchData))]
public partial class MatchService : Service
{
public MatchService(string name): base(name)
{
}
public void onLoad()
{
}
//public new string UniqueName => nameof(MatchService);
[ServerApi]
public void JoinMatch(string uid, int match_type, Action<ErrCode> callback)
{
Log.Info("Call=>server_api:JoinMatch");
callback(ErrCode.OK);
}
[ServerOnly]
[CallbackArgs("code", "user")]
public void FindMatch(string uid, Action<ErrCode, Account> callback)
{
callback(ErrCode.OK, null);
}
}- Unified DB access API for both cache and storage with Distributed Lock.
Redis for cache and Rocksdb for persistency(also in redis protocol^^)
var db = Global.DbManager.LoadDb(DbConfig.account_db); //Create and get db
db.Set("PLAYER0001", userData);- Switch between KCP/TCP/websockets super easy (just open conf/app.json)
[
{
"AppName": "Login.App",
"ExternalIp": "auto",
"InternalIp": "auto",
"Port": 17777,
"DefaultActorNames": [
"LoginService"
],
"HeartbeatIntervalMS": 5000,
"ClientNetwork": "NetworkType.KCP"
}
]- Messagepack/Zeroformatter/Protobuf are easily supported
AutoGen takes care of serialization&deserializtion
//AUTOGEN, do not modify it!
using Fenix.Common;
using Fenix.Common.Attributes;
using Fenix.Common.Rpc;
using MessagePack;
using System.ComponentModel;
using Shared;
using Shared.Protocol;
using Shared.DataModel;
using System;
namespace Shared.Message
{
[MessageType(ProtocolCode.CHANGE_NAME_REQ)]
[MessagePackObject]
public class ChangeNameReq : IMessageWithCallback
{
[Key(0)]
public String name { get; set; }
[Key(199)]
public Callback callback
{
get => _callback as Callback;
set => _callback = value;
}
[MessagePackObject]
public class Callback
{
[Key(0)]
[DefaultValue(ErrCode.ERROR)]
public ErrCode code { get; set; } = ErrCode.ERROR;
}
}
}- Able to call Actors and Hosts through ActorRef anywhere
var svc = this.GetActorRef<LoginServiceRef>();
svc.rpc_login("username", "password", (code2, uid, hostId, hostName, hostAddress) =>
{
if (code2 != ErrCode.OK)
{
Log.Error("login_failed");
return;
}
Log.Info("login_ok");
//...
});- Architecture specifically designed for Game developers
Liteweight and easy to use than any other distributable server framework.
A Host is a container(Process) for many/single actors.
An Actor is an entity with state, able to make rpc calls, has its own lifecycle within the Host.
Scaling is achieved through multiprocesses, interprocess communication are mainly through Global cache or TCP/KCP networking.
Design principle comes from Bigworld, and microservices.
The simple, the better.
- State/Stateless Actor & Disaster Recovery & Access Control
using Fenix;
using Fenix.Common;
using Fenix.Common.Attributes;
using Shared.Protocol;
using System;
using Shared.DataModel;
namespace Server.UModule
{
[ActorType(AType.SERVER)] //this actor exists only in server side
[AccessLevel(ALevel.CLIENT_AND_SERVER)] //this actor can be accessed from both client/server
[RuntimeData(typeof(Account))] //Tag an actor with RuntimeData/PersistData, the DB saving process is taken care of.
//When disaster happens, the actor can be recovered from previous state
public partial class Avatar : Actor
{
public Client.AvatarRef Client => (Client.AvatarRef)this.client;
public Avatar()
{
}
public Avatar(string uid) : base(uid)
{
}
public override void onLoad()
{
}
public override void onClientEnable()
{
//向客户端发消息的前提是，已经绑定了ClientAvatarRef,而且一个Actor的ClientRef不是全局可见的，只能在该host进程上调用
this.Client.client_on_api_test("", (code) =>
{
Log.Info("client_on_api_test", code);
});
}
[ServerApi]
public void ChangeName(string name, Action<ErrCode> callback)
{
Get<Account>().uid = name;
callback(ErrCode.OK);
}
[ServerOnly]
public void OnMatchOk()
{
}
}
}We gladly accept community contributions.
- Issues: Please report bugs using the Issues section of GitHub
- Source Code Contributions:
- See C# Coding Style for reference on coding style.