qiciengine / qiciengine-documentation

QICI Engine documentation for API and user manuals

QICI Engine (青瓷引擎中文)

• Introduction
• Technology Stack
• Features
• Getting Started
• Documentation
• Examples
• Opening Issues
• Contributing
• Changelog
• Stay In Touch
• License

Introduction

QICI Engine is a free and open source JavaScript game engine library with a web-based comprehensive suite of toolset for making HTML5 games.

With QICI Engine, creating HTML5 Games just like Web Development, use your favorite code editor, use your favorite web browser, leverage JavaScript language and all the best web development tools. QICI Engine takes care of the complexity of the underlying technologies, so you just focus on what's important - making your game!

Technology Stack

QICI Engine is based on the free and open source HTML5 game framework Phaser, which uses Pixi.js for WebGL and Canvas rendering across desktop and mobile web browsers.

Phaser is actively developed and maintained by @photonstorm, but QICI Engine uses the specific version Phaser 2.3.0. We keep track of bug fixes and performance improvements for Phaser, so you can use the customized Phaser version that QICI Engine provides safely.

QICI Engine is made up of three parts: QICI Core, QICI Widget and QICI Editor:

• QICI Core: A JavaScript Game Engine library that is based on Phaser.
• QICI Widget: A JavaScript UI library for creating rich application.
• QICI Editor: A web-based editor with a Node.js server for accelerating HTML5 game development.

The QICI Core is the core of QICI Engine, the QICI Editor would not work without it, but the QICI Core can function on its own to be used to make a HTML5 Game by writing code without QICI Editor. But for complex UI, it’s really hard to build and maintain without the help of WYSIWYG visual interface, with QICI Editor even artists and designers can help to build the game’s UI.

QICI Widget provides the HTML5 UI widgets for making the GUI in QICI Editor.

QICI Core is a JavaScript Game library, QICI Widget is a JavaScript UI library, and QICI Editor uses Node.js for accessing the file system, so QICI Engine is a Full-Stack JavaScript Game Engine.

Features

• QICI Core
  • WebGL and Canvas rendering support
  • UI Components: Toggle, Slider, ProgressBar, ScrollView, List, Table, etc.
  • Rect Transform UI Layout
  • DragonBones skeleton animation data format support
  • NinePatch image
  • NodeMask and Filter effect
  • Mixing Dom and Canvas
  • Web fonts and Bitmap fonts
  • JSON Tiled map editor file support
  • Web Audio and Audio Tag
  • Tween animation
  • Behavioural oriented architecture
  • Asset Management
  • Serialization with scene and prefab
  • Mouse, Keyboard and Touch support
  • Import data from Excel
  • Plugin system with official plugins like Arcade Physics and Lock Orientation
• QICI Editor
  • Project Management
  • Scene Management
  • Hierarchy panel, Scene panel and Inspector panel
  • Texture atlases
  • Frame Animation
  • Editing tween curve
  • Editing NinePatch
  • Import and preview skeleton animation
  • Extending Editor
  • Project settings
  • Publishing Project

You can even run QICI Editor in your mobile device browsers:

Getting Started

• Follow the Installation Guide to install Node.js and the latest QICI Editor.
• Read the Project Management Guide to create a new project.
• Read the Scene Editing Guide to create a new scene.
• Read the UI and Components Guide to add some components on the scene.
• Press the "Run" button from the Toolbar or select the "Edit/Preview(WebGL)" item from the Main Menu to play and test the game.

Documentation

The website’s documentation is divided into multiple sections.

• There are Guides that discuss topics like Using Editor, UI and Components, Official Plugins and Extending Editor.
• The API Documentation for QICI Core
• The Demo Guides teaching you to build the demo step by step.
  • To be continued...

Examples

A wide range of source code examples for you to explore. Download all in one zip file.

Opening Issues

If you encounter a bug with QICI Engine we would like to hear about it. Search the existing issues and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of QICI Engine and browser you’re using. Please include a stack trace and reduced repro case when appropriate, too.

QICI Engine issues are intended for bug reports and feature requests. For help and questions with using QICI Engine please make use of our Ask forum. If you want to hang out and chat about game dev in general, please join our slack channel in Stay In Touch section.

Contributing

• QICI Engine Core: https://github.com/qiciengine/qiciengine-core
• QICI Engine Documentation: https://github.com/qiciengine/qiciengine-documentation
• QICI Engine Examples: https://github.com/qiciengine/qiciengine-examples
• QICI Engine Cookbook: https://github.com/qiciengine/qiciengine-cookbook
• Lightweight Game Server: https://github.com/qiciengine/qiciengine-server

Everybody is welcomed to report issues or pull requests for all the GitHub repositories mentioned above.

Changelog

Details changes for each release are documented in the release notes. We recommend you use the latest version of QICI Engine.

Stay In Touch

If you have questions with using QICI Engine please visit our Ask forum, We will answer your questions ASAP.

If you use Slack and would like to join the QICI Engine channel then please [drop us an email](mailto:[email protected]?subject=Slack Invite&body=Please invite me to the QICI Engine slack channel.%0A%0AMy%20email%20address%20is%3A%20___%0AMy%20first%20name%20is%3A%20___%0AMy%20last%20name%20is%3A%20___). All we need is your email address, first name and last name and then we can send you an invite to the channel.

If you want to keep up to date with the latest QICI Engine news then just follow us on Twitter and we will keep you posted!

For more Information, please visit our official QICI Engine webstie or Chinese website.

If you have any questions or if there is something we didn’t cover, please feel free to contact me at email or Twitter.

License

QICI Engine is released under the MIT License.

qiciengine-documentation's Issues

[Q]Struggle to understand `gameObject`s, Components, `Node`s and `Behaviour`s.

This might be my lack of understanding but I do find confusion in the ui and documentation around the terms gameObjects, Components, Nodes and Behaviours.

For example the documentation calls GameObjects components. In the UI you find the objects under the 'GameObject' Menu Item. Which makes sense because all those objects inherit from qc.Node which is gameobjects/components.

But now in the inspector under the Node section you can 'Add Component'. But this actually adds qc.Behaviour. So should the button not be called 'Add Behaviour' instead?

I understand 'Add component' basically does a qc.Node.addScript which explicitly check that the script is an instance of qc.Behaviour.

qc.Behaviour Does not seem to inherit from qcNode so it is not a gameobject or component?

So the question I'm trying to get to is my understanding kind of correct?

If so should 'Add Component' Button not be changed to 'Add Behaviour'?

This will also need a couple of renames in the docs I'm willing to do.

Later,

Manual and API 404

Hi

The links from the main http://www.qiciengine.com/ page for the Manual and API gives a 404 if you follow them. But it seems the manual is still avail via http://docs.qiciengine.com, but I can not find the API.

It would be sad if qici docs lost its Google Ranking because atm I can google "qici behaviour api" to get to the correct page. I'm aware I can run the docs offline, but googling is so much easier.

If you need any assistance in restoring the manual, please let me know.

Thanks,

Offline Documentation

Hi,

Sorry if it is obvious, but how do you build the documentation for offline viewing?

Creaet

Hi,

There is a Creaet typo, should be Create. Wanted to fix it using github but there is
26 typos so it would be easier for someone who has the docs checked out.

Regards,