This repository has been archived on 2022-10-02. You can view files and clone it, but cannot push or open issues or pull requests.
dcbot-old/README.md

61 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2021-06-06 17:06:52 +00:00
# tribalwarshelp.com DC Bot
2020-11-06 19:51:03 +00:00
A Discord bot for the online game Tribal Wars.
2020-09-03 13:13:49 +00:00
Features:
1. Coords translation
2020-09-03 13:16:45 +00:00
2020-09-03 13:13:49 +00:00
![Screenshot](/screenshots/coordstranslation.png?raw=true)
2020-09-03 13:16:45 +00:00
2. Live conquer notifications
2020-09-03 13:16:45 +00:00
![Screenshot](/screenshots/notifications2.png?raw=true)
2020-09-03 13:16:45 +00:00
3. List of tribe members ordered by OD/ODA/ODD/ODS/points
4. Translated into 4 languages: Polish, Czech, English, Dutch
2020-09-03 13:13:49 +00:00
[You can check all available commands here.](https://dcbot.tribalwarshelp.com/commands/)
## Development
2021-06-06 17:06:52 +00:00
### Prerequisites
1. Golang
2. PostgreSQL database
3. Configured [API](https://github.com/tribalwarshelp/api)
### Installation
2021-05-06 13:25:09 +00:00
**Required ENV variables:**
```
2020-09-03 13:13:49 +00:00
DB_USER=your_pgdb_user
DB_NAME=your_pgdb_name
DB_PORT=your_pgdb_port
DB_HOST=your_pgdb_host
DB_PASSWORD=your_pgdb_password
API_URL=your_api_url
BOT_TOKEN=your_bot_token
2021-06-06 17:06:52 +00:00
LOG_DB_QUERIES=true
```
2021-06-06 17:06:52 +00:00
1. Clone this repo.
```
git clone git@github.com:tribalwarshelp/dcbot.git
```
2021-06-19 15:02:54 +00:00
2. Open the folder with this project in a terminal.
2021-06-06 17:06:52 +00:00
3. Set the required env variables directly in your system or create .env.local file.
4. Run the app.
```
go run main.go
```
2021-06-06 17:06:52 +00:00
## License
2021-06-06 17:06:52 +00:00
Distributed under the MIT License. See ``LICENSE`` for more information.
2021-06-06 17:06:52 +00:00
## Contact
Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)