KILAM Credits Display

The open source tool for creating action bar credits by GrupoKILAM.

How it works

The tool is designed for creating a datapack that will display the text given in batches with a smooth animation with waiting periods at the center of the batch.

In game

/function credits:start

Performance

The text is divided with a binary search so the game does not need to evaluate a massive amount of conditions each animation tick; perhaps is possible to evaluate at runtime and reduce even more the computational needs, but the current solution works fine (tested with 100~ players with texts 50 lines of text) and is the securest.

The DataPack created does not seem to make any performance drops for the designed use cases with the binary search approatch.

Usage

python3 credits.py --credits_text "Line1" "Line2" --spacing 140 --formatting '{"text":"%text%"}' --zip --name credits

import credits

# Creates directory `search` with the binary search
credits.create_credits(
    [
        '',
        'Credits display - GrupoKilam',
        'Original idea by Kimani_',
        'Developed by kimani_ and luisch444',
        '', ''
    ]
)

import credits

# Creates the full datapack as `credits.zip`
credits.create_datapack(
    [
        '',
        'Credits display - GrupoKilam',
        'Original idea by Kimani_',
        'Developed by kimani_ and luisch444',
        '', ''
    ], 140, '{"text":"%text%","color":"#ffffff"}', True, 'credits', False
)

Project

The code is not really refine; the tool was made for internal use and adapted for public use.

Feature Requests

You may request on issues or in any of our communication channels a feature to be added, we can not ensure we will do it as it depends on the amount of work and time required.

Contributions

Feel free to contribute to the project or ask for feedback, the code is not pretty, and surly it could be improved!