update readme

This commit is contained in:
Tabby 2025-11-02 16:53:59 +11:00
parent 3500dfe909
commit c68d013bc1
2 changed files with 12 additions and 8 deletions

View file

@ -37,9 +37,10 @@ Since these commands edit data, only users with the `technician` role may use th
> [!Warning] Work in progress > [!Warning] Work in progress
fabcat is made in Godot v4.5 with the discord.gd plugin. To edit the project follow these steps: fabcat is made in Godot v4.5 with the discord.gd plugin. To edit the project follow these steps:
1. Download Godot v4.5 1. Download [Godot v4.5](https://godotengine.org/download/archive/)
2. Clone the fabcat repo to your computer 2. Clone the [fabcat repo](https://github.com/tabby-cat-nya/FabcatBot) to your computer
3. Open the project folder with Godot 3. Add the `.env` file with the discord bot key (ask Tabby)
4. Open the project folder with Godot
### Project Structure ### Project Structure
- `main.gd` - main script which manages everything at the top level, you shouldn't need to touch this - `main.gd` - main script which manages everything at the top level, you shouldn't need to touch this
@ -66,8 +67,8 @@ Each application command file is made up of up to 5 key parts, only `execute()`
- [Example discord.gd Project](https://github.com/3ddelano/discord-bot-v2-godot/tree/main) - [Example discord.gd Project](https://github.com/3ddelano/discord-bot-v2-godot/tree/main)
### Running an instance of fabcat ### Running an instance of fabcat
1. export to linux x86_64 1. In Godot, select `Project -> Export...` and export the Linux build
2. move to your server 2. This should create a few files which you should move to your server, make sure to move the `.env` file here too
3. give it executable permissions 3. You may need to give the `.x86_64` executable permissions
4. run with the --headless argument 4. run the executable with the `--headless` argument
5. then do something else to keep it running in background, restarting as needed The bot should then be running! You may want to consider creating some sort of startup task so the bot can continue if something happens to the server

View file

@ -20,5 +20,8 @@
- [x] seperate place to store bot access key - [x] seperate place to store bot access key
- [x] update test command - [x] update test command
- [ ] provide real technician id
- [ ] update global commands
### Possible furture development ### Possible furture development
- job management - job management