cocos-remote-atlas-util

This is a tool to replace the remote atlas/image in the cocos engine.

Install

npm install --save @game-engine/cocos-remote-atlas-util

Usages

import RemoteAtlasUtil from '@game-engine/cocos-remote-atlas-util';

// set remote atlas image
RemoteAtlasUtil.getInstance().setRemoteUrl(atlasDirName, atlasJsonRemoteUrl, atlasImageRemoteUrl);
// set single remote image
RemoteAtlasUtil.getInstance().setSingleImageUrl(imageRelativePath, remoteUrl);
// check if all admin images have url set.
const { atlas, single } = RemoteAtlasUtil.getInstance().checkAllImageSetUrl();
console.error(`admin images url have not been set: atlas=${atlas.join(',')}; single=${single.join(',')}`)

Sprite config tool

const { createSpriteConfig } = require('@game-engine/cocos-remote-atlas-util/dist/tool');
const path = require('path');

createSpriteConfig({
    // the root path of project.
    rootPath: path.resolve(__dirname, '../'),
    // the textures relative path. [Optional]
    texturePath: 'assets/resources/texture',
    // the sprite config relative path. [Optional]
    spriteConfigPath: 'config/sprite.config.json',
    // the folders name do not want replace remote atlas. [Optional]
    excludes: ['static']
});

Important

1. Make sure that set url before you load it!
2. All image need to put it into "resources/texture" folder. Or you can change the texturePath parameter.
3. If you need to use an atlas, please create a file named "auto-atlas" and don't rename it.