Hri7566
/
fishing-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Hri7566 2024-10-11 19:08:35 -04:00
parent 1a8a272c87
commit 919e2ff7ad
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,3 +1,5 @@
<img src="./fish_icon.png" width="64" alt="Crucian Carp" />
# fishing-api
This is a rewrite of Brandon Lockaby's fishing bot for Multiplayer Piano.
@ -16,14 +18,16 @@ Copy the default `.env` file:
cp .env.template .env
```
Edit that file to match your environment, then install packages:
Edit that file to match your environment. Keep in mind that a connection token is required for all fishing service clients. These clients are for connecting to the actual service (such as Discord or MPP) and bridges the connection to the backend API. This way, the execution related to fishing itself is focused in its own process, instead of travelling between sending messages and processing fishing-related computations.
Next, install the project's dependencies from npm:
```bash
bun install
bunx prisma db push
```
Run both the http server and the clients for various services separately with these commands:
Run both the HTTP API and the clients for various services separately with these commands:
```bash
bun . # Main http server

BIN
fish_icon.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB