Go to file
Scott Wadden c0a823b1a9
Instancing mostly working.
2022-02-14 21:32:21 -04:00
.idea Removed python from project 2022-01-13 22:50:32 -04:00
app Load player script 2022-02-12 22:50:49 -04:00
installer Fixed windows build. 2021-02-03 15:57:30 -04:00
media Build windows exe. Copy dlls. 2021-01-25 17:05:38 -04:00
src Instancing mostly working. 2022-02-14 21:32:21 -04:00
tests Build support 2022-02-12 00:02:24 -04:00
tools wip2 2021-12-18 21:27:09 -04:00
vendor Back to kinematic voxel plugin 2022-01-22 15:51:49 -04:00
vmlib/enu Instancing mostly working. 2022-02-14 21:32:21 -04:00
.editorconfig editorconfig 2020-02-21 11:12:39 -04:00
.gitignore default forward direction is towards the sun 2022-01-26 20:18:09 -04:00
.gitmodules Switched to mainline godot-voxel 2021-07-22 00:21:02 -03:00
.lldbinit Added lldb nim formatters 2021-10-28 17:08:23 -03:00
LICENSE.txt Instancing 2021-06-18 02:47:02 -03:00
README.md Update README.md 2021-07-03 21:06:26 -03:00
config.nims wip 2022-02-08 17:06:13 -04:00
dist_config.example.json Signing, packaging and notarization 2020-11-13 17:25:42 -04:00
enu.nimble Instancing working. Still buggy. 2022-02-14 09:06:19 -04:00

README.md

Note: This is the development branch of Enu 0.2, and is currently unstable and undocumented. It has only been tested on macos, and may not build on other platforms. The stable branch is in better shape.

Enu

3D live coding, implemented in Nim.

Enu Screenshot

Enu lets you build and explore worlds using a familiar block-building interface and a Logo inspired API. It aspires to make 3D development more accessible, and will eventually be usable to create standalone games.

Demo

Building 3D Games with Enu 0.2 - NimConf 2021

Enu 0.1 demo video:

Enu 0.1 Demo

Outdated Demos

Examples

Draw a square:

forward 10
right 10
back 10
left 10

or:

4.times:
  forward 10
  turn_right()

Square Example Create a twisting tower:

var
  length = 20
  height = 50

height.times:
  left length / 2
  back length / 2
  4.times:
    forward length
    turn_right()
  forward length / 2
  right length / 2
  turn_right 5
  up()

Tower Example

Draw randomly:

up 10
forward 10
(50..100).times:
  forward 2..5
  turn_right -180..180
  up 0..2

Random Example

Set the color to blue randomly with a 1 in 50 chance. Otherwise set it to white:

if 1 in 50:
  color = blue
else:
  color = white

or as a one-liner:

color = if 1 in 50: blue else: white

Random Color Example

Move forward 10 times, cycling through colors:

for i in 0..9:
  next_color()
  forward()

or:

10.times:
  color = cycle(red, black, blue)
  forward()

Color Cycle Example

Install

Download from https://github.com/dsrw/enu/releases. The Windows version isn't signed, and UAC will warn that it's untrusted. This will be fixed in a future release.

The Linux version hasn't been tested particularly well, but it works for me under Ubuntu 20.04. Please report any issues.

The world format will change in a future release. Worlds created in 0.1 won't be supported in future versions.

Build and Run

$ nimble prereqs
$ nimble build
$ nimble import_assets
$ nimble start

Notes

Enu requires a custom Godot version, which lives in vendor/godot. This will be fetched and built as part of nimble prereqs.

See https://docs.godotengine.org/en/3.2/development/compiling/index.html

Usage

Keyboard/Mouse

  • ESC - toggle mouse capture and to dismiss editor windows. Reloads script changes.
  • W, A, S, D - move around when mouse is captured.
  • Space - jump. Double jump to toggle flying. Hold to go up while flying.
  • Shift - run.
  • C - go down while flying.
  • ~ - toggle the console.
  • F - toggle fullscreen.
  • 1 - enter edit mode.
  • 2 - 9 - change active action.
  • Mouse Wheel Up/Down - change active action.
  • Ctrl - reload script changes. Hold to temporarily capture the mouse and move, so you can change your view without having to switch away from what you're doing.
  • Cmd+P / Ctrl+P - Pause the current script.
  • Left Click - Place a block/object or open the code for the currently selected object.
  • Right Click - Remove a block/object.

XBox / Playstation Controller

  • Left Stick - move.
  • Right Stick - change view.
  • A / X - jump. Double jump to toggle flying. Hold to go up while flying.
  • B / ◯ - go down while flying. Dismiss code editor.
  • Y / △ - toggle edit mode.
  • L1 / R1 - change active action.
  • L2 - place a block/object or open the code for the currently selected object.
  • R2 - remove a block/object.
  • L3 - run.

Enu currently includes 5 block types/colors, and 1 object model (a robot). This will be greatly expanded in the future.

Building

Drop a block or robot with the left mouse button/controller trigger, remove it with the right. Adjoining blocks will be combined into a single structure. With the mouse captured, building works more or less like MineCraft. Release the mouse by pressing ESC to draw blocks using the mouse cursor.

Code by switching to the code tool by left clicking/triggering on an object or structure. Changes are applied when the code window is closed (ESC key) or CTRL is pressed. Holding CTRL will also temprarly grab the mouse and allow you to change your position.

Config

The Enu data directory lives in ~/Library/Application Support/enu on Mac, %AppData%\enu on Windows, and ~/.local/share/enu on Linux. config.json has a few configurable options:

downscale: Increase to render at a lower resolution to improve performance. Should be an integer.

font_size: The font size. DPI is currently ignored, so hidpi screens will require a higher number.

dock_icon_size: Size of the icons in the dock. DPI is currently ignored, so hidpi screens will require a higher number.

world: The world/project to load. Change this to create a new world.

show_stats: Show FPS and other stats.

Tasks

v0.2

  • Slim down Godot classes. Move out most of the state.
  • General refactoring and cleanups.
  • Rethink Nim VM usage. Ideally, everything will run in a single VM.
  • State machines to manage UI and player behavior.

v0.2.1

  • iOS support.