Skip to content

Commit e31ba11

Browse files
committed
Updated DEVELOPMENT.md
1 parent a0f27f7 commit e31ba11

2 files changed

Lines changed: 70 additions & 47 deletions

File tree

DEVELOPMENT.md

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,76 @@
1-
# Building plugin
1+
# Development
22

3-
## step 1: build python-3.10.1
43

4+
## Building plugin (step by step)
5+
6+
Install requirements
7+
8+
Ubuntu/Debian:
9+
```bash
10+
$ sudo apt install qt5-default cmake gcc git-core
511
```
12+
13+
### step 1: create a empty project
14+
15+
Use a UNIGINE SDK Browser and create some empty project, for example `my_project`
16+
17+
*`my_project` folder - where you can see `data` and with `bin` and with `include` and launchers*
18+
19+
### step 2: clone the sources
20+
21+
Ubuntu/Debian:
22+
```bash
23+
$ cd my_project
24+
$ git clone https://github.com/unigine-plugins/unigine-editor-python3scripting
25+
$ cd unigine-editor-python3scripting
26+
$ cp -rf * ../
27+
```
28+
29+
### step 3: build python-3.10.1
30+
31+
Ubuntu/Debian:
32+
```bash
33+
$ cd my_project
634
$ cd UnigineEditorPlugin_Python3Scripting
735
$ ./build_python.sh
836
```
37+
38+
### step 4: build plugin
39+
40+
Ubuntu/Debian:
41+
```bash
42+
$ cd my_project
43+
$ cd UnigineEditorPlugin_Python3Scripting
44+
$ ./build_plugin.sh
45+
```
46+
47+
### step 5: run editor
48+
49+
After this call `./launch_editor.sh` or launch editor from `UNIGINE SDK Browser`
50+
51+
## Helpful links
52+
53+
- https://www.codeproject.com/Articles/820116/Embedding-Python-program-in-a-C-Cplusplus-code
54+
- https://docs.python.org/3.7/c-api/bytes.html
55+
- https://habr.com/ru/post/469043/
56+
- https://intermediate-and-advanced-software-carpentry.readthedocs.io/en/latest/c++-wrapping.html
57+
58+
Here can find wrappers:
59+
- https://github.com/Berenco/texworks
60+
61+
New type (class)
62+
- https://docs.python.org/3/c-api/typeobj.html
63+
- https://docs.python.org/3/c-api/typeobj.html#typedef-examples
64+
- https://docs.python.org/3.5/extending/newtypes.html
65+
66+
67+
Mp4 to gif
68+
- https://cloudconvert.com/mp4-to-gif
69+
70+
71+
## Generate Python Wrappers Classes
72+
73+
```
74+
$ python3 -m pip install CppHeaderParser
75+
$ ./generate_pytypeobjects.sh
76+
```

README.md

Lines changed: 0 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -16,49 +16,4 @@ Pluging for scripting by python3 in Unigine Editor https://unigine.com/get-unigi
1616

1717
[here](https://sea-kg.com/files/unigine-plugins/UnigineEditorPlugin_Python3Scripting/v2.14.1.1/)
1818

19-
## Build instruction
20-
21-
### Linux (Ubuntu)
22-
23-
```
24-
$ sudo apt install qt5-default python3 python3-dev
25-
```
26-
27-
*`unigine_project` folder - where you can see `data` and with `bin` and with `include` and launchers*
28-
29-
- Download this project via git or as zip
30-
- Copy `UnigineEditorPlugin_Python3Scripting` to your `unigine_project` folder
31-
- Copy `build_plugin.sh` to to your `unigine_project` folder
32-
- Open terminal in your `unigine_project` folder
33-
- chmod +x build_plugin.sh
34-
- ./build_plugin.sh
35-
36-
After this call `./launch_editor.sh` or launch editor from `UNIGINE SDK Browser`
37-
38-
## Helpful links
39-
40-
- https://www.codeproject.com/Articles/820116/Embedding-Python-program-in-a-C-Cplusplus-code
41-
- https://docs.python.org/3.7/c-api/bytes.html
42-
- https://habr.com/ru/post/469043/
43-
- https://intermediate-and-advanced-software-carpentry.readthedocs.io/en/latest/c++-wrapping.html
44-
45-
Here can find wrappers:
46-
- https://github.com/Berenco/texworks
47-
48-
New type (class)
49-
- https://docs.python.org/3/c-api/typeobj.html
50-
- https://docs.python.org/3/c-api/typeobj.html#typedef-examples
51-
- https://docs.python.org/3.5/extending/newtypes.html
52-
53-
54-
Mp4 to gif
55-
- https://cloudconvert.com/mp4-to-gif
56-
57-
58-
## Generate Python Wrappers Classes
59-
60-
```
61-
$ python3 -m pip install CppHeaderParser
62-
$ ./generate_pytypeobjects.sh
63-
```
6419

0 commit comments

Comments
 (0)