Loom SDK for Cocos Creator

Content:

• English

• Prerequisites
• Loom Cocos SDK
• Generate LoomJS SDK
• Install Loom
• Install Cocos Creator
• Integrate to Creator Game
• Sample
• Notice

• 中文

• 环境依赖
• Loom Cocos SDK
• 打包并生成 Loom Cocos SDK
• 安装 Loom
• 安装 Cocos Creator
• Creator Game 内集成调用
• Sample
• 说明

Prerequisites

1. Python 2.7
2. Git
3. NodeJS, NPM
4. Loom, Install Steps
5. Cocos Creator

Loom Cocos SDK

Loom global structure diagram

Loom Cocos SDK structure diagram

Loom-Cocos-SDK have same api, same protobuf, similar contract with loom-js.

Loom Cocos SDK is base on Loom-JS , and proting it to Cocos Creator .

Generate LoomJS SDK

• git submodule update --init, update git submodule
• ./tools/genCocoSDK.py

Loom SDK for Cocos Creator is the directory loom-cocos-sdk, which is generated by command ./tools/genCocoSDK.py

Install Loom

wget https://storage.googleapis.com/private.delegatecall.com/loom/osx/build-128/loom
chmod +x loom

mkdir tmpgopath
export GOPATH=`pwd`/tmpgopath
./loom spin weave-blueprint
cd blueprint
export GOPATH=$GOPATH:`pwd`
make deps
make
cd build

../../loom init
cp ../genesis.example.json genesis.json

Run Blockchain:

# unable to start http server: listen tcp 127.0.0.1:9092: bind: address already in use
pkill blueprint # kill server first
../../loom run

Please consult the Loom SDK docs for further instruction on running your own DappChain.

Install Cocos Creator

Cocos Creator is a complete package of game development tools and workflow, including a game engine (based on Cocos2d-x), resource management, scene editing, game preview, debug and publish one project to multiple platforms.

For the first time we introduced entity-component structure and data-driven workflow to the Cocos2d-x family. With JavaScript, you can scripting your component in no time. The editor and engine extension is also made with JavaScript so you can make games and refine your tool in a single programming language.

Cocos Creator provides an innovative, easy to use toolset such as the UI system and Animation editor. The toolset will be expanding continuously and quickly, thanks to the open editor extension system.

you can download Cocos Creator from here , and install.

Integrate to Creator Game

1. copy the generated Loom Cocos SDK to your project's asset/script directory, and rename it to loom
2. write your own proto file as requirements of your game e.g. sample/loomDemoForCreator use setscore.proto, and related setscore_pb.js
3. write yur own contract as requirements of your game, and serailezse your data with setscore_pb.js, and send to Loom Blockchain, take a look at SimpleContract

4. invoke api of your contract at suitable position.
5. Run

Sample:

there have two Sample project:

• loomDemoForCreator simplely use loom sdk
• dark-slash use loom sdk in a real game

Test Steps

• update git submodule, run command git submodule update --init, if you have done this, skip this.
• generate and pack Loom Cocos SDK, run command ./tools/genCocoSDK.py
• sync Loom Cocos SDK to sample/loomDemoForCreator and sample/dark-slash, run command ./tools/syncLoomJSToSample.py
• entry directory blueprint/build, run Loom Block Chain services, run command ../../loom run, if you have done this, skip this.
• open sample/loomDemoForCreator or sample/dark-slash with Cocos Creator and run

Notice

• Loom Block Chain configuration, Contract's usage, take a look at this
• Sample dark-slash come from Cocos Creator Tutorial Project

环境依赖:

1. Python 2.7
2. Git
3. NodeJS, NPM
4. Loom, Install Steps
5. Cocos Creator

Loom Cocos SDK 介绍

Loom 全局结构如下:

Loom Cocos SDK 软件结构如下:

由图可见, Loom-Cocos-SDK 与 loom-js 使用相同的API, 相同的 protobuf 文件, 基本类似的合约写法。

Loom Cocos SDK 是基于 Loom-JS 而移植到 Cocos Creator 上.

打包并生成 Loom Cocos SDK

• git submodule update --init, 更新 git 子工程， 如果已更新可以跳过
• 运行命令 ./tools/genCocoSDK.py

./tools/genCocoSDK.py 会在工程根目录下生成的 loom-cocos-sdk 目录, 这就是 Loom SDK 在 Cocos Creator 上的适配包

安装 Loom

wget https://storage.googleapis.com/private.delegatecall.com/loom/osx/build-128/loom
chmod +x loom

mkdir tmpgopath
export GOPATH=`pwd`/tmpgopath
./loom spin weave-blueprint
cd blueprint
export GOPATH=$GOPATH:`pwd`
make deps
make
cd build

../../loom init
cp ../genesis.example.json genesis.json

运行 Blockchain

../../loom run

更多详情介绍参见Loom SDK docs.

安装 Cocos Creator

Cocos Creator是以内容创作为核心的游戏开发工具，在Cocos2d-x基础上实现了彻底脚本化、组件化和数据驱动等特点。

Cocos Creator基于开源框架Cocos2d-x，实现了一体化、可扩展、可自定义工作流的编辑器，并在Cocos系列产品中第一次引入了组件化编程思想和数据驱动的架构设计，这极大地简化了Cocos2d-x开发工作流中的场景编辑、UI设计、资源管理、游戏调试和预览、多平台发布等工作，是使用Cocos2d-x进行团队协作开发的最佳选择。

在 这里 下载最新的 Cocos Creator 安装即可.

Creator Game 内集成调用

1. 将上一步中打包生成好的 Loom Cocos SDK 放到工程的 script 目录下, 重命名为 loom
2. 根据你的游戏的需求编写自己的 proto 文件, 然后用 protoc 生成对应的 js 文件 e.g. 本例中使用的是 setscore.proto, 及对应生成的 setscore_pb.js
3. 编写适应自己游戏需求的合约, 使用上一步中的 setscore_pb.js 将数据序列化, 并将数据发往 DappChain, 参见 SimpleContract

4. 在你的游戏中需要的位置调用上一步中的接口.
5. 运行, 检查

Sample:

本工程中有带有两个 Sample:

• loomDemoForCreator 简单直接的调用合约接口, 更偏向于功能测试与只关注使用方式
• dark-slash 以更真实的游戏的方式来调用合约接口

测试步骤:

• 更新 git 子工程, 运行 git submodule update --init, 已更新的话，可以跳过
• 生成并打包 Loom Cocos SDK, 运行 ./tools/genCocoSDK.py
• 同步生成好的包到 sample/loomDemoForCreator, sample/dark-slash, 运行 ./tools/syncLoomJSToSample.py
• 切换到 blueprint/build 目录, 运行 Loom Block Chain 服务, 运行 ../../loom run, 已运行，可以跳过
• 用 Cocos Creator 打开 sample/loomDemoForCreator 或 sample/dark-slash, 运行

说明

• Loom Block Chain Server 的配置, 运行, 合约的使用, 参见这里
• Sample dark-slash 来自于 Cocos Creator 的样例工程