@game-assets-creator/server v0.0.1-alpha.0

@game-assets-creator/server

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

There are many great ways to create assets for a game, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create an application so amazing that it'll be the last one you ever need.

Here's why:

• You shouldn't have to know how do draw to create a game
• Your time can be optimized when creating an asset letting a tool do the "hard work"
• You should be able to create amazing things with less effort :smile:
• You should be able to create your own tool to create assets (use our libs)

Of course, not all time it will serve all projects since your needs may be more specific. So we will be adding more features in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

A list of commonly used resources that I find helpful are listed in the Acknowledgements.

Built With

• jsdom
• html-to-image

Getting Started

Follow this instructions on how to set up your project locally.

Prerequisites

• None for now

Installation

1. Install the package

# with npm
npm i @game-assets-creator/server
# with yarn
yarn add @game-assets-creator/server

Usage

Get started:

// ES6 or typescript
import GAC from '@game-assets-creator/server'
// ES5
const GAC = require('@game-assets-creator/server')

const character = GAC.create({type:'human'})

const imageBuffer = character.toPNG()

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat(some scope): Add some AmazingFeature'). Please use Conventional Commits
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

David Lima - @xarlyudo

Project Link: https://github.com/DavidProf/game-assets-creator

Acknowledgements

• jsdom
• html-to-image