Add OpenDeliveryBot to "Projects Using Mineflayer" #3162
Conversation
|
I don't think this project is big (or ambitious) enough to warrant an exclusive mention in the list |
|
ik but its a good example of what can be done with the python version as there is no docs for it (not many) |
|
also that list is a bit outdated: |
|
i also plan on adding support for plugins. (in python) |
|
I don't know.. there are literally tens of thousands of projects depending on Mineflayer at this point. I think it makes sense to have this list curated (and preferably not by the authors of those projects) |
|
Many dependents indeed, but a lot less functional end-to-end bots with docs. I don't think any gatekeeping is necessary beyond weeding out the obviously low quality/effort things. Authors are the ones writing the projects, so they've always been free to open PRs. |
|
Sure. It makes sense that authors open the PR themselves. But it also makes sense that we don't have every single well-formed project in the list, because that would take up way too much space in the README. Maybe adding a projects.md could make sense. For the projects in the README I think they should be remarkable in some respect. Either for their creative use of the library or for the sheer size of the project. But seeing as this list is definitely outdated it'd probably make sense to have a general discussion about what "requirements" should be needed for a project to be featured in the README. I do not think this project fits, but that might just be me. |
A projects.md could probably be added at some point yes. But I don't think the size of the current README is anything blocking for the moment.
So as you mention some things listed here are outdated. But I think they still have some historical significance like rbot, maybe an additional sublist for "outdated but interesting", maybe you want some inspiration? Aside from weeding out the low quality/effort (things that could be examples)/done many times over projects, I disagree about nitpicking too much here to make listing here some competition. For code contributions this matters, as maintainers have to maintain code written by contributors and not understanding that code or it being low quality is added tech debt.
Can you elaborate ? I don't understand. |
Not currently, no. But it seems the last time the projects list was updated, there were only a couple hundreds projects depending on Mineflayer. Now there are over 25000 (counting only public repositories on GitHub). So my concern is if we add in any odd project to the list, it will quickly grow to be a major part of the README, which is not ideal. I see your point about not favorizing some over the others which is why I think just sorting by popularity (say, number of stars on GitHub) would make sense. Then include something like a top 5 and have the rest in a different file and just link there. The reason I don't think this project fits is that it is not very technically ambitious, it is not actually finished, and it seems to have no user base thus far. That does not make it a bad project by any means, but I don't think it makes sense "promoting" (can't find a better word) it in the main README of the project. |
|
It's also meant as an example of the Python side of mineflayer. I've not seen many projects based on Python and the idea is that it shows what can be done with it (as the code is a bit different from JS). I needed to use the JS code as a base and use a tool to convert it into Python code to use as there is not much documentation for it. as for the user base, it's hard promoting a GitHub project (for me then) |
This is my primary objection. I didn't want to say it because you hadn't explicitly stated your intent. I don't think the projects list should be a way for authors to promote their projects. It's meant solely to emphasize the powers of the library with concrete applications. Or at least that's how it should be, in my mind. |
|
also, this project is using https://github.com/Textualize/textual |
my intention is not to promote the project. only to show what the Python version can do. |
|
will this be merged or is there gonna be a new system? |
|
Important things I think are:
On the last point I'd recommend listing the package on PyPI for ease of use, but that's up to you. |
|
😄 I just added it to PyPi https://pypi.org/project/opendeliverybot/
im inplementig #3163 (if it works tho) |
|
also someone is making a nice web based gui for it |
|
I'm going to merge since you're actively working on it, but yeah we should clean up the list of user projects |
OpenDeliveryBot is an ongoing project that is made in the python version of mineflayer. it allows players to use a bot to deliver items from place to place using a terminal CLI and GUI.