NoahGameFrame

• develop
• master
• chat

#####QQ Group：341159815

What is NoahGameFrame?

NoahGameFrame (NF) is a lightweight, fast, scalable, distributed plugin framework. NF is greatly inspired by OGRE and Bigworld.

Features

• Easy-to-use, interface-oriented design
• An extensible plugin framework that makes getting your application running quick and easy
• A clean, uncluttered design and stable engine that has been used in several commercial products
• A high performance actor model (by Theron)
• Event and attribute-driven, making it clear and easy to maintain your business
• Based on standard C++ development, ensuring cross-platform support
• An existing C++ and C# game client for rapid development
• Cross-platform support

Tutorial && Documents

https://github.com/ketoo/NoahGameFrame/wiki

Client (Unity3D && Cocos2d)

Client

Architecture

App Architecture:

Server Architecture

Get the Sources:

git clone https://github.com/ketoo/NoahGameFrame.git

or

svn checkout https://github.com/ketoo/NoahGameFrame

Dependencies

• libevent 2.0.22
• easylogging++ 9.80
• mysql++ 3.2.2
• google protobuf 3.6
• redis-cpp-client
• Theron 6.00.01

IF YOU CAN NOT BUILD THE DEPENDENCIES THEN PLEASE RUN THE CMDS BELOW TO SET UP THE ENVIRONMENT:

• sudo apt-get g++
• sudo apt-get cmake
• sudo apt-get install automake
• sudo apt-get install zip unzip

Supported Compilers

• GCC >= 4.8 (Tested in Ubuntu 15.04)
• MSVC >= VS2015 (Tested in Win7/10)

Build and Install

MSVC >= 2015

1. Git pull all source
2. Open the solution: NoahFrame.sln, build FileProcessTool project
3. Run GenerateConfigXML.bat to generate configuration files
4. Open the solution: NoahFrame.sln
5. Build the solution(if u build failed, please build again(not rebuild))
6. Run the binary file by _Out/rund.bat

CMake ---- please use administrator(or sudo) to do these:

1. Git pull all source
2. Install cmake[>= 3.1] please choose options for installing: Add CMake to the system PATH for all users and restart your computer
3. Install VS2015 or gcc[>= 4.8]
4. Run Dependencies/build_dep.sh
5. Run install4cmake.bat or install4cmake.sh to build NF
6. Run the binary file by _Out/rund.bat or _Out/rund.sh

JAVA Project

WebSite: https://github.com/NFGameTeam/NFrame-java

C# Project

WebSite: https://github.com/ketoo/NFrame

License

The NFrame project is currently available under the Apache License.

Tutorial:

01-Hello world, add a module

// -------------------------------------------------------------------------
//    @FileName      	:    HelloWorld1.h
//    @Author           :    ketoo
//    @Date             :    2014-05-01 08:51
//    @Module           :   HelloWorld1
//
// -------------------------------------------------------------------------

#ifndef NFC_HELLO_WORLD1_H
#define NFC_HELLO_WORLD1_H

#include "NFComm/NFPluginModule/NFIPluginManager.h"

class HelloWorld1
    : public NFIModule
{
public:
    HelloWorld1(NFIPluginManager* p)
    {
        pPluginManager = p;
    }

    virtual bool Init();
    virtual bool AfterInit();

    virtual bool Execute();

    virtual bool BeforeShut();
    virtual bool Shut();

protected:

};

#endif


#include "HelloWorld1.h"

bool HelloWorld1::Init()
{
    // Use this for initialization
	
    std::cout << "Hello, world1, Init" << std::endl;

    return true;
}

bool HelloWorld1::AfterInit()
{
    // AfterInit is called after Init
	
    std::cout << "Hello, world1, AfterInit" << std::endl;

    return true;
}

bool HelloWorld1::Execute()
{
    // Execute is called once per frame
	
    //std::cout << "Hello, world1, Execute" << std::endl;

    return true;
}

bool HelloWorld1::BeforeShut()
{
    //before final
	
    std::cout << "Hello, world1, BeforeShut" << std::endl;

    return true;
}

bool HelloWorld1::Shut()
{
    //final
	
    std::cout << "Hello, world1, Shut" << std::endl;

    return true;
}

02-Hello world, test data driver

• how to use the world's most advanced data engine

03-Hello world, test heartbeat and event system

• how to use the synchronous events

04-Hello actor, test actor model(async event system)

• how to use the asynchronous events
• use multiple cpus to get high performance

How to Create a New LuaScriptModule

Step 1

Create a Lua Script File, and Must Contain following functions

• reload()
• awake()
• init()
• ready_execute()
• after_init()
• before_shut()
• shut()

Mostly like this

test_module.lua

test_module = {}
register_module(test_module,"test_module");

function test_module.reload()
end

function test_module.awake()
	reload();
end

function test_module.init()
end

function test_module.after_init()
end

function test_module.ready_execute()
end

function test_module.before_shut()
end

function test_module.shut()
end

##Step 2 Add your LuaScriptModule Infomation into script_list.lua

ScriptList={
    {tbl=nil, tblName="TestModule"},
    {tbl=nil, tblName="TestModule2"},
}

load_script_file(ScriptList)

##Hot fix Add your lua script file name on here script_reload.lua

About The Author

• Mail: 342006@qq.com
• BBS: http://bbs.noahframe.com

Amazing open source projects:

breeze

• Auther: zsummer
• Github: https://github.com/zsummer/breeze
• Description:A fast, scalable, distributed game server framework for C++

gce

• Auther: nousxiong
• GitHub: https://github.com/nousxiong/gce
• Description: The Game Communication Environment (GCE) is an actor model framework for online game development.