# dng

dng is a maze/puzzle game + engine! Design and work your way through your own maze avoiding enemies and finding
treasure!

## How to run

To run the game you can just launch `dng` or `dng.exe` on windows.

Follow the onscreen prompts to load a level and play!

### Configurations

By default the game will look for its configuration file in a few OS specific places.
The default config is bundled along side the executable: `config.toml`

## Create your own level!

Levels use the following directory structure:

```shell
level-name/
  dng.map # required -the map file
  proc.lua # optional - custom lua overrides
```

### Map Format

The map format is just a text file with the following key tokens:

| Token | Description              |
|:------|:-------------------------|
| w     | Wall                     |
| p     | The player (must have 1) |
| e     | Enemies (0 or more)      |
| t     | Treasure (0 or more)     |
| 0     | Empty space              |

Doors and Keys: 

Doors and keys are single use and map to specific doors.
Each key (1-4) maps to a door type (a-d)

| Token | Description              |
|:------|:-------------------------|
| 1     | Key 1, for Door a        |
| 2     | Key 2, for Door b        |
| 3     | Key 3, for Door c        |
| 4     | Key 4, for Door d        |
| a     | Door a, opened by key 1  |
| a     | Door b, opened by key 2  |
| a     | Door c, opened by key 3  |
| d     | Door d, opened by key 4  |


#### Tips

Space your map out using whitespace between every token (`w w w w` instead of `wwww`) for better readability.
Use a monospace font to help things align

### Custom Lua Code

Create a `proc.lua` in your level folder.
You can override anything found in `dnglib` using standard lua scoping rules.
If you wish to call the original defaults you can include `dnglib.defaults` in your file:
`local defaults = require('dnglib.defaults')` and call the functions:

```lua
package.path = '['
function onKeyPress(key)
    -- Set your own overrides
    defaults.onKeyPress(key)
end
```

## Develop

dng uses git-submodules:

```shell
git clone https://github.com/s3nd3r5/dng
git submodules init
git submodules update
```

### Dependencies

Current build process is setup for a *nix like environment.

| Dependency | Version |
|:-----------|:--------|
| c++        | 20+     |
| g++        | 8+      |
| CMake      | 3.16+   |
| Lua        | 5.4.*   |
| SFML       | 2.5.*   |

_Note: with some CMake modifications we could probably leverage lower versions_

### Build

dng uses CMake

```shell
# use a build dir to ensure we ignore build props
cmake -B cmake-build
```

_Developed with CLion using CMake and g++ on Linux_

### Enforcing local lua files

To ensure you're always loading the local files make sure you include:

`package.path = "./?.lua;" .. package.path` at the top of your `proc.lua`

If you're experiencing issues loading the proper files you can always set in your local development environment:

`export LUA_PATH=/path/to/dng/?.lua;` (replacing `/path/to/dng` with your actual local development path)

this will allow you to run `dng` from anywhere

### Licensing in files

You can find a copy of the notice in `.copyright_headers`.

Note `dnglib/constants.lua` and `src/lua.hpp` which have custom licensing information.

## Run

Once you build the project you can execute it by:

```shell
# use your build dir and select a map!
./cmake-build/dng
```

Note: You need to use the working directory containing the `include` folder!

## MacOS

MacOS support is not functional at the moment, but I merged the generic changes in since if I do want to get OSX support for older MacOS systems
then I need something that isn't dependent on their librarys not including some modern C++ features.

I lack a proper test machine at the moment and struggled to get [Darling](https://www.darlinghq.org/) working properly.

The _biggest_ issue is the fact that I was also unable to pull in a minimum amount of boost libs that I needed, so I had to submodule the entire
system. Which results in quite a bit of filesize for this tiny project. The executable and shared libs would be much smaller, but the source is hefty.
Sorry. I'm sure you could get away with /not/ initializing boost and being just fine since Windows and Linux codepaths shouldn't ever call it.

## External Libraries and Resources used by dng

* [SFML](https://github.com/SFML/SFML) licensed
  under [zlib/png license](https://www.sfml-dev.org/license.php)
* [Lua](https://github.com/lua/lua) licensed under [MIT license](https://www.lua.org/license.html)
* [Boost](https://github.com/boostorg/boost) licensed under [Boost Software License](https://github.com/boostorg/boost/blob/master/LICENSE_1_0.txt)
* [Press Start 2P Font](https://fonts.google.com/specimen/Press+Start+2P#glyphs) licensed
  under [SIL Open Font License](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL)
* [Liberation Fonts](https://github.com/liberationfonts/liberation-fonts) licensed
  under [SIL Open Font License](https://github.com/liberationfonts/liberation-fonts/blob/main/LICENSE)