-
Notifications
You must be signed in to change notification settings - Fork 41
Libmoji Docs
Here you can find a list of all functions and variables that are available to use with Libmoji, and what they do. You will also find descriptions and example code for each of the following.
An array that contains the string and index value associated with each gender.
const genders = [['male',1],["female",2]];A string array that contains all possible poses that can be passed to the buildUrl method.
const poses = ["fashion","head","body"];An array that contains the string and index value associated with each style.
const styles = [["bitstrips",1],['bitmoji',4],["cm",5]];
/* bitstrips, Bitmoji classic, Bitmoji deluxe */A string which contains the beginning of every preview engine image's URL.
const basePreviewUrl = "https://preview.bitmoji.com/avatar-builder-v3/preview/";A string which contains the beginning of every cpanel engine image's URL.
const baseCpanelUrl = "https://render.bitstrips.com/v2/cpanel/";A string which contains the beginning of every render engine image's URL.
const baseRenderUrl = "https://render.bitstrips.com/render/";Takes gender and style strings as input and returns a traits object with a list of all possible traits for a specific gender and style.
console.log(libmoji.getTraits("male"));
/* returns an array of trait objects */Takes a gender string as input and returns a brands object with a list of all possible brands for a specific gender.
console.log(libmoji.getBrands("male"));
/* returns an array of brand objects */Takes a brand object as input and returns an outfits object with a list of all possible outfits for a specific brand.
console.log(libmoji.getOutfits(libmoji.getBrands("male")[0]));
/* returns an array of outfit objects from the first male brand */Takes a trait object as input and returns a values object with a list of all possible values for a specific trait.
console.log(libmoji.getValues(libmoji.getTraits("male")[0]));
/* returns an array of values for the first male trait */Takes a trait object as input and returns its name as a string.
console.log(libmoji.getKey(libmoji.getTraits("male")[0]));
/* console would print "beard" since it is the first male trait */Takes an image url string as input and returns the avatar uuid associated with it as a string.
console.log(libmoji.getAvatarUuid(https://render.bitstrips.com/v2/cpanel/f3b1c198-8c3a-4386-a2de-5902bf7309df-be541d0a-5344-47a3-94ac-5e3912651ea5-v1.png?transparent=1&palette=1));
/* console would print 'be541d0a-5344-47a3-94ac-5e3912651ea5' */Takes an image url string as input and returns the avatar id associated with it as a string.
console.log(libmoji.getAvatarId(https://render.bitstrips.com/v2/cpanel/8968038-316830037_35-s5-v1.png?transparent=1&palette=1));
/* console would print '316830037_35-s5' */Takes a template object as input and returns the comic id associated with it as a string.
console.log(libmoji.getComicId(libmoji.randTemplate(libmoji.templates)));
/* console would print a comic id */Takes a max integer as input and returns a random integer. The pool of values starts at 0 (included) and ends at the max. (excluded) The random value can never be the max, at most it will be 1 less since the array index starts at 0.
console.log(randInt(2));
/* console would either print '1' or '0' */Takes a brands object as input and returns a random brand object.
console.log(libmoji.randBrand(libmoji.getBrands("male")));
/* console would print a random brand object from the list of male brands */Takes an outfits object as input and returns a random outfit string.
console.log(libmoji.randOutfit(libmoji.getOutfits(libmoji.randBrand(libmoji.getBrands("male")))));
/* console would print a random male outfit */Takes a trait object as input and returns a random value string.
console.log(libmoji.randValue(libmoji.getTraits("male")[0]));
/* console would print a random value taken from the first male trait value pool */Takes a traits object as input and returns a traits object. Every trait has a random value assigned. The returned traits object consists of key/value pairs and does not just list traits (like the input).
console.log(libmoji.randTraits(libmoji.getTraits("male")));
/* console would print a male traits object with random values */Takes a traits object (key/value form) as input and returns a string. This function is only used by buildUrl to convert a traits object to string form for the URL.
console.log(libmoji.mapTraits(libmoji.randTraits(libmoji.getTraits("male"))));
/* console would print a string of traits to be used in a url */Takes a templates object as input and returns a template object.
console.log(libmoji.randTemplate(libmoji.templates));
/* console would print a template object */This function requires a pose (string), scale (integer), gender (integer), style (integer), rotation (integer), traits (key/value traits object), and an outfit (string). Returns a URL string.
let gender = libmoji.genders[libmoji.randInt(2)];
let style = libmoji.styles[libmoji.randInt(3)];
let traits = libmoji.randTraits(libmoji.getTraits(gender[0],style[0]));
let outfit = libmoji.randOutfit(libmoji.getOutfits(libmoji.randBrand(libmoji.getBrands(gender[0]))));
console.log(libmoji.buildPreviewUrl("fashion",3,gender[1],style[1],0,traits,outfit));
/* console would print a random image url */This function requires a comic id (string), avatar id or uuid (string), transparent (integer), and a scale (integer). Returns a URL string.
let comicId = libmoji.getComicId(libmoji.randTemplate(libmoji.templates));
let avatarId = libmoji.getAvatarId(https://render.bitstrips.com/v2/cpanel/8968038-316830037_35-s5-v1.png?transparent=1&palette=1);
console.log(libmoji.buildCpanelUrl(comicId,avatarId,1,2));
/* console would print a random image url with your Bitmoji */This function requires a comic id (string), avatar id or uuid (string), transparent (integer), scale (integer), and an outfit (string). Returns a URL string.
let comicId = libmoji.getComicId(libmoji.randTemplate(libmoji.templates));
let avatarId = libmoji.getAvatarId(https://render.bitstrips.com/v2/cpanel/8968038-316830037_35-s5-v1.png?transparent=1&palette=1);
let outfit = libmoji.randOutfit(libmoji.getOutfits(libmoji.randBrand(libmoji.getBrands("male"))));
console.log(libmoji.buildRenderUrl(comicId,avatarId,1,2,outfit));
/* console would print a random image url with your Bitmoji */