fl-darkbot

README

Darkbot

Getting started for users

• Getting started and documentation how to use it

other links

• Discovery Forum Thread and anouncements
• Github of the project
• See other Dark Tools for Freelancer here

Project Description for devs

• This project is a discord bot Darkbot3 for open source game community Freelancer Discovery
• It implements Discord bot to track player bases, players themselves and forum posting with notifications to Discord.
• The logic of it: User connects darkbot to some discord channel, and sets settings which space bases, player tags or space systems to track. Darkbot repeatedly updates information to discord channel
• project saves ready for deployment docker images at docker hub, see settings here, which are invoking this configuration

Getting started with development:

• create your own Discord app link and invite it to some Discord server

• If you are me, then just use your dev env inviting link you already created:

  • https://discord.com/api/oauth2/authorize?client_id=1071516990348460033&permissions=8&scope=bot

• Ensure you have set necessary Environment variables in your own enverant.json file or as real environment variables

  • App specific configurations can be found here.

• Install golang of version no less than it is mention in test.yml file

• Launch app as go run . run (see go run . --help for other available commands)

• Visit your Discord server again where bot is connected. Select empty channel and write ; connect

  • By default Console prefix to use command is ;. Seee ; --help for other commands.
  • Try smth list ; base tags list

• Optionally install Taskfile

  • and run dev commands like task test for running unit tests
  • or see them inside Taskfile for manual copy pasting to shell
  • task --list-all to list available commands

• If you update any dependencies, make sure to rerun go mod vendor to sync their vendoring

If you wish making changes to mkdocs:

• We use static site generator via mkdocs to document stuff for end users
• install preferably Taskfile or peak commands in it for manual copy pasting
• Install python3 of version no less than it is mention in CI file
• run task mkdocs:dev to open web server with documentation at http://127.0.0.1:8000/ , then change files in /docs folder

Note for deployment

• The project depends on having two private URL from Discovery API for its running. Provided by Alex.
  • Development is possible without them as with env var you can mock data receved from them.
  • by default DEV_ENV_MOCK_API=true for convinience of easier getting started

Architecture

The project has 5 package parts parts:

• scrappy scraps third party REST APIs and web forum for data. Stores in in storage (memory) to other modules
• configurator is interacting with SQL database to store user settings
• listener is Discord API connected application, that accepts user commands from channel and sends to consoler, and gives from it answer
• consoler is a CLI interface to accept input from listener and render its CLI answer back
• viewer is application that in a loop gets user settings and connected channels, and rerenders to them view based on available data in scrappy and configurator settings

Dev standards

• Code architecture should be unit testable, even if tests will not be covering everything (Intercepting input from Discord to Cobra CLI and rendering output from it to Discord was made to minimize Discord code footprint to minimum for this reason)
  • Integration (kind of unit testing) is available for majority of code logic by just triggering Cobra CLI commands.
• following different OOP principles, like having minimum exposed interfaces to rest of a code
• following semantic versioning and generating changelogs with the help of autogit
• Keep amount of dependencies low for easier long term maintanance. (TODO Recheck which dependencies u can delete later)
  • To simplify long term maintanance, dependencies will be vendored in.

Tech stack

• golang
• discordgo
• cobra-cli
• gorm (sqlite3)
• docker
• terraform (hetzner / docker cli ami image)
• terraform docker provider

Project status

• Finished its core development of features
• In long term maintenance mode

Acknowledgements

• Freelancer Discovery API provided by Alex as a way to deliver info from Flhook to the bot
• Pobbot originally made by dr.lameos sparkled this project
• Forum tracking is inspired by Biqqles project forumlancer

License

fl-darkbot was originally created by Andrei Novoselov (aka darkwind, aka dd84ai) The work is released under AGPL, free to modify, copy and etc. as long as you keep code open source and mentioned original author. See LICENSE file for details.

Documentation

Overview

Copyright © 2022 NAME HERE <EMAIL ADDRESS>