About this project
H5P Game Map is an H5P content type that lets students pick their own exercises from a game map interface.
Support expectations: the README states the content type is the result of contract work with specific requirements that may not match other users' expectations. The developer made it openly available so it can be used free of charge, but is not obliged to provide free support, accept feature requests or accept pull requests; he may still continue working on it at his own pace.
Build workflow as documented:
- Clone the repository with git and check out the branch you are interested in.
- Run npm install to install the required modules.
- Run npm run build to build the project, or npm run watch to have everything rebuilt continuously while editing.
- Always run npm run build before putting the code into production.
- Run npm run lint to check for coding style guide violations.
- The build process transpiles ES6 to earlier versions to improve compatibility with older browsers; functions some browsers do not support require a polyfill.
- The build process also moves the source files into one distribution file and minifies the code.
Semantics size workaround: common H5P integrations use mySQL databases in which the semantics field of the h5p_libraries table is of type text, holding up to 64KB of data. The semantics.json of GameMap exceeds that limit, so the project keeps semantics_src.json and minifies it, which is what npm run build_semantics is used for. The README notes this is not ideal because it must be run when semantics change, and that npm run build and npm run watch also build the minified semantics.
Packaging: the README recommends installing the H5P CLI tool instead of zipping everything manually, because that tool handles several things automatically. In simple cases, running h5p pack followed by the repository directory and a target file name is sufficient. For more information on using the distribution files in H5P, the README points to an introductory video and the H5P developer guide at h5p.org/library-development.
The README supplied here contains no license terms, version information, feature list or end-user usage documentation beyond these build, semantics and packaging notes.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.