4 |
5 | 
6 |
7 |
8 |
9 | 🤖 Use open and free AI models to generate reusable nodes for Minecraft bots.
10 | 11 |
12 |
13 | 
15 | or donate on PayPal
16 |
17 |
18 |
19 | 
25 | About • 26 | Features • 27 | Install 28 |
29 | 30 | ## About 📬 31 | 32 | Project KnowledgeBook is an open-source Minecraft bot management platform that provides players with a user-friendly web interface to create and control helpful bots. Our goal is to enhance the Minecraft multiplayer experience with powerful automation tools, all at no cost to the player. 33 | 34 | **AI Stuff** 35 | More info and docs about the new AI features will be added soon! 36 | 37 |
38 | 
39 |
40 |
41 | ## YouTube Demo
42 |
43 | [](https://www.youtube.com/watch?v=tEXtJFuGw8Y)
44 |
45 | ## Getting Started
46 |
47 | Check our (soon) [Wiki](link-to-wiki) for detailed guides on:
48 |
49 | - Setting up Project Skyview
50 | - Creating and managing bots
51 | - Using the item delivery system
52 | - Accessing the 2D map view
53 | - Building an custom bot using nodes
54 | - And more!
55 |
56 | ## Roadmap
57 |
58 | - Add checkboxes to nodes (booleans)
59 | - Add an way in export and import flows.
60 | - Auto save flows to browser.
61 |
62 | ## Ready to download flows🕹
63 |
64 | | Flow name | Description | Download |
65 | | --------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------- |
66 | | Obtain crafting table | Collects wood to craft a crafting table and drops it | [Download](https://github.com/SilkePilon/KnowledgeBook/blob/main/flows/crafting_table.json) |
67 | | | | |
68 |
69 | ## How To Install 📥
70 |
71 | ### Prerequisites
72 |
73 | Make sure you have the following installed:
74 |
75 | - [Node.js](https://nodejs.org/) 22.0.0 or above
76 | - [npm](https://www.npmjs.com/)
77 |
78 | ### Installation Steps
79 |
80 | 1. Clone the repository:
81 | ```bash
82 | git clone https://github.com/SilkePilon/KnowledgeBook.git
83 | cd KnowledgeBook
84 | ```
85 |
86 | 2. Install dependencies for all workspaces:
87 | ```bash
88 | npm run install:all
89 | ```
90 |
91 | 3. Set up HTTPS for development:
92 | ```bash
93 | cd backend
94 | npm run setup-https
95 | ```
96 |
97 | This will:
98 | - Install dependencies for both frontend and backend
99 | - Generate trusted SSL certificates for local development
100 | - Configure HTTPS for secure communication
101 |
102 | > **Note:** When first accessing the backend API in your browser, you may need to accept the self-signed certificate. This is normal for local development and doesn't affect security.
103 |
104 | ### Running the Application
105 |
106 | You can run the frontend and backend separately or together:
107 |
108 | #### Run both frontend and backend:
109 | ```bash
110 | npm run dev
111 | ```
112 |
113 | #### Run only the frontend:
114 | ```bash
115 | npm run frontend
116 | ```
117 |
118 | #### Run only the backend:
119 | ```bash
120 | npm run backend
121 | ```
122 |
123 | The frontend will be available at `http://localhost:3000` and the backend at `http://localhost:8080` by default.
124 |
125 | ### Development
126 |
127 | - Frontend code is located in the `frontend/` directory
128 | - Backend code is located in the `backend/` directory
129 | - Each directory has its own `package.json` with specific dependencies and scripts
130 |
131 | ```bash
132 | curl -sL -o main.zip https://github.com/SilkePilon/KnowledgeBook/archive/refs/heads/main.zip && unzip main.zip && cd KnowledgeBook-main && npm install && npm rebuild && cd .. && rm main.zip && cd KnowledgeBook-main && node main.js
133 | ```
134 |
135 | ## Manual Install
136 |
137 | #### 1. Clone the Repository
138 |
139 | First, make a local copy of the repository:
140 |
141 | ```bash
142 | git clone https://github.com/SilkePilon/KnowledgeBook.git
143 | ```
144 |
145 | Open the cloned repository in your preferred terminal app.
146 |
147 | #### 1. Install packages
148 |
149 | Assuming you have [Node](https://nodejs.org/en/download/package-manager/current) and [NPM](https://www.npmjs.com/) installed you can run the following commands:
150 |
151 | ```bash
152 | npm install
153 | npm rebuild
154 | node main.js
155 | ```
156 |
157 | That's it! You can now open up https://knowledgebook.vercel.app/ and start creating!
158 |
159 | ## Adding Custom Nodes to the Project
160 |
161 |
162 | 
163 |
164 |
165 | Welcome to the project! This guide will walk you through the steps to add custom nodes. Follow these instructions to contribute your custom functionality.
166 |
167 | ### 1. Clone the Repository
168 |
169 | First, make a local copy of the repository:
170 |
171 | ```bash
172 | git clone https://github.com/SilkePilon/KnowledgeBook.git
173 | ```
174 |
175 | Open the cloned repository in your preferred IDE.
176 |
177 | ### 2. Create a New Node File
178 |
179 | Navigate to the `flow_functions` folder in the project directory. Create a new file for your node with the following naming conventions:
180 |
181 | - **Name Format:** `your_node_name.js`
182 | - **Rules:**
183 | - Use lowercase letters
184 | - Use underscores (`_`) to separate words
185 | - Do not include numbers in the file name
186 |
187 | For example, if you want to create a node for crafting planks, you might name the file `craft_planks.js`.
188 |
189 | ### 3. Update `functions.json`
190 |
191 | In the `flow_functions` directory, open the `functions.json` file and add an entry for your new node:
192 |
193 | ```json
194 | {
195 | "YOUR_NODE_NAME": {
196 | "name": "YOUR_NODE_NAME",
197 | "file": "YOUR_NODE_NAME.js",
198 | "id": "YOUR_NODE_NAME",
199 | "label": "DISPLAY NAME",
200 | "hasInput": true,
201 | "description": "YOUR NODE DESCRIPTION",
202 | // example of input
203 | "input": { "amount": "number", "message": "text", "sneak": "switch" },
204 | "author": "YOUR NAME"
205 | }
206 | }
207 | ```
208 |
209 | **Replace the placeholders:**
210 |
211 | - `YOUR_NODE_NAME` - The name of your node (in lowercase with underscores)
212 | - `DISPLAY NAME` - The name displayed in the UI
213 | - `YOUR NODE DESCRIPTION` - A description of what your node does
214 | - `YOUR NAME` - Your GitHub username
215 | - `{ "NAME": "number", "NAME": "text" }` - Your input fields.
216 |
217 | **Available input options:**
218 |
219 | - `text` - An general text input box
220 | - `number` - An input box limited to numbers only
221 | - `switch` - An switch that can be set to true or false
222 |
223 | ### 4. Implement the Node
224 |
225 | Open your newly created file and implement your node using the following structure:
226 |
227 | ```javascript
228 | const { getBot } = require("../main.js");
229 |
230 | function main(data) {
231 | // Get the bot object
232 | const bot = getBot();
233 | // Your function logic here
234 | console.log("Executing test_node with data:", data);
235 | }
236 |
237 | module.exports = { main };
238 | ```
239 |
240 | **Key Points:**
241 |
242 | - Require `bot` from `../main.js`.
243 | - The `main` function should be defined and exported. This function is executed when the node runs.
244 | - Use `try` and `catch` statements for error handling. If an error occurs, log it and rethrow it to ensure it can be caught elsewhere.
245 |
246 | **Accessing input fields**
247 | In order to the get values from the input field of a node you can use the `data` argument in the `main` function
248 | an example:
249 | in `functions.json` I've added an function with the following input:
250 | `{ "Amount": "number", "Message": "text" }`
251 | now i can access them in the `main` function by doing: `data.amount` and `data.message`
252 | the parameter name is based on the key provided in the input.
253 |
254 | **Examples**
255 |
256 | You can also checkout some of the already made nodes:
257 |
258 | - [Chat](https://github.com/SilkePilon/KnowledgeBook/blob/main/flow_functions/chat.js)
259 | - [Wait for chat message](https://github.com/SilkePilon/KnowledgeBook/blob/main/flow_functions/wait_for_chat_message.js)
260 | - [Walk to](https://github.com/SilkePilon/KnowledgeBook/blob/main/flow_functions/walk_to.js)
261 |
262 | **Limitations**
263 |
264 | - no way of outputting custom data from a node.
265 |
266 | ### 5. Submit a Pull Request
267 |
268 | Once you’ve added your node and updated the `functions.json` file, push your changes to a new branch and open a pull request on GitHub.
269 |
270 | ```bash
271 | git checkout -b your-feature-branch
272 | git add .
273 | git commit -m "Add custom node YOUR_NODE_NAME"
274 | git push origin your-feature-branch
275 | ```
276 |
277 | Go to the GitHub repository and create a pull request. Your changes will be reviewed, and if everything looks good, they will be merged!
278 |
279 | ## Thank You!
280 |
281 | Thank you for contributing to the project! If you have any questions or need further assistance, feel free to reach out.
282 |
283 | Happy coding! 🚀
284 |
285 | ## Star History
286 |
287 |
288 | `` `
301 |
302 |