KilledByAPixel / FrankEngine

Game Engine and Level Editor

Home Page:https://github.com/KilledByAPixel/FrankEngine

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Frank Engine

Frank Engine is a game development framework with a built in editor written in C++. The goal is to be a fast way to create large open world 2D games with high quality graphics. Everything necessary to create a fully featured game is included: physics (Box2D), rendering (DirectX), level editor, dynamic lighting, particle system, sound, music (Ogg Vorbis), gamepad input, GUI, and debug console. The code is fairly well documented and includes simple starter projects build on.

Features

  • Large streamable worlds with small memory footprint
  • Integrated level editor, instantly switch from editing to playing!
  • Integrated Box2d Physics
  • Deferred rendering with diffuse, normal and emissive maps
  • Supports a ton of dynamic shadow casters and shadow casting lights
  • 2D sprite, terrain, and particle system
  • Stereo sound effects with Direct Sound
  • Music with Ogg Vorbis
  • Integrated with The DirectX Utility Library (GUI, sound, etc)
  • Sub frame interpolation using fixed time step
  • Keyboard, mouse, and joystick input binding system
  • In game debug console
  • User friendly editor features: cut, copy, paste, undo, and redo

Videos

Engine Demo - Showing features of the engine

Piroot Trailer - Physics based metroidvania

Bulkhead Demo - Top down roguelike shooter

Screenshots

Screenshot 2 Screenshot 3 Screenshot 4

Basic Engine Commands

These commands work by default in all games made using Frank Engine. In some games you will need to type "devmode 1" in the debug console to enable all the commands.

Tilde - Brings up the debug console where you can enter debug commands.  Try typing "help" for more info.  There are a slew of commands, everything from vsync to tweaks for specific gameplay variables. F1 - Shows debug information like frame rate and engine stats. F2 - Shows an Box2D debug physics overlay. F3 - Reloads textures and sounds from disk. F4 - Toggles edit mode, allowing a designer to create the terrain and place objects. F5 - Takes a screenshot and saves it to the snapshots folder. F6 - Opens up the profiler to help track where frame time is being spent.

Editor Help

Pressing F4 will toggle between the editor and the game. Whenever you switch back to the game, the player will automatically be moved to the mouse cursor to make iteration faster.

The top right shows which layer you are editing/selecting, click on a layer number to change it, or use the number keys. On a tile layer you can draw and change tiles for visual and collision. On an object layer you can move objects and change their attributes. Select the tile or object type to draw in the pick box in the lower right. Cut, copy, paste and undo/redo are all very functional.

Draw tiles and select objects using the left mouse button. Drag right mouse button to select multiple tiles/objects. By default this will select all layers but you can hold alt to select only the active layer.

Layer Select

  • 1 - Background layer
  • 2 - Foreground layer
  • 3 - Objects layer

Camera

  • Middle Mouse (or Left Mouse + Tab) - Move camera
  • Mouse Wheel (or Right Mouse + Tab) - Zoom camera

Selection

  • Mouse Right - Rectangle select
  • Mouse Right + Alt - Single layer select
  • Mouse Right + Shift - add to selection (only for objects)
  • Mouse Right + Ctrl - remove from selection (only for objects)

Tile Edit

  • Mouse Left - Draw tile data & select/deselect
  • Mouse Left + Shift - Draw line
  • Mouse Left + Ctrl - Eyedropper
  • Mouse Left + Mouse Right - Block erase
  • Alt - Block draw
  • Z - Flood fill
  • X - Flood erase

Object Edit

  • Mouse Left - Object select
  • Mouse Left + Ctrl - Scale object (only can be done when 1 object is selected)
  • Mouse Left + Shift - Rotate object (only can be done when 1 object is selected)
  • Z - Add object
  • X - Remove object

Shortcuts

  • WASD - Move in quick pick box
  • Ctrl+Z, Y - Undo, Redo
  • Ctrl+X, C, V - Cut, Copy Paste
  • Ctrl+S, L - Save, Load
  • Shift+Ctrl+C - Copy entire active patch
  • Shift+Ctrl+V - Paste entire active patch
  • G - Toggle grid
  • B - Toggle block edit

About

Game Engine and Level Editor

https://github.com/KilledByAPixel/FrankEngine

License:Other


Languages

Language:C++ 66.1%Language:C 31.2%Language:Makefile 2.6%Language:Perl 0.1%