Write good introduction tutorials for mineflayer

PrismarineJS / mineflayer

Create Minecraft bots with a powerful, stable, and high level JavaScript API.

https://prismarinejs.github.io/mineflayer/

MIT License

5.07k stars 920 forks source link

Write good introduction tutorials for mineflayer #908

Open rom1504 opened 4 years ago

rom1504 commented 4 years ago

This would help people learn how to use it and avoid recurring questions. Example of good tutorials (these projects are unrelated with minecraft):

Would be great if people would contribute on this. A good place to put it would be either the project wiki, either .md files.

rom1504 commented 4 years ago

Not really what I had in mind but a guy created a video series about creating a mineflayer bot https://youtu.be/zvUDiwqKpiQ , it's in French but it's pretty detailled, I think we could reference it.

rom1504 commented 4 years ago

There is so many stuff on YouTube about mineflayer, it's crazy. https://m.youtube.com/results?search_query=%22mineflayer%22 I think it would be interesting to reference some of these things

rom1504 commented 4 years ago

Something very important to do here is explain how people should handle async, that's the confusion that happens the most often.

hexatester commented 4 years ago

Also example on good wiki tutorial python-telegram-bot/python-telegram-bot/wiki.

rom1504 commented 4 years ago

What we needs is tutorials on :

how to do async with mineflayer : callbacks, events, basic explanation and how to use with mineflayer
how to use the different features of mineflayer with links to the relevant examples
a FAQ section with eg how to create a discord bot with mineflayer, how to click on windows, how to use a proxy, ... (you can look at issues and discord to find frequently asked questions)
identify other frequent use cases that confuses people and make a tutorial out of this

rom1504 commented 4 years ago

https://www.youtube.com/watch?v=dRehDuNj0vU seems ok, let's maybe add to the readme

rom1504 commented 4 years ago

https://www.loginradius.com/engineering/blog/callback-vs-promises-vs-async-await/ can help build the async tutorial

xMdb commented 2 years ago

(these links dont provide any benefits to me)

i wrote these tutorials for vultr:

https://www.vultr.com/docs/how-to-link-discord-and-minecraft-chat-with-mineflayer-and-discord-js https://www.vultr.com/docs/how-to-setup-a-basic-mineflayer-bot-on-ubuntu-20-04