Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matthewnau/libmoji

📚 Bitmoji's API made easy for everyone
https://github.com/matthewnau/libmoji

api bitmoji fun javascript library

Last synced: about 1 month ago
JSON representation

📚 Bitmoji's API made easy for everyone

Awesome Lists containing this project

README 

        
# Libmoji

This is a tiny library for easily using the Bitmoji API to make fun, and unique [Bitmoji](https://www.bitmoji.com/) avatars! This library utilizes Bitmoji's services to create new avatars, and to give existing account holders more image customization. Libmoji provides functions that allow you to build the image URL for an avatar with random or specific characteristics pulled from the Bitmoji [asset database](https://api.bitmoji.com/avatar-builder-v3/assets). It also allows you to render your personal Bitmoji in ways that aren't normally possible! Comics are pulled from the [templates database](https://api.bitmoji.com/content/templates).



Libmoji makes it easy for you to integrate Bitmoji avatars into your project without the need for having a Bitmoji or Snapchat account. Libmoji works without the use of access tokens when generating avatars, and therefore can only render character previews by default. In order to create comic strips, you will need to have a Bitmoji or Snapchat account, and have the [chrome extension](https://chrome.google.com/webstore/detail/bitmoji/bfgdeiadkckfbkeigkoncpdieiiefpig). While making an account is not necessary for all of Libmoji, it is recommended so that you can have fun exploring all possibilities!



Many different types of Bitmoji styles can be created. Libmoji allows you to make `Bitmoji Deluxe`, `Bitmoji Classic`, and `Bitstrips` avatar styles. Each style can be rendered in either gender with tons of different traits and outfits! There are an infinte amount of possibilities! See the article [Bitmoji Styles](https://github.com/matthewnau/libmoji/wiki/Bitmoji-Styles) for examples of what each style looks like.
















---



## Integrating Libmoji



Integrating Libmoji into your project is very simple! You've got two options to choose from. Either fork the project from GitHub, or use npm to install the module.



#### Npm Installation

```Shell

$ npm install libmoji

```

Regardless of your installation choice, you should now have access to all functions and variables from the library. Libmoji does not use too many variables or functions, but it is important to make sure that you do not use any of the same names in your project or it could cause errors. Refer to the [documentation](https://github.com/matthewnau/libmoji/wiki/Libmoji-Docs) for how to use Libmoji.



---



## Additional Information



If you're interested in how a Bitmoji image URL is assembled, or need assistance with using Libmoji please visit the [wiki](https://github.com/matthewnau/libmoji/wiki). It contains all Libmoji related [docs](https://github.com/matthewnau/libmoji/wiki/Libmoji-Docs) and articles which may be of use.



Also, to use the comics portion of Libmoji, you need to first identify your unique avatar ID. This can be done by following the steps in [this](https://github.com/matthewnau/libmoji/wiki/Finding-Your-ID) article. Once you have the ID, you're good to go!














---



## Product disclaimer



This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by Bitmoji or any of its affiliates or subsidiaries. This is an independent and unofficial product. Use at your own risk.