Skip to content

Commit 63ade8a

Browse files
committed
improved wiki and readme
1 parent 4bb8f65 commit 63ade8a

5 files changed

Lines changed: 33 additions & 74 deletions

File tree

README.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,46 @@
1-
Renthyl is a modular FrameGraph-based rendering pipeline designed with efficiency in mind.
1+
2+
# Renthyl
23

34
[![](https://jitpack.io/v/codex128/Renthyl.svg)](https://jitpack.io/#codex128/Renthyl)
45

5-
## Features
6+
![VXGI-demo](resources/VXGI-demo.png)
67

8+
Renthyl is a modular, code-first, and completely customizable rendering pipeline for JMonkeyEngine suitable for any game. It is designed to be as fast as possible by culling unnecessary render operations and minimizing resource creation.
79

10+
Renthyl is currently in alpha status: there may be bugs. If one is encountered, please open an issue, and include stacktraces, example code, and screenshots if applicable. Also note that many features within the RenthylPlus subproject are work-in-progress.
811

9-
* Allows for the use of modern rendering paradigms, such as deferred and forward++.
10-
* Code-first design makes constructing and manipulating FrameGraphs incredibly easy.
11-
* Easily control the layout of the FrameGraph using game logic.
12-
* Designed to be totally savable, so FrameGraphs can be saved and loaded from files.
13-
* Culling algorithm ensures unnecessary operations are skipped.
14-
* Resource manager minimizes the creation and binding of resources by reallocating resources where possible.
15-
* Allows for stress-free multithreading.
16-
* Tree-like Structure allows individual groups of passes to be exported and shared.
12+
Contributors are welcome and wanted! If you have the know-how, consider implementing a rendering technique in the RenthylPlus subproject.
1713

1814
## Get Started
1915

20-
1. Add Renthyl to your Gradle build script.
16+
1. Add Renthyl to your Gradle build script. Renthyl depends on Java 8 and JMonkeyEngine 3.8 minimum, along with some other libraries.
2117

22-
```groovy
23-
dependencies {
24-
implementation "com.github.codex128:Renthyl:1.2.3"
25-
}
26-
```
27-
Make sure you add Jitpack as a repository:
2818
```groovy
2919
repositories {
30-
maven {
31-
url "https://jitpack.io"
32-
}
20+
maven {
21+
url "https://jitpack.io"
22+
}
23+
}
24+
dependencies {
25+
implementation "com.github.codex128:RenthylCore:v1.2.5"
26+
implementation "com.github.codex128:RenthylCore:v1.2.5:sources"
27+
implementation "com.github.codex128:RenthylCore:v1.2.5:javadoc"
3328
}
3429
```
3530

3631
2. Initialize Renthyl in your JMonkeyEngine application.
3732

3833
```java
3934
Renthyl.initialize(application);
35+
```
36+
37+
3. Create a FrameGraph and add it to the main ViewPort.
38+
39+
```java
4040
FrameGraph fg = Renthyl.forward(assetManager);
4141
viewPort.setPipeline(fg);
4242
```
4343

44-
3. Run the project.
45-
46-
## Learn Renthyl
44+
### Wiki (under construction)
4745

48-
A full guide on how to use Renthyl can be found at this repository's [wiki](https://github.com/codex128/FrameGraph/wiki).
46+
* [Understanding Renthyl](Wiki/UnderstandingRenthyl.md)

RenthylPlus/src/test/java/codex/renthylplus/tests/TestVoxelConeTracing.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public void simpleInitApp() {
9494
spot = new SpotLight();
9595
spot.setPosition(new Vector3f(10, 10, 10));
9696
spot.setDirection(new Vector3f(-1f, -1f, -0.7f).normalizeLocal());
97-
spot.setColor(ColorRGBA.White.mult(3.0f));
97+
spot.setColor(ColorRGBA.White.mult(2.0f));
9898
spot.setSpotRange(1000f);
9999
spot.setSpotOuterAngle(FastMath.PI*0.25f);
100100
spot.setSpotInnerAngle(FastMath.PI*0.05f);
-20.4 KB
Binary file not shown.

RenthylPlus/src/test/resources/Models/gi-test.gltf

Lines changed: 10 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -443,26 +443,6 @@
443443
"roughnessFactor":0.4000000059604645
444444
}
445445
},
446-
{
447-
"doubleSided":true,
448-
"extras":{
449-
"lp":{
450-
"uid":"5157a2d78e"
451-
},
452-
"pov":{},
453-
"yp":{
454-
"active_ypaint_node":""
455-
}
456-
},
457-
"name":"pattern",
458-
"pbrMetallicRoughness":{
459-
"baseColorTexture":{
460-
"index":0
461-
},
462-
"metallicFactor":0,
463-
"roughnessFactor":0.4000000059604645
464-
}
465-
},
466446
{
467447
"doubleSided":true,
468448
"extras":{
@@ -621,7 +601,7 @@
621601
"TEXCOORD_0":10
622602
},
623603
"indices":11,
624-
"material":2
604+
"material":1
625605
}
626606
]
627607
},
@@ -635,7 +615,7 @@
635615
"TEXCOORD_0":14
636616
},
637617
"indices":15,
638-
"material":3
618+
"material":2
639619
}
640620
]
641621
},
@@ -649,7 +629,7 @@
649629
"TEXCOORD_0":18
650630
},
651631
"indices":15,
652-
"material":4
632+
"material":3
653633
}
654634
]
655635
},
@@ -663,7 +643,7 @@
663643
"TEXCOORD_0":21
664644
},
665645
"indices":15,
666-
"material":3
646+
"material":2
667647
}
668648
]
669649
},
@@ -677,7 +657,7 @@
677657
"TEXCOORD_0":24
678658
},
679659
"indices":15,
680-
"material":4
660+
"material":3
681661
}
682662
]
683663
},
@@ -691,7 +671,7 @@
691671
"TEXCOORD_0":27
692672
},
693673
"indices":15,
694-
"material":3
674+
"material":2
695675
}
696676
]
697677
},
@@ -705,7 +685,7 @@
705685
"TEXCOORD_0":30
706686
},
707687
"indices":15,
708-
"material":4
688+
"material":3
709689
}
710690
]
711691
},
@@ -722,7 +702,7 @@
722702
"TEXCOORD_0":33
723703
},
724704
"indices":15,
725-
"material":5
705+
"material":4
726706
}
727707
]
728708
},
@@ -750,7 +730,7 @@
750730
"TEXCOORD_0":39
751731
},
752732
"indices":15,
753-
"material":2
733+
"material":1
754734
}
755735
]
756736
},
@@ -777,24 +757,11 @@
777757
"TEXCOORD_0":46
778758
},
779759
"indices":47,
780-
"material":6
760+
"material":5
781761
}
782762
]
783763
}
784764
],
785-
"textures":[
786-
{
787-
"sampler":0,
788-
"source":0
789-
}
790-
],
791-
"images":[
792-
{
793-
"mimeType":"image/png",
794-
"name":"test-texture",
795-
"uri":"test-texture.png"
796-
}
797-
],
798765
"accessors":[
799766
{
800767
"bufferView":0,
@@ -1515,12 +1482,6 @@
15151482
"target":34963
15161483
}
15171484
],
1518-
"samplers":[
1519-
{
1520-
"magFilter":9729,
1521-
"minFilter":9987
1522-
}
1523-
],
15241485
"buffers":[
15251486
{
15261487
"byteLength":10660,

resources/VXGI-demo.png

214 KB
Loading

0 commit comments

Comments
 (0)