https://github.com/britzl/template-lowres

Defold template project for lowres/pixel-art games.
https://github.com/britzl/template-lowres

defold defold-library lowrezjam pixel-art

Last synced: about 2 months ago
JSON representation

Defold template project for lowres/pixel-art games.

• Host: GitHub
• URL: https://github.com/britzl/template-lowres
• Owner: britzl
• Created: 2018-07-28T06:42:13.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-12T06:30:03.000Z (4 months ago)
• Last Synced: 2024-10-25T10:36:16.672Z (about 2 months ago)
• Topics: defold, defold-library, lowrezjam, pixel-art
• Language: GLSL
• Homepage:
• Size: 83 KB
• Stars: 26
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-defold - LowRes - art games. (Libraries / Programming Language)

README

        
# template-lowres

Defold template project for creation of low-res pixel art games. The project provides a render script for rendering the game to a low-res texture that will be centered and upscaled to fit the screen dimensions. The project also provides fonts for use in low resolution pixel art games.

The template project also contains presets for the following formats:

* [LOWREZJAM-2018](https://itch.io/jam/lowrezjam-2018) - 64x64 pixel template with support for on-screen controls

* [Nokia 3310 Jam](https://itch.io/jam/3310jam) - 84x48 pixel template

HTML5 demo: https://britzl.github.io/LOWREZJAM/

# Installation

You can use the template in your own project by adding this project as a [Defold library dependency](http://www.defold.com/manuals/libraries/). Open your game.project file and in the dependencies field under project add:

https://github.com/britzl/template-lowres/archive/master.zip

Or point to the ZIP file of a [specific release](https://github.com/britzl/template-lowres/releases).

This repository is also available as a [GitHub Template repository](https://help.github.com/en/articles/creating-a-repository-from-a-template).

# Usage

It is quite easy to setup and use the template:

* Open `game.project` and use the render script (`lowrez/render/lowrez.render`) instead of the default one from builtins.

* Add one of the provided game objects to your bootstrap collection

  * `lowrez/lowrezjam.go`

  * `lowrez/nokia3310jam.go`

  * `lowrez/custom.go`

Expand the game object, select the attached script component and configure how the graphics should render. You can modify `width`, `height` and `snap` (see below).

## Lowrez render script

The template provides a render script that renders to a low-res texture and upscales to fit screen dimensions. The texture will be centered in the window.

## Changing size

Change the screen size by posting a `set_size` message to the render script with a `width` and `height` message property.

```lua

msg.post("@render:", "set_size", { width = 320, height = 240 })

```

## Configure scale snapping

The upscaled low-res texture will by default be scaled to fill as much of the window as possible. It is possible to ensure that the upscaled texture will have a zoom that is set to an integer value. You can toggling scale snapping via the `toggle_scale_snap` message or explicity set snapping using the `set_scale_snap` message with `snap` set to true or false.

```lua

msg.post("@render:", "toggle_scale_snap")

msg.post("@render:", "set_scale_snap", { snap = true })

```

## On screen controls

The render script will also in a separate pass draw on-screen controls as per allowed rules for the jam. The on-screen controls must be a gui with material set to the provided `controls.material`.

# Fonts

The template ships with the following fonts suitable for low resolution pixel art games:

* 04b font - 5x5 pixel font (Freeware - http://www.04.jp.org/)