Code Monkey home page Code Monkey logo

modupdatechecker's Introduction

Mod Update Checker

A Python app that periodically checks CurseForge for approved updates of mods, posting an announcement in a Discord server of your choosing with a fully customisable message.

Big thanks to the original author for figuring out the API calls & code for that, I simply moved things around and dockerised everything.

This fork does not use embeds, instead opting for a basic message to allow for tagging with @everyone or @here

Images of this repository are available at https://hub.docker.com/repository/docker/zalosath/asa-mod-update-notifier/general or simply use zalosath/asa-mod-update-notifier in any docker format.

UNRAID installation

To install into your UNRAID system, you can wget the template XML file into /boot/config/plugins/dockerMan/templates-user

cd /boot/config/plugins/dockerMan/templates-user
wget https://raw.githubusercontent.com/jordan-dalby/ModUpdateChecker/main/my-asamodupdatechecker.xml

Then go through the usual container creation process and fill in any required variables.

Other installation options

docker-compose

I recommend that you use docker-compose for its simplicity.
To do so, add your information into .env.template, ensuring you keep the single quotations, then rename the file to .env and run docker-compose up to build, create, and start the container.

Dockerfile

This repo was created to be run on UNRAID, however it's still possible to run this manually with docker run and the following environment variables set:

API_KEY = your curseforge API key  
BOT_TOKEN = your discord bot token  
MOD_IDS = mod id's to track, separated with a comma e.g. 12345678,87654321  
CHANNEL_ID = discord channel ID to send announcements to e.g. 123456789123456  
DEBUG_CHANNEL_ID = discord channel ID to send debug to e.g. 123456789123456  
ANNOUNCE_MESSAGES = should messages sent to the announcement channel be published? True or False  
MESSAGE_TEMPLATE = the message, separated with line breaks \n {mod_name} {version} {changes} \n etc. Leave blank for a default message template.

You can pass the .env file into docker run by adding --env-file=.env

example image

modupdatechecker's People

Contributors

dc-modding avatar postpapa avatar

Stargazers

Jordan Dalby avatar

Watchers

Jordan Dalby avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.