Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 3.41 KB

README.md

File metadata and controls

85 lines (57 loc) · 3.41 KB

cyan_potion

Maven Central License: MIT

Quality Gate Status cyan_potion_base

Quality Gate Status cyan_potion_coordinate

Quality Gate Status cyan_potion_rpg_module

A lightweight 2d game engine in java.

Introduction

After a long period of hesitation, I managed to convince myself to open source most parts of it, yes, even MIT instead of GNU.

This engine is built on the several principles:

1. completing 2d games in java.
2. prefer more programmers friendly, not artists friendly.
3. high freedom + high expandability.
4. be crazy.

Current state

It is still in the process of development, and many places are incomplete.

Many codes related to animation/display have not been completed yet.

The event system is also very rudimentary.

And no much materials for the inner logic for now.

Notice about sonar cloud

Right now we (or I, exactly) decided just use sonar cloud as code smell detector or something.

We do not care much about test coverage because it is really hard to write some auto-test for a GUI program,

and this engine not works very well when there be no window(though it really can work but...).

We might add some tests when repairing some bug and make sure it not happened again, but no plan for adding more tests just for gaining coverage and make the data looks more beautiful now.

But we will not reject all reasonable adding test pull requests.

Demo

Here is the demo.

(The demo is actually for cyan_potion_rpg_module, but I guess this counts.)

image

You can also take a look at this.

Contribute

Also, if there be people who want to contribute codes/ideas/suggestions, feel free to do so.

Please also notice that if I receive your pull request, you will be put in the authors list.

If you want to be put in the licenses folder also, please notice that we accept only MIT license for your pull request.

Add the MIT license to your code piece and put it into into license folder, and write description about it.

Special Thanks

Java ProfilerJava profiler Thanks ej-technologies for providing such a wonderful performance analysing tool.

Thanks for reading this

-----XenoAmess