Wiwa engine is a 3D Game Engine developed during the Game Engines subject. Our goal is to fulfill an Engine that can be used to develop all kinds of games. The engine is based on a full ECS system, and it's meant to have modern features as PBR and C# scripting.
- Scriting ECS
- Wwise Audio engine
- Custom shader and material pipeline
For now the engine has the following features.
- Reflection
- Data oriented ECS (Entity-Component-System)
- WIP material system
- WIP basic lighting
- FBX model loading
- PNG texture loading
- Own custom file format
- Scene manager
- Camera manager
- Scene serialization
- Frustrum culling
- Mouse picking
- AABB support
Currently we are two students working on the project
In order to install the project you can
git clone https://github.com/ZaroDev/WiwaEngine
Dependencies:
- Visual Studio 2019 or more
Open the Scripts folder and then select your Visual Studio version at GenerateProjectsX.bat
Create a Assets folder at the Editor folder
Advise: the project only supports Windows
- Demo
- Entities
- Editor camera
- Camera manager
- Resource manager
- Materials
- Projects
- Time
- Shader pipeline
- Scripting
- Audio
In order to showcase the different features of Wiwa it includes a demo scene.
To open it go to Scenes and drag and drop Full_demo.wiscene to the Scene window.
To create an entity left click on the Hierarchy window and select an option. You can create either a blank entity or a primitive.
Entities can have be parented and have local and global positions.
- Hold right click to look
- Right click + WASD to move
- F to focus the selected entity
- Alt + right click to orbit an entity
- Alt + Q to quit the app
- Q to unselect the current gizmo
- W to move an object
- E to rotate an object
- R to scale
To create a camera just open the Cameras panel from View->Cameras then Create Camera. To make the camera frustum cull the option cull needs to be active.
The resource manager automatically imports each Model or Texture from the Assets\ folder, the result of that import can be seen in the generated Library\.
The resources once loaded they keep loaded until a new scene is loaded. This keeps the engine from loading and unloading assets in a middle of a scene.
To see the loaded resources open the Resources window from View->Resources.
To change the import options of an asset the Import window can be checked.
Note: for now image import settings is WIP
To create a material click the button Create Material at the Assets window.
Assing a name to the material and click create.
Open the material editor window and select a material you want to edit.
For now projects only contain info about the project such as the company and project name. In the future this tab will allow the user to select the scenes from the project to build the game.
The play and pause buttons allow the user to enter play mode. This allows the deltaTime to be updated each frame, and in the future will make the scripting work. The time variables and time scale can be seen under the Time tab at View->Configuration
The shader pipeline allows the user to create their own shaders using GLSL. To use it create a new shader on assets browser,
then open the .vs and .fs those are the shader files, you can add a geometry shader by just making another file with the same name ended in .gs.
To add the uniforms to the engine just go to View->Shaders from that menu uniforms from various types can be added or deleted. To compile or save the shader click Compile.
If there's an error on the files when compiling the console will print a message and the status of the shader will change to Error.
Note: uniform names must be the shame as in the shader files
The scripting pipeline allows the user to create fast iterations of systems and components in C# without re-compiling the engine. When oppening the engine a solution named AppAssembly is created.
To create new files click on the Assets window Create.
This will generate a new C# system script with the template.
You can edit the files with the editor that you desire.
Note: to compile the scripting code you need VS2019 or VS2022
To choose between diferent visual studio compiler and settings go to View->Configuration->External tools there you can change the visual studio version for the compiler and the configuration.
Note: we strongly recomend using Release for better performance
At this point in time you can't debug C# code.
Note: Don't compile while on play mode this will crash the engine.
To see more in detail how to use the C# API click here.
The audio engine works using the Wwise API and allows the user to add audio to the engine.
To work with the audio engine you need to download Wwise. When downloaded you can create a new project in Wwise where you can work with music sound and effects.
In engine you just need to load the .bnk project in the Audio window.
And load the necessary banks in order to execute all the events.
Add the component to an Entity to make it execute an event on Play.
Copyright (c) 2022 Xymaru & ZaroDev
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.