mukia-engine 0.3.3

<div align="center">

<h3>Mukia</h3> An open-source Game Engine

<i>Engine Test</i>

</div>

Use the Project

Prerequisite: DOTNET

Using Bash

1. Download and extract the release (NOTE: gzip decompressor needs to be manually installed)
2. Run the script

Manually

1. Download and extract the release (NOTE: gzip decompressor needs to be manually installed)
2. Remove the install.sh as it's not needed
3. Create a Project Directory
4. Open the Terminal into your Project Directory and run dotnet new console
5. Then, run dotnet add package mukia-engine
6. Finally, move all files in install-assets and move the folders: resources and shaders

Scenes

Loading Demo Scene

ZombieSurvial demo

When getting an error check:

1. Does the scene folder have any malformed text
2. Is this resource\scene\ directories is created
3. Forgot to add the SaveNode attribute, or uses the wrong name
4. Make an issue on the github project

Publish Game

To publish your code use:

dotnet publish --output <output> -r <os> --self-contained

Loading Scenes

ZombieSurvial load <path-to-scene>

When recieving an error, do the same steps in the Loading Demo Scene.

Scene Formating

Node should always come first

A node declearation should be the first thing in scene, with all of the properties under it.

e.g.

# Node
[engine.camera local-id='1' parent='0']
	# Properties of Node
	MukiaEngine.Vector3 Position={"X":0,"Y":0,"Z":0}
	MukiaEngine.Vector3 Rotation={"X":0,"Y":0,"Z":0}
	MukiaEngine.Vector3 Scale={"X":1,"Y":1,"Z":1}
	System.String Name="PlayerCamera"

Type Name=Value

Node declearation properties should be as follows:

• Type: as in full name (so float becomes System.Single) and be or inherit the type in the node class.
• Name: The name should also be in a valid name, in the node's type
• Value: in the JSON format (allows for number literals like NaN or infinity)

local-ids should not duplicate

Local id's should be unique and should not be duplicate in multiple Node declearations. For example:

# fine
[engine.node local-id"1" parent="parent"]
# results in error, or unknown behaviour
[engine.node local-id"1" parent="parent"]

No parent is a 0

To declear that node is parented to tree, add 32 0s.

[engine.node local-id"1" parent="0"]

Meshes

To convert a .obj to a mesh usable in the Engine.

1. Export the mesh as an .obj

.

2. Use the command:

py tools/mesh_converter.py [obj-file-here] [export-file-here]

To be noted, the script only supports .obj files and is surport to handle one object.