Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zaneh/dafarmz-bot
1.0 of DaFarmz bot. Uses Elixir, Nostrum, Postgres, and Node.js. Game assets not included.
https://github.com/zaneh/dafarmz-bot
discord-bot discord-game elixir farming farming-simulator game nostrum
Last synced: 20 days ago
JSON representation
1.0 of DaFarmz bot. Uses Elixir, Nostrum, Postgres, and Node.js. Game assets not included.
- Host: GitHub
- URL: https://github.com/zaneh/dafarmz-bot
- Owner: ZaneH
- License: other
- Created: 2023-08-22T18:28:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-22T18:58:19.000Z (about 1 year ago)
- Last Synced: 2024-10-03T08:31:03.908Z (about 1 month ago)
- Topics: discord-bot, discord-game, elixir, farming, farming-simulator, game, nostrum
- Language: Elixir
- Homepage: https://dafarmz.zaaane.com
- Size: 50.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# DaFarmz Bot
## Run Locally
### Clone the project
```bash
git clone https://github.com/ZaneH/dafarmz-bot.git
cd dafarmz-bot
```
### Setup environment variables
You'll need to create an application in the Discord Developer Portal to
get a token for your bot. You'll also need to enable developer mode in
Discord to get your bot's user ID.
The permissions your bot needs includes:
- Read Messages
- Send Messages
- Manage Messages
- Read Message History
- Add Reactions (unused, but planned)
```
# .env
export DISCORD_USER_ID=
export DISCORD_TOKEN=
```
### Install dependencies
```bash
mix deps.get
```
### Install JS dependencies
```bash
cd js_image/
npm install
cd ..
```
### Create database
```bash
mix ecto.create
```
### Run migrations
Currently there is no seed data. You'll need to populate the database
manually with shop items, lifecycle images, etc.
```bash
mix ecto.migrate
```
### Run the bot
```bash
iex -S mix
```
## License
### In English
You are free to:
- Share — copy and redistribute the material in any medium or format
- The licensor cannot revoke these freedoms as long as you follow the license terms.
Under the following terms:
- Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
- NonCommercial — You may not use the material for commercial purposes.
- NoDerivatives — If you remix, transform, or build upon the material, you may not distribute the modified material.
## Assets
Game assets in the 1.0 version are from [Sprout Lands asset pack by Cup Nooble](https://cupnooble.itch.io/sprout-lands-asset-pack). Due to their license, I will not be redistributing these assets.
If you run this locally, you'll need the following files:
- `js_image/images/layer-1-v2.png` (For the base image, grid + grass)
- `js_image/images/layer-2-v2.png` (For the base image, border decoration)
- `js_image/images/*.png` (For the lifecycle images. These need to be added to the database manually for each `item` row.)