# PHOENIXEngine

**Repository Path**: yongxing912/PHOENIXEngine

## Basic Information

- **Project Name**: PHOENIXEngine
- **Description**: PHOENIXEngine，这是一个可以用来开发机器人，游戏的引擎。集成Slam算法进行机器人室内导航，使用A*算法进行全局路径规划，使用DWA算法进行局部避障。
- **Primary Language**: C++
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://manykit.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 68
- **Created**: 2025-01-15
- **Last Updated**: 2025-01-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PHOENIXEngine

# **概况**

![avatar](Documentation/markdownfile/img/mframe.png)

	开源，跨平台，室内机器人引擎

	open soruce cross platform system for robots

	从PHOENIX3D游戏引擎发展而来，用用C++/Lua 作为开发环境

	致力于游戏技术与机器人技术的融合



# **版本**

	**版本：0.01

    功能完备的3D场景仿真渲染，UI组件等

    基于Windows和Liunx室内机器人自主定位建图，路径规划0.01版

	**版本：0.02

	增强壁障算法，使其运行可以避开障碍

	**版本:1.0.0

	基于插件式的Slam架构
	
	基于Controller的Lua面向对象逻辑架构（例比UnityEngine的Component）Robot->AIAgent->AIAgentBase->Controller(箭头代表派生自)

	增加音乐管理，闹钟等简单功能等

	增加全屏显示，Raspberry开机启动，电量显示等功能

	增加基础版本Snappy图形编程功能

	增加SnowBoy jarvis 离线语言唤醒功能

	**版本:1.5.0
	在原有项目的基础上，增加插件机制，使用Data/MANYKit作为机器人代码容器
	
	使用面向对象的Lua代码的Component结构，进行项目代码编写

# **演示网址**

开源地址 码云:https://gitee.com/manykit/PHOENIXEngine

依赖库地址 百度网盘：https://pan.baidu.com/s/1TXvzHCstj2v5uakM5lz-XA?pwd=kzgh 

依赖库放置目录:PHOENIXEngine/PHOENIX/

QQ交流群：336273110

网址: https://manykit.com

商城: https://shop194048616.taobao.com

PHOENIXFrame编程机器人: https://www.bilibili.com/video/BV1SK4y1P7Eo/?share_source=copy_web&vd_source=bd5737b5547d66c65824b24f44e3d7db

# **演示图片**

![avatar](Documentation/ShowImages/phoenixframe_pcb.png)

![avatar](Documentation/ShowImages/face.png)

![avatar](Documentation/ShowImages/code.png)

# **关于PHOENIXEngine**

	欢迎来到PHOENIXEngine，这是一个可以用来开发游戏，机器人，物联网项目的开发引擎。集成了HectorSlam，用来做为机器人室内导航。
	引擎已经支持Windows上，ARM，Linux，LinuxARM，iOS平台，使用简洁高效的Lua作为主要逻辑开发，使用C++/C作为底层构建语言。
	通过跨平台编译，可以将项目运行在所需要的平台上。
	借助Arduino，ESP8266/32等芯片，使用ManyKitArduino，引擎可以支持一般的物联设备开发。
	PHOENIXEngine只选择了最基本的两种语言C/C++和Lua。我们希望用户下载下路，编译即可运行。	

# **作者**
    
    引擎一直由 许多（ManyXu） 在开发维护

#  **编译/Compile**

### **Windows**

使用visual studio打开PHOENIXEngine/PHOENIX.sln编译,

平台配置选择OpenGLRelease|Win32或OpenGLDebug|Win32

如不编译，直接运行PHOENIXEngine/Bin/AppPlayerOpenGL.exe
	
### **Linux Raspberry**

1.配置
	进入目录PHOENIXEngine/PHOENIX/
	
	sudo sh ./linuxbuildconfigarm.sh

	遇到询问是否需要执行，键盘敲y

2.编译引擎库 libPX2Engine.so (注意这里不需要sudo):
	
	<!------如直接，运行已编译好的文件，跳过该步骤>

	sh ./linuxbuildarm.sh

3.编译Slam2D:

	<!------如直接，运行已编译好的文件，跳过该步骤>

	进入目录PHOENIX/PX2Engine/AI/Slam2D 运行

	sh linuxbuildarm.sh

4.安装引擎库:

	sudo sh ./linuxbuildinstallarm.sh

5.执行
	进入目录 PHOENIXEngine/Bin/

	<!------如直接，运行已编译好的文件，运行命令，增加运行权限
		sudo chmod 777 ./AppPlayer.ReleaseARMDynamic
	>
	
	在PHEONIXEngine/PHOENIX/Bin目录执行 ./AppPlayer.ReleaseARMDynamic
	
	树莓派默认OpenGL驱动没有激活，可以直接执行 ./AppPlayer.ReleaseARMDynamic window=0 以命令行运行程序

	若需要启动OpenGL驱动硬件加速，需使用sudo raspi-config进行修改，修改后，需使用hdmi显示屏幕，插针的屏幕将无法显示。

6.系统上电，自动启动配置[查看wiki](https://gitee.com/manykit/PHOENIXEngine/wikis/Home)系统启动时自动运行程序或脚本
	
### **Linux PC**

1.配置
	进入目录PHOENIXEngine/PHOENIX/

	sudo sh ./linuxbuildconfig.sh

2.编译引擎库libPX2Engine.so(注意这里不需要sudo):

	sh ./linuxbuild.sh

3.编译Slam2D:

	进入目录PHOENIX/PX2Engine/AI/Slam2D 运行

	sh linuxbuild.sh


4.安装引擎库:

	sudo sh ./linuxbuildinstall.sh

5.运行最终的可执行程序
	进入目录 PHOENIXEngine/Bin/
	
	执行 ./AppPlayer.ReleaseDynamic
	
1. 注意事项

	Linux中的串口需要一般在sudo模式下才能或许，执行脚本sudo sh linuxserialsudo.sh 可以将串口模式变为正常模式也可以读取（需要重新插拔usb线）

	如果出现例似如下错误：Syntax error: "(" unexpected。首先可以用命令ls -l /bin/sh 看看当前默认的是什么shell，Ubuntu一般默认为bash

    修改默认的shell，可以采用命令sudo dpkg-reconfigure dash。选择否。

### **Android**
	
	待续

### **IOS**

	使用XCode打开项目PHOENIX/Phoenix.xcworkspace编译项目，目前该配置比较老，未更新
	
# **更多内容**

	https://gitee.com/manykit/PHOENIXEngine/wikis/Home

# **版权信息/Licence**

	ManyKit开源协议1.0：
	PHOENIXEngine是一个开源开放的引擎，拥有免费版本和商业版本，开源版本只需要遵循较少的规则就可以免费用于商业开发，商业版本包含技术服务。协议声明如下：
	1.任何人，组织都可以自由修改引擎，免费应用于商业开发。
	2.使用PHOENIXEngine开源免费版本，必须在醒目位置标注PHOENIXEngine的商标，并且在软件中出现PHOENIXEngine开源协议，即本协议。
	3.用户开发的扩展包，可以选择开源或者闭源，对自己开发的开发包享有完全的自主控制权利，可自行决定是否收费，是否免费。
	4.许多米科技保留对PHONEIXEngine，PHOENIXFrame，MuBot的商标权。
	5.许多米科技保留对PHOENIXEngine引擎技术社区，插件管理，项目交流社区的独家开发使用权。
	6.使用PHOENIXEngine开发的商业产品（包含网络上销售的软件扩展包等），需允许许多米科技进行销售。产品需提供相关文档资料等以便销售。