apimiku-twitterbot

The project is not maintained anymore. Here will be no new features or improvements. A Node.js based Twitter bot sharing the works like illustrations and videos of Appearance Miku!

Hmm. What's the deal?

Appearance Miku is one of MMD models based on Hatsune Miku, and you ~~should~~ must know Appearance Miku is kawaii-est MMD model ever.
You can see some nice pictures(illustrations) or video works on pixiv, Niconico Video, Niconico Illust, and somewhere more! ~~ignore R-18 and NSFW works, yay.~~
... Okay, you're back here. I'm not responsible even if you *addicted* to her. :)

Tell me how can I run this anyway ;(

Easy and stay cool, bro. Let's take a simple but awesome journey.

Requirements

Node.js (Tested on v8.x LTS, v10.x LTS)
Stable Internet connection. 100Gb/s is recommended if you feel dizzy easily.
Some awesomeness-in-your-brain? uwu

Clone this repository

Let's give Appearance Miku a comfortable house!

Install git if you haven't installed before.
$ sudo apt-get install git on Ubuntu/Debian
# yum install git on CentOS/Fedora
Now clone this repository using following command :
$ git clone https://gitlab.com/SDSkyKlouD/apimiku-twitterbot.git

To reduce storage space consumption, add --depth 1 option at the end of the command.
You're done with making a house for Appearance Miku! yeah!

Pre-setup

But our Appearance Miku says, she needs to take a rest while she charge herself.
That's okay, moving house is not easy to do. She fell asleep, and we can prepare some basic stuffs for her, right?

Check for example configuration files in cloned repository.

$ cd apimiku-twitterbot
$ cd config
$ ls
... api_config.examples.js exclude_list.examples.js ...

Open and edit api_config.examples.js and fill out every empty fields.

There will be enough explanations available in these example configuration files.
~~Creating a Twitter app is not too hard. Just google it ;)~~ If you didn't apply for Twitter developer account before, it'll make you painful, a little. damn.
Rename or copy api_config.examples.js to api_config.js.
Open and edit exclude_list.examples.js if you want to manipulate some exclusion list.

You can trust me, the explanations in the file are not some lies.
Rename or copy exclude_list.examples.js to exclude_list.js.
Let some furnitures in!

$ cd ..   # if you are not in the root of the cloned repository
$ npm install

You're done! now wake our girl up!

Run!

Our Appearance Miku seems fully charged and she says she is ready to do everything. Okay then, let's give her a work.

# in the root of the cloned repository
$ node bot.js

You'll see some processing sequence. Now check your Twitter account which has been configured for this bot.
If you feel everything went correctly, then why don't you hug our girl XD

~~??? : SIMPLE? HUH.~~

Extra : Cron, cron, cron!

You can let Appearance Miku to do work periodically by setting a cronjob. Below is an example of cronjob(crontab) setting.

# min hour dom mon dow command
  0   */2  *   *   *   node <path-to-cloned-repository>/bot.js

This will run the bot script every two hours.

※ NOTE that this crontab setting will not work on some systems.
※ NOTE that this script DOESN'T REQUIRE administrator permission because our Appearance Miku doesn't need any help from master to do this. Please edit crontab with $ crontab -e, not $ sudo crontab -e or # crontab -e.

Conclusion?

I like Appearance Miku. uwu

License

Under the ~~sea~~ LGPLv3

Contribute

If you create a/some pull request, I will review it unconditionally and make decision to merge or deny.
Your contribution will be applied to up and running bot, and a small icon of your profile image will be shown in the file page(s) what you've contributed as well.

Copyright?

Copy~~right~~left 🄯 2018 SD SkyKlouD
Coded with 💖, README made with 🍸

SDSkyKlouD/apimiku-twitterbot