Pink Bean

A multi-purpose bot for MapleStory.

Demo

pinkbean-demo.mp4

Contributing Guideline

1. Fork the repo. To preserve quality commits and for safety, only Pink Bean team members may commit directly to our repository. To contribute an update or otherwise commit that resolves an Issue, you will need to first fork a copy to your own account. For more information about creating a fork, click here.
2. Create a unique branch name. To prevent possible branch conflicts, we recommend using a unique name such as "fixes-item-bug" or your github username. For more information on creating a branch, click here.
3. Push your commit. After you've created your branch, commit the changes you've made and make sure to merge it.
4. Create a pull request. To properly submit your changes to this repository, you will need to create a pull request and then compare your branch to our master branch. For more information on creating pull requests from a remote branch, click here

Installation Instruction

Native

1. Install MySQL Database
2. Install Redis
3. Install NodeJS and NPM
4. For Linux, please have build-essential and python 2.7 installed
5. Clone the directory. git clone https://github.com/telunc/pinkbean.git
6. Install dependencies with npm install
7. Create default.json in /config folder. Please refer to example.json.
8. Launch MySQL and Redis servers
9. Start Pink Bean with npm start

Docker

1. Install MySQL Database
2. Install Redis
3. Install Docker
4. Clone the directory. git clone https://github.com/telunc/pinkbean.git
5. Create default.json in /config folder. Please refer to example.json.
6. Launch MySQL and Redis servers
7. Start Pink Bean with sh build.sh