Coconut

Coconut is a utility library for Cocos2d-html5 that makes it easier to create HTML games.

Feel free to check out the cocos2d-html5-boilerplate repository to see an example project that uses this library.

This package was created in order to:

• make common usage of the Cocos2d-html5 API less verbose
• add non-documented API options to custom helpers in order to get better IntelliSense
• easily access common helpers that the Curriculum Advantage dev team uses across dozens of different game repositories
• fill in the gap for missing functionality, including:
  • audio event listeners
  • user-friendly text inputs
  • complex text labels (multiple colors, font styles, math symbols, fill-in-the-blank, etc.)
  • deterministic, pseudo-random data generation

Installation

From the root of your project folder, use the npm CLI to install this package:

npm i @curriculum-advantage/coconut

Usage

Importing specific exports (recommended):

import { log } from '@curriculum-advantage/coconut';
log('Hello World!');

Importing the entire module:

import coconut from '@curriculum-advantage/coconut';
coconut.log('Hello World!');

Contributing

Style

This project follows the Airbnb style guide.

Local Testing

There are a quite a few ways to go about testing updates to this NPM package locally, before submitting a pull request. One way is to install from a commit on your feature branch. Below is a package.json example (be sure to update dependency url and commit hash as needed):

{
   "dependencies": {
    "@curriculum-advantage/coconut": "git+https://github.com/curriculum-advantage/coconut.git#452c7be",
  }
}

Alternatively, this article outlines pros/cons for other methods.

Coconut

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[2.2.6] - 2021-04-28

• Add method to retrieve image label font size

[2.2.5] - 2021-04-21

• Blank line bug fix

[2.2.3] - 2021-04-19

• Fix bug with where duplicate child could be added to node in Multilabel

[2.2.2] - 2021-04-19

• Fix bug with setting font size on ImageLabel from MultiLabel

[2.2.1] - 2021-04-19

• Adding option for callback function to ImageLabel and MultiLabel for when the text processing is completed
• Update MultiLabel to only display once all text have been generated

[2.2.0] - 2021-04-16

• Revert changes on how fractions are created by the MultiLabel
• Migrate math syntax to the MultiLabel

[2.1.19] - 2021-04-05

• Update project dependencies

[2.1.18] - 2021-04-05

• Add support for updating stroke after ImageLabel have been generated

[2.1.17] - 2021-04-01

• Add support for setting font and background color to ImageLabel
• Add ability to set ImageLabel position after creation
• Add ability to enable text shadow to ImageLabel
• Add the ability to update ImageLabel Dimension
• Add the ability to add a ClickHandler to ImageLabel
• Add the ability to disable ClickHandler on MultiLabel
• MultiLabel now pass the MultiLabel instance to the ClickHandler
• MultiLabel now directly create math symbols

[2.1.8] - 2021-03-26

• Update MultiLabel to use js private encapsulation rather than constructor encapsulation.
• Adding text attribute to MultiLabel constructor, so you no longer have to manually call setString
• MultiLabel and ImageLabel can be created with or without the new keyword.

[2.0.0] - 2021-02-22

• Images will be generated using the dom in place of using cc.Label in order to work around poor drivers on certain low-cost Lenovo Chromebooks.
• createLabel was replaced with ImageLabel().

[Unreleased]

[1.0.2] - 2019-10-02

Fixed

• Fix audioManager type errors.

[1.0.1] - 2019-10-02

Fixed

• Fix IntelliSense for projects using this package.
• Update package to only include build files.
• Fix type errors.

[1.0.0] - 2019-09-30

• Initial release