efemra/README.md

# efemra

*Efemra* is a WIP toy game engine. It is currently essentially an early, in-progress Zig rewrite of the [pim](https://github.com/gheshu/pim) engine, which is described by its creator Kara as "a little 'zen garden'".

Efemra is absolutely WIP and does not work at all! Feel free to watch as I stumble my way through Zig, Vulkan and graphics programming. I hope to have more to show for myself soon.

In the meantime, please check out pim, because that engine actually works and is super cool!

## dependencies

Currently I am only targeting Linux and testing on Gentoo. Probably will investigate Windows once things get further. You'll need:

* Zig 0.10 (this is the prerelease version)
* Vulkan: headers, layers, and loader (these will depend on your package manager).
* glfw 3 headers
* Possibly some other stuff that you likely already have? TODO: experiment with building on a popular distro to see what's needed.
* Currently efemra isn't at the point of loading Quake levels, but that probably will eventually be a thing.


## building

It might not build yet... but in theory:

* Install [gyro](https://github.com/mattnite/gyro) Zig package manager.
* Execute `gyro fetch` to fetch dependencies.
* Execute `gyro build run` to build and (someday) run!
readme! 2022-07-19 02:45:20 +00:00			`# efemra`

Small README fixes 2023-04-12 09:39:07 +00:00			`Efemra is a WIP toy game engine. It is currently essentially an early, in-progress Zig rewrite of the [pim](https://github.com/gheshu/pim) engine, which is described by its creator Kara as "a little 'zen garden'".`
readme! 2022-07-19 02:45:20 +00:00
			`Efemra is absolutely WIP and does not work at all! Feel free to watch as I stumble my way through Zig, Vulkan and graphics programming. I hope to have more to show for myself soon.`

			`In the meantime, please check out pim, because that engine actually works and is super cool!`
deps and install info 2022-07-19 03:09:54 +00:00
			`## dependencies`

			`Currently I am only targeting Linux and testing on Gentoo. Probably will investigate Windows once things get further. You'll need:`

			`* Zig 0.10 (this is the prerelease version)`
Small README fixes 2023-04-12 09:39:07 +00:00			`* Vulkan: headers, layers, and loader (these will depend on your package manager).`
deps and install info 2022-07-19 03:09:54 +00:00			`* glfw 3 headers`
			`* Possibly some other stuff that you likely already have? TODO: experiment with building on a popular distro to see what's needed.`
			`* Currently efemra isn't at the point of loading Quake levels, but that probably will eventually be a thing.`


			`## building`

			`It might not build yet... but in theory:`

Small README fixes 2023-04-12 09:39:07 +00:00			`* Install [gyro](https://github.com/mattnite/gyro) Zig package manager.`
deps and install info 2022-07-19 03:09:54 +00:00			* Execute `gyro fetch` to fetch dependencies.
			* Execute `gyro build run` to build and (someday) run!