Skip to content

Commit

Permalink
add readme for packing
Browse files Browse the repository at this point in the history
  • Loading branch information
lxk121lalala committed Dec 7, 2023
1 parent daa267b commit 5b63f04
Show file tree
Hide file tree
Showing 16 changed files with 108 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

*.zip
54 changes: 54 additions & 0 deletions Media/Pack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Packaging for Windows With Our Plugins
English | [中文](./Pack_CN.md)
## Introduction

Currently only c++ projects are supported for packaging, see 1.1

If it is a blueprint project, it needs to be converted to c++ project first, see 1.2

In the future, direct blueprint project packaging will be supported


## 1.1 Packing c++ UE projcet
### a. Set the game default map

<img src="image/pack/a1.png" width="800" />

### b. pack

<img src="image/pack/a2.png" width="800" />


<img src="image/pack/a3.png" width="800" />



## 1.2 Converted BP project to c++ project

### a. add c++ class

<img src="image/pack/b1.png" width="800" />

<img src="image/pack/b2.png" width="800" />

<img src="image/pack/b3.png" width="800" />

<img src="image/pack/b4.png" width="800" />


### b. close UE, open with visual studio

<img src="image/pack/b5.png" width="800" />

<img src="image/pack/b6.png" width="800" />

**_NOTE:_** Visual Studio will start automatically when adding a C++ class. If not, please start it manually in the project directory.


<img src="image/pack/b7.png" width="800" />

## Contributors

<a href="https://github.com/xverse-engine/XV3DGS-UEPlugin/graphs/contributors">
<img src="https://contrib.rocks/image?repo=xverse-engine/XV3DGS-UEPlugin" />
</a>
52 changes: 52 additions & 0 deletions Media/Pack_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 如何使用我们的插件打包WINDOWS程序

## 简介

目前只支持c++工程进行打包,见1.1
如果是蓝图工程,需要先转换成c++工程,见 1.2
后续会支持直接蓝图使用工程打包

[English](./Pack.md)| 中文
## 1.1 c++工程打包
### a. 设置默认地图关卡

<img src="image/pack/a1.png" width="800" />

### b. 打包

<img src="image/pack/a2.png" width="800" />


<img src="image/pack/a3.png" width="800" />



## 1.2 蓝图工程转换成c++工程

### a. 添加c++ class

<img src="image/pack/b1.png" width="800" />

<img src="image/pack/b2.png" width="800" />

<img src="image/pack/b3.png" width="800" />

<img src="image/pack/b4.png" width="800" />


### b. 关闭UE窗口,用visual studio打开

<img src="image/pack/b5.png" width="800" />

<img src="image/pack/b6.png" width="800" />

注意:通常情况下,Visual Studio会在添加c++类时自动启动。如果没有,请在项目目录中手动启动。


<img src="image/pack/b7.png" width="800" />

## Contributors

<a href="https://github.com/xverse-engine/XV3DGS-UEPlugin/graphs/contributors">
<img src="https://contrib.rocks/image?repo=xverse-engine/XV3DGS-UEPlugin" />
</a>
Binary file added Media/image/pack/a1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/image/pack/a2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/image/pack/a3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/image/pack/b1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/image/pack/b2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/image/pack/b3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/image/pack/b4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/image/pack/b5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/image/pack/b6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/image/pack/b7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed demo/Plugin_XV3dGS_ue5.1_v1.0.zip
Binary file not shown.
Binary file removed demo/Plugin_XV3dGS_ue5.2_v1.0.zip
Binary file not shown.
Binary file removed demo/Plugin_XV3dGS_ue5.3_v1.0.zip
Binary file not shown.

0 comments on commit 5b63f04

Please sign in to comment.