+
# Wicked Engine Scripting API Documentation
This is a reference and explanation of Lua scripting features in Wicked Engine.
@@ -124,7 +126,7 @@ You can use the Renderer with the following functions, all of which are in the g
- PutDecal(Decal decal)
- PutEnvProbe(Vector pos)
- ClearWorld(opt Scene scene) -- Clears the global scene and the associated renderer resources
-- ReloadShaders(opt string path)
+- ReloadShaders()
### Sprite
Render images on the screen.
diff --git a/Documentation/WickedEngine-Documentation.md b/Content/Documentation/WickedEngine-Documentation.md
similarity index 90%
rename from Documentation/WickedEngine-Documentation.md
rename to Content/Documentation/WickedEngine-Documentation.md
index 7a781b8e0..31bc11825 100644
--- a/Documentation/WickedEngine-Documentation.md
+++ b/Content/Documentation/WickedEngine-Documentation.md
@@ -1,3 +1,5 @@
+
+
# Wicked Engine
@@ -11,40 +11,44 @@
-
-Wicked Engine is an open-source game engine written in C++. It is easy to use, high performance and feature rich. There are no external dependencies, but some free libraries are included as part of the source code. The MIT license means that anyone is free to download, modify, and share it. This project is hosted on GitHub.
+
+Wicked Engine is an open-source C++ engine focusing on modern rendering techniques and performance. Use this as a framework for your graphics projects, or learning. Some programming skills are required for the best experience, but some simple tools like an Editor are also included. It is free to be used for anything good.+This project is hosted on GitHub. -- [Documentation](Documentation/WickedEngine-Documentation.md)
-- [Scripting API Documentation](Documentation/ScriptingAPI-Documentation.md)
+- [Documentation](Content/Documentation/WickedEngine-Documentation.md)
+- [Scripting API Documentation](Content/Documentation/ScriptingAPI-Documentation.md)
- [Features](features.txt)
-- [Devblog](https://turanszkij.wordpress.com/)
+- [Devblog](https://wickedengine.net/)
- [Videos](https://www.youtube.com/playlist?list=PLLN-1FTGyLU_HJoC5zx6hJkB3D2XLiaxS)
-You can download the engine by using Git and cloning the repository, or downloading it as zip. This will give you the full C++ source code that you must build for yourself. Building is simply pressing F5 in Visual Studio. You can also choose to download a pre-built version of the Editor or Tests applications, which will allow you to load content and write LUA scripts.
+You can download the source code by using Git and cloning the repository, or downloading it as zip. You can also choose to download a pre-built version of the Editor or Tests applications, which will allow you to try out features, load content and execute LUA scripts.
+Tip: try loading models or scripts from the Content folder using the Editor app to see how everything works. +
- 
-
+
### Platforms:
- Windows 10 Desktop [Visual Studio 2019]
- UWP [Visual Studio 2019]
-- Linux [CMake 3.7]
+- Linux (experimental) [CMake 3.7]
### How to build:
#### Windows
To build Wicked Engine for Windows 10, use Visual Studio and the provided `WickedEngine.sln` solution file. There are a couple of projects that you can run up front: Editor, Tests and Template. You just have to set either as startup project and press F5 in Visual Studio to build and run. For optimal performance, choose `Release` mode, for the best debugging experience, choose `Debug` mode.
-
+
-If you want to develop an application that uses Wicked Engine, you will have to link to WickedEngine_Windows.lib or WickedEngine_UWP.lib.lib and `#include "WickedEngine.h"` into the source code. For examples, look at the Template, Editor and Tests projects in Visual Studio that do this.
+If you want to develop an application that uses Wicked Engine, you can build the WickedEngine static library project for the appropriate platform, such as `WickedEngine_Windows` and link against it. Including the `"WickedEngine.h"` header will attempt to link the binaries for the appropriate platform, but search directories should be set up beforehand. For example, you can set additional library directories to `$(SolutionDir)BUILD\$(Platform)\$(Configuration)` by default. For examples, see the `Template`, `Tests`, and `Editor` projects.
You can also dowload prebuilt and packaged versions of the Editor and Tests here: [](https://github.com/turanszkij/WickedEngine/actions)
If you have questions or stuck, please use the `windows` communication channel on Discord: [](https://discord.gg/CFjRYmE)
-Note: Building 32-bit and ARM versions are possible, but no longer provided by default. The developer will need to configure the solution themselves for these platforms. For ARM platform, also use the `-D BT_USE_DOUBLE_PRECISION=1` definition when compiling.
+Note: Building 32-bit and ARM versions should be possible, but no longer provided by default. You will need to configure the solution for these platforms yourself if you want this. For ARM platform, also use the `-D BT_USE_DOUBLE_PRECISION=1` definition when compiling.
+
+Cmake: It is possible to build the windows version with Cmake, but the recommended way is to use the provided WickedEngine.sln file with Visual Studio as this is the most tested method.
#### Linux
The Linux support is experimental. You can find a sample build script for Ubuntu 20.04 [here](.github/workflows/build.yml) (in the linux section). You might need to install some dependencies, such as Vulkan SDK 1.2 or greater (to get DirectXShaderCompiler), SDL2, cmake 3.7 and g++ compiler (C++ 17 compliant version). For Ubuntu 20.04, you can use the following commands to install dependencies:
@@ -76,7 +80,7 @@ If you have questions or stuck, please use the `linux` communication channel on
#### Initialization (C++):
-
+
```cpp
// Include engine headers:
@@ -178,11 +182,11 @@ For more code samples and advanced use cases, please see the example projects, l
### Scripting API:
-
+
You can use a great number of engine features through the Lua scripting api, which can even be used real time while the program is running. The included applications, like the Editor,
contain a scripting input method toggled by the "Home" key. A blue screen will be presented where the user can type in LUA commands. It is very minimal in regards to input methods.
-For further details, please check the scripting API documentation: [Wicked Engine Scripting API](Documentation/ScriptingAPI-Documentation.md)
+For further details, please check the scripting API documentation: [Wicked Engine Scripting API](Content/Documentation/ScriptingAPI-Documentation.md)
### Model import/export:
@@ -194,11 +198,10 @@ In addition, the Editor supports the importing of some common model formats (the
- GLTF 2.0
The preferred workflow is to import models into the Editor, and save them as WISCENE, then any Wicked Engine application can open them.-(The old Blender exporter script is now not supported! (from version 0.21.0), because the engine was redesigned with Entity-Component System at its core. The old object oriented version can be found [here].) ### Graphics API: -The default renderer is DirectX 11 on Windows and Vulkan on Linux. There is also an optional DirectX12 renderer for Windows. +The default renderer is `DirectX 11` on Windows and `Vulkan` on Linux. There is also an optional `DirectX 12` renderer for Windows. You can specify command line arguments (without any prefix) to switch between render devices or other settings. Currently the list of options:
| dx12 | -Use DirectX 12 rendering device* | +Use DirectX 12 rendering device |
| vulkan | -Use Vulkan rendering device** | +Use Vulkan rendering device |
| debugdevice | @@ -223,26 +226,7 @@ You can specify command line arguments (without any prefix) to switch between re
-
-* *DX12 will try to load shaders from WickedEngine/shaders/hlsl6 directory.
-HLSL6 shaders can be compiled by Rebuilding the Shaders_HLSL6 project from within Visual Studio (Python 3 required for building).
-
-* **Vulkan support will be built into the application if the Vulkan SDK is installed on the build machine.
-Vulkan will try to load shaders from WickedEngine/shaders/spirv directory.
-SPIRV shaders can be compiled by Rebuilding the Shaders_SPIRV project from within Visual Studio (Python 3 required for building).
-For Linux builds, spirv shaders will be built by using Cmake system.
-
-- -### Contributions - -Contributions can be submitted on Github by following the steps below: -1) Open an issue and describe the feature or patch in detail -2) The feature or patch will be discussed in the issue, and determined if it would benefit the project -3) After the request is accepted, open a pull request and reference the issue with #issue_number -4) Code review will be conducted and the pull request will be merged when it meets the requirements -5) When the pull request passes, you will be added to the credits as a contributor and your name shall be remembered by future generations +
@@ -254,7 +238,7 @@ Contributions can be submitted on Github by following the steps below:
-### Finally, take a look at some screenshots: +### Screenshots: Sponza scene with voxel GI enabled:  diff --git a/Template_UWP/Main.cpp b/Template_UWP/Main.cpp index 7ad4b9c42..d58c51853 100644 --- a/Template_UWP/Main.cpp +++ b/Template_UWP/Main.cpp @@ -49,8 +49,6 @@ public: main.infoDisplay.watermark = true; main.infoDisplay.resolution = true; main.infoDisplay.fpsinfo = true; - - wiRenderer::SetShaderPath("shaders/"); } void Uninitialize() noexcept @@ -117,11 +115,6 @@ protected: // Event handlers void OnActivated(CoreApplicationView const & /*applicationView*/, IActivatedEventArgs const & args) { - if (args.Kind() == ActivationKind::Launch) - { - auto launchArgs = (const LaunchActivatedEventArgs*)(&args); - wiStartupArguments::Parse(launchArgs->Arguments().data()); - } CoreWindow::GetForCurrentThread().Activate(); } diff --git a/Template_UWP/Template_UWP.vcxproj b/Template_UWP/Template_UWP.vcxproj index c5aa03081..903cd2a3f 100644 --- a/Template_UWP/Template_UWP.vcxproj +++ b/Template_UWP/Template_UWP.vcxproj @@ -43,9 +43,7 @@