djFlixel

version : 0.4.2 , License : MIT
Requires : Haxe 4.2, HaxeFlixel 4.11
Author : John32b

This is a set of tools and helpers for HaxeFlixel. It needs a minimum initialization of its main static class D.hx and then you are all set to use all of the components in your projects.

📌 Please note that this is just a side project of mine and I cannot guarantee any support or bugfixes.

This library started as a helper for my projects, but later decided to open source and distribute it. I have tried to provide meaningful comments throughout the source files, also make sure to checkout the demo in the /demo folder for a full working example of using the library.

Compatibility

Target	Status
Flash 1	🆗
HashLink	🆗
HTML5	⚠️Some things like pixel operations don't work/are slow
Native/C++	Should work out of the box, currently untested.
Android	🤷‍♂️ Don't know, probably not

¹ Flash is deprecated in browsers, but offers extremely fast compilation speeds, good for development/testing

Install

haxelib git djFlixel https://github.com/john32b/djFlixel

Main Features 🍑

FlxMenu

A multi-page menu system. Useful to create main menus and option menus. It's very simple to setup and use. Supports links, checkboxes, list selection, number selection (float, ints). Almost everything is customizable from the cursor image, alignment, colors, animation times and more.

---

FlxAutotext

Versatile autotype text object that supports a simple inline tagging system. Meaning that you can insert special tags in the source string and change the behavior on the fly. You can change the speed, add pauses and even trigger callbacks.

---

The Global DJFLIXEL Helper Object D

djFlixel offers the public static class D.hx for accessing some minor objects and helpers. It is available in the package djFlixel.D

What is included in D :

• D.snd : Offers some sound functions, like playing assets with only the short filename or setting predefined volumes for sounds
• D.ctrl : Streamlined control polling. Check once and get gamepad/keyboard presses. Also ability to change keymap
• D.save : Save functions helper.
• D.dest : Helper object offering extra destroying functions, like tweens, or timers (Use it like FlxDestroyUtil)
• D.assets : Used in development, tries to load/reload assets from their real path so that you can make changes without having t to recompile the program again. Just do an asset reload, reset the state, and new assets will be fetched (Most useful for .json and other configuration files)
• D.text : Offers quick generation of flxText objects with custom styles. Provides its own text styling struct. The entirety of djFlixel relies on this object to get and style flxTexts
• D.align : Tools to align flxSprites. Align then in relation to the screen or to each other on in columns. Offers many options.
• D.ui : UI related helpers. Provides generation of the build-in djFlixel icons.
• D.bmu : General purpose BitmapData Manipulation tools.
• D.gfx: Flixel/djFlixel specific Bitmap Manipulation tools. -- There is a reason this is separate from D.bmu --

---

FX Package

In the folder/package djflixel/gfx you can find some tools for creating various effects like static, rainbow loader, starfield, text sine scroller, text bouncer etc. All of the effects offer many customization options.

^{Some of the effects}

---

Others

Icons

djFlixel has some built-in general use icons. Icons come in sized of 8,12,16,24 pixels wide and tall. Icons are accessible from the D.ui object. Also , you can use the bitmap tools in D.bmu to colorize the icons.

// Sprite icon of a heart colored red
var ic = new FlxSprite(D.bmu.replaceColor(D.ui.getIcon(16,'heart'),0xFFFFFFFF,0xFFFF0000));

Slice9 Tile mode Scaling

In the tool D.bmu you can find a useful slice9 scaler, that works by tile-repeating the inner parts, It generates bitmapdata objects so you can use it however you want.

DEMO

In the /demo folder you can find the sources for a demo program that will showcase many components of the library. You can download a binary here (Windows Only)

About HashLink 📎

HashLink is a virtual machine, it can provide fast performance similar to a native build but with very fast compile times. I recommend trying it out for development/release builds as it is highly compatible and stable. To set it up (for windows):

• Download the latest development binary from here : https://github.com/HaxeFoundation/hashlink/releases
• Extract it somewhere, e.g. c:\HaxeToolkit\hl
• Run lime setup hl -- It will ask you to visit the website, press n
• It will ask you the path to the HashLink binaries, give where you put it e.g. c:\HaxeToolkit\hl
• Finished

You can now build HaxeFlixel project to HashLink with : lime build hl

Notes on some library source files

In the source files you will find two extra namespaces djA and djfl.

• djA includes some target agnostic code. Code that can be used in all HAXE targets, like nodejs.
• djfl includes code that is specific to OpenFL.

Those are partial personal libraries that I use in some projects, but I'll probably never going to publish. So I did a copy paste of the specific files djFlixel uses and put them in a proper namespace folder structure, so djFlixel compiles. And that I don't have to alter anything for my own projects when I include the libraries with <haxelib name="djA"/>

Games using this library

Tomb Explorer : https://john0032.itch.io/tombexplorer

Future Knight Remix : https://john0032.itch.io/futurek

❗ If you have a program that uses this library, pm me and I'll add it here.

In Closing

I started creating this library in 2015-2016, recently I reseted the commit history to a fresh start. The older versions are available in the TAG releases here on GitHub.

Thanks for checking this out 😸,
John.