Skip to content

Commit 4ff2b8d

Browse files
anpawoanpawo
committed
docs: information about the program + patch notes
1 parent 317bed8 commit 4ff2b8d

File tree

7 files changed

+130
-8
lines changed

7 files changed

+130
-8
lines changed

‎README.md‎

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,79 @@
11
# Video-Code
2-
The goal of this project is to create videos with code.
2+
The initial goal of this project is to create videos from code.<br>
3+
I've always wanted to create millimetric videos and I will be able to, soon enough.
4+
5+
The second thought is that such thing can be used to automate the generation of video.<br>
6+
AI have a hard time with designs, they are better with code, they could potentially take advantage of this project to generate videos with a good quality and a logical flow.
7+
8+
Thirdly, I want the program to have a visual interface like any other video editing app but I want it to be automatically generated from the Python API.<br>
9+
With a code and a visual interface, anyone can make videos according to their liking.
10+
11+
## Getting Started with Video-Code
12+
To create a video with Video-Code, you need to write some simple code in Python.
13+
14+
The flow of the Video comes from the __Inputs__ that you, first import or create, then modify with __Transformations__ and finally add to the __timeline__.
15+
16+
To import or create an __Input__, you need to create a __video__ or __image__ instance (soon text and shapes).<br>
17+
To modify it, you need to use __Transformations__ like __translate__ or __fade__.<br>
18+
To add the frames of the __Input__ to the timeline, use the __\<Input\>.add()__ function.
319

420
Below is an example of the last feature added (code) and the result (video).
521

22+
623
```py
7-
from frontend.VideoCode import *
24+
from videocode.VideoCode import *
825

926

1027
v1 = video("video/v.mp4")
1128

29+
30+
v1[0:40].apply(move(200, 0))
1231
v1[0:20].apply(fadeIn()).add()
1332
v1[20:40].apply(fadeOut()).add()
1433
```
1534

35+
1636
<img src="docs/readme/example.gif" style="width: 50%;">
37+
38+
## Patch Notes
39+
40+
41+
<details open>
42+
<summary><code>Inputs</code></summary>
43+
<br>
44+
45+
- `image`
46+
- `video`
47+
48+
</details>
49+
50+
<br>
51+
52+
<details open>
53+
<summary><code>Transformations</code></summary>
54+
<br>
55+
56+
- `fade`
57+
58+
<br>
59+
60+
- `translate`
61+
- `move`
62+
63+
<br>
64+
65+
- `overlay`
66+
67+
</details>
68+
69+
<br>
70+
71+
<details open>
72+
<summary><code>Patchs</code></summary>
73+
<br>
74+
75+
- `rework`: position of the frames (02/03/25)
76+
- `transformation`: move (02/03/25)
77+
78+
</details>
79+

‎docs/readme/01_header.md‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎docs/readme/01_introduction.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Video-Code
2+
The initial goal of this project is to create videos from code.<br>
3+
I've always wanted to create millimetric videos and I will be able to, soon enough.
4+
5+
The second thought is that such thing can be used to automate the generation of video.<br>
6+
AI have a hard time with designs, they are better with code, they could potentially take advantage of this project to generate videos with a good quality and a logical flow.
7+
8+
Thirdly, I want the program to have a visual interface like any other video editing app but I want it to be automatically generated from the Python API.<br>
9+
With a code and a visual interface, anyone can make videos according to their liking.
10+
11+
## Getting Started with Video-Code
12+
To create a video with Video-Code, you need to write some simple code in Python.
13+
14+
The flow of the Video comes from the __Inputs__ that you, first import or create, then modify with __Transformations__ and finally add to the __timeline__.
15+
16+
To import or create an __Input__, you need to create a __video__ or __image__ instance (soon text and shapes).<br>
17+
To modify it, you need to use __Transformations__ like __translate__ or __fade__.<br>
18+
To add the frames of the __Input__ to the timeline, use the __\<Input\>.add()__ function.
19+
20+
Below is an example of the last feature added (code) and the result (video).

‎docs/readme/02_code.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11

22
```py
3-
from frontend.VideoCode import *
3+
from videocode.VideoCode import *
44

55

66
v1 = video("video/v.mp4")
77

8+
9+
v1[0:40].apply(move(200, 0))
810
v1[0:20].apply(fadeIn()).add()
911
v1[20:40].apply(fadeOut()).add()
1012
```

‎docs/readme/04_patch_notes.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Patch Notes
2+
3+
4+
<details open>
5+
<summary><code>Inputs</code></summary>
6+
<br>
7+
8+
- `image`
9+
- `video`
10+
11+
</details>
12+
13+
<br>
14+
15+
<details open>
16+
<summary><code>Transformations</code></summary>
17+
<br>
18+
19+
- `fade`
20+
21+
<br>
22+
23+
- `translate`
24+
- `move`
25+
26+
<br>
27+
28+
- `overlay`
29+
30+
</details>
31+
32+
<br>
33+
34+
<details open>
35+
<summary><code>Patchs</code></summary>
36+
<br>
37+
38+
- `rework`: position of the frames (02/03/25)
39+
- `transformation`: move (02/03/25)
40+
41+
</details>

‎docs/readme/example.gif‎

373 KB
Loading

‎docs/readme/generate.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ printf '\n%s\n%s\n%s\n' '```py' "$(cat video.py)" '```' > "$README_CODE"
1414
ffmpeg '-i' output.mp4 "$README_GIF" '-y'
1515

1616
# concatenate the files
17-
cat docs/readme/*.md > README.md
17+
(for file in docs/readme/*.md; do cat "$file"; echo; done) > README.md

0 commit comments

Comments
 (0)