/ulix-dexflow

Dexflow framework based on the Ulix game engine.

Primary LanguagePythonMIT LicenseMIT

License: MIT Python Version LDTK Moderngl Code style: black

Support Server

Ulix: Dexflow

Dexflow is a framework for building (fan)games inspired by the Pokémon series of games. As with any Ulix framework, Dexflow expands Ulix' functionality with features usually found in these kinds of games. The framework falls under the Creative Commons BY-NC-SA 4.0 license. Any used assets and libraries fall under their own respective licenses.

Documentation

Dexflow is currently in unlabelled alpha and is undergoing heavy changes. When creating your own work using the framework we heavily recommend keeping to certain types of additions:

  • Create your own awesome world.
  • Place people in your world and give them behaviours.
  • Add new battlers for players to discover and find.
  • Fine-tune encounters for the perfect game balance.
  • Create cinematics with dialogue and events.
  • Make your own 3D animations for your battler's attacks.

In general, you should definitely join our Discord for any questions and, perhaps more importantly, suggestions! The framework is incredibly fresh and your feedback will have a definite impact on the final product!

We offer very little documentation as of now. If you want an introduction, need help, or have any questions, you should hit us up on Discord! We regularly introduce new people to the framework, so please do not hesitate to ask. :-)

If you have any suggestion or issue, please post on Discord and/or make an issue on Github.

Basic Usage

You can either clone the repo directly or patch the repo on an existing Ulix folder. Python version 3.8 is heavily recommended as it ensures compatibility with the Ulix Particle Forge.

Please install any dependencies by running setup.bat.

Before your first time playing the game, and after making any changes to the world, you will need to compile the LDTK world file.

Run compile_world.bat to generate the compressed world file, after which your game can be played via game.bat.

Building your world

Editing the world is done via the editor program LDTK. We heavily advise you to use the world.ldtk file supplied with this repo (in the world folder) as a base for your own world as it has been correctly configured for use.

Building

See: https://github.com/kivy/kivy/wiki/Using-Visual-C---Build-Tools-instead-of-Visual-Studio-on-Windows