/[sudobot]/trunk/docs/app/(docs)/getting-started/page.mdx
ViewVC logotype

Diff of /trunk/docs/app/(docs)/getting-started/page.mdx

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 580 by rakinar2, Mon Jul 29 20:37:38 2024 UTC revision 599 by rakinar2, Wed Aug 7 14:51:05 2024 UTC
# Line 55  Next, navigate to the directory where yo Line 55  Next, navigate to the directory where yo
55  cd sudobot  cd sudobot
56  ```  ```
57    
58    ### Building SudoBot for Node.js
59    
60  Now, to build the project, we'll use [BlazeBuild](https://github.com/onesoft-sudo/sudobot/tree/main/blazebuild), which is a blazingly fast build tool, for TypeScript and JavaScript projects.  Now, to build the project, we'll use [BlazeBuild](https://github.com/onesoft-sudo/sudobot/tree/main/blazebuild), which is a blazingly fast build tool, for TypeScript and JavaScript projects.
61  To use BlazeBuild, you don't need to install anything including BlazeBuild itself, as it will be installed and set-up automatically during the build process.  To use BlazeBuild, you don't need to install anything including BlazeBuild itself, as it will be installed and set-up automatically during the build process.
62  BlazeBuild will also make sure to install any missing SDKs or tools required for building the project.  BlazeBuild will also make sure to install any missing SDKs or tools required for building the project.
# Line 69  This will build, compile and package the Line 71  This will build, compile and package the
71  Depending on your system, the build process may take a few seconds to a few minutes to complete.  Depending on your system, the build process may take a few seconds to a few minutes to complete.
72  We recommend using a system with at least 8GB of RAM and 2 CPU cores for faster build times.  We recommend using a system with at least 8GB of RAM and 2 CPU cores for faster build times.
73    
74  If you don't have enough resources, this command will fail with heap allocation errors. If that happens, or if you don't want to build it yourself, don't worry. You can download prebuilt versions for every release. The builds are tested on Node.js **v21**, however they should also work with **v20**.  If you don't have enough memory, this command might fail with heap allocation errors. If that happens, or if you don't want to build it yourself, don't worry. You can download prebuilt versions for every release. The builds are tested on Node.js **v21**, however they should also work with **v20**.
75  You might see that only Linux and macOS (darwin) releases are available. This doesn't mean you cannot run the bot on Windows systems - only the native bindings are platform dependent. You don't need to worry about that in most cases and the bot will just work fine.  You might see that only Linux and macOS (darwin) releases are available. This doesn't mean you cannot run the bot on Windows systems - only the native bindings are platform dependent. You don't need to worry about that in most cases and the bot will just work fine.
76  You can download the prebuilt versions in the GitHub releases page: https://github.com/onesoft-sudo/sudobot/releases/latest  You can download the prebuilt versions in the GitHub releases page: https://github.com/onesoft-sudo/sudobot/releases/latest
77    
78  As always if you ever encounter errors with commands or you see something is not working as you expect, you can join our [Discord Server](https://discord.gg/892GWhTzgs) and ask for help!  As always if you ever encounter errors with commands or you see something is not working as you expect, you can join our [Discord Server](https://discord.gg/892GWhTzgs) and ask for help!
79    
80    ### Building SudoBot for Bun
81    
82    If you'd like to use Bun instead of Node.js to run SudoBot, then you don't need to build the bot because Bun supports TypeScript natively. Just skip to the next part and follow the commands and instructions specifically for Bun.
83    
84  ## Configuration  ## Configuration
85    
86  After building the project, you need to configure the bot to run on your server.  After building the project, you need to configure the bot to run on your server.
# Line 164  After configuring the bot, you can run i Line 170  After configuring the bot, you can run i
170  By default, BlazeBuild will use [Bun](https://bun.sh) to run the bot. If you want to use Node.js instead, you can run the following command:  By default, BlazeBuild will use [Bun](https://bun.sh) to run the bot. If you want to use Node.js instead, you can run the following command:
171    
172  ```bash  ```bash
173  ./blazew run -- --node  ./blazew run --node
174  ```  ```
175    
176  This will start the bot, and you should see the bot online in your Discord server.  This will start the bot, and you should see the bot online in your Discord server.
# Line 178  The bot uses [Discord's Application Comm Line 184  The bot uses [Discord's Application Comm
184  To register the application commands to the Discord API, you can run the following command:  To register the application commands to the Discord API, you can run the following command:
185    
186  ```bash  ```bash
187  ./blazew run -- -- -u  ./blazew run -- -u
188  ```  ```
189    
190  If you have debug mode enabled and have `HOME_GUILD_ID` set in the `.env` file, the bot will register the commands in the development guild.  If you have debug mode enabled and have `HOME_GUILD_ID` set in the `.env` file, the bot will register the commands in the development guild.
# Line 187  If you don't have debug mode enabled, th Line 193  If you don't have debug mode enabled, th
193  If you want to force the bot to register the commands globally, you can run the following command:  If you want to force the bot to register the commands globally, you can run the following command:
194    
195  ```bash  ```bash
196  ./blazew run -- -- -u -g  ./blazew run -- -u -g
197  ```  ```
198    
199  To clear the registered commands, you can run the following command:  To clear the registered commands, you can run the following command:
200    
201  ```bash  ```bash
202  ./blazew run -- -- -c  ./blazew run -- -c
203  ```  ```
204    
205  Once again, if you have debug mode enabled, the bot will clear the commands in the development guild. Otherwise, it will clear the commands globally.  Once again, if you have debug mode enabled, the bot will clear the commands in the development guild. Otherwise, it will clear the commands globally.
206  To force the bot to clear the commands globally, you can run the following command:  To force the bot to clear the commands globally, you can run the following command:
207    
208  ```bash  ```bash
209  ./blazew run -- -- -c -g  ./blazew run -- -c -g
210  ```  ```
211    
212  ## Emojis  ## Emojis
Legend:
Removed from v.580  
changed lines
  Added in v.599
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26