ijo42/curseforge2discord

By ijo42

•Updated about 5 years ago

Image

2.1K

Overview Tags

ijo42/curseforge2discord repository overview

⁠CurseForge2Discord

⁠Difference from ErdbeerbaerLP/Curseforge-Bot⁠

Fork based on Minnced WebHook Discord API instead JDA. Personal thanks to Griefed⁠ for a bunch of useful content

feats:

This does not require the creation of bot account.
A more lightweight library
Not use GitHub conf storing
A lit bit of Improvements
Maintability
Support⁠
Built-in S6 Overlay

The lsiobase/alpine⁠ image is a custom base image built with Alpine linux⁠ and S6 overlay⁠. Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier

⁠Image-Variants

Tags	Description
`latest`	Using the `latest` tag will pull the latest release image for amd64/x86_64 architecture.
`master`	Using the `master` tag will pull latest master-branch image for amd64/x86_64 architecture.
`dev`	Using the `dev` tag will pull latest dev image for amd64/x86_64 architecture.
`sha-([a-z0-9]{7})`	Using this tag will push image based on relevant git-commit `(sha-fbc170f)`
`#.#.#`	Using this tag will push relevant Release `(2.0.1)`

⁠Pre-built Images

using docker-compose:

version: "2"
services:
  cf2d:
    image: ijo42/curseforge2discord:latest
    container_name: cf2d
    restart: unless-stopped
    environment:
      - TZ=Europe/Berlin # Timezone
      - ROLE_ID=000000000 # (Optional) The ID of the discord role mentioned when the bot makes a post
      - PUID=1000 # User ID
      - PROJECT_ID=435552 # The ID of your Curseforge project
      - PGID=1000 # Group ID
      - FOOTER_URL=https://avatars.githubusercontent.com/u/53531892 # Footer Image
      - FILE_LINK=CURSE # DIRECT-link to file or CURSE-link on project page or NO_LINK.
      - DISCORD_CHANNEL_ID=000000000 # The ID of the channel you want the bot to post in
      - WEBHOOK_TOKEN=InsertHere # Your discord-server webhook
      - DESCRIPTION=New File(s) Detected For CurseForge Project(s) # This sets the text that appears as the message description in the update notification
      - CHANGELOG_FORMAT=md # yml or md or css. Only choose one syntax. Can be very usefull if project owner/author uses discord MarkDown formatting in their changelog.
    volumes:
      - ./host/path/to/config:/config # Where the bot-conf will be stored

using CLI:

docker create \
  --name=cf2d \
  -e TZ=Europe/Berlin `# Timezone` \
  -e ROLE_ID=000000000 `# (Optional) The ID of the discord role mentioned when the bot makes a post` \
  -e PUID=1000 `# User ID` \
  -e PROJECT_ID=435552 `# The ID of your Curseforge project` \
  -e PGID=1000 `# Group ID` \
  -e FILE_LINK=curse `# DIRECT-link to file or CURSE-link on project page or NO_LINK.` \
  -e DISCORD_CHANNEL_ID=000000000 `# The ID of the channel you want the bot to post in` \
  -e FOOTER_URL=https://avatars.githubusercontent.com/u/53531892 `Footer Image` \
  -e WEBHOOK_TOKEN=InsertHere `# Your discord-server webhook` \
  -e DESCRIPTION=New File(s) Detected For CurseForge Project(s) `# This sets the text that appears as the message description in the update notification` \
  -e CHANGELOG_FORMAT=md `# yml or md or css. Only choose one syntax. Can be very usefull if project owner/author uses discord MarkDown formatting in their changelog.` \
  -v ./host/path/to/config:/config `# Where the bot-conf will be stored` \
  --restart unless-stopped \
  ijo42/curseforge2discord:latest

⁠Build yourself

⁠Image

Use the Dockerfile⁠ to build the image yourself, in case you want to make any changes to it

docker-compose.yml:

version: '2'
services:
  cf2d:
    container_name: cf2d
    build: ./cf2d
    restart: unless-stopped
    volumes:
      - ./path/to/config:/config
    environment:
      - TZ=Europe/Berlin # Timezone
      - ROLE_ID=000000000
      - PUID=1000 # User ID
      - FOOTER_URL=
      - PROJECT_ID=
      - PGID=1000 # Group ID
      - FILE_LINK=
      - DISCORD_CHANNEL_ID=
      - WEBHOOK_TOKEN=
      - DESCRIPTION=
      - CHANGELOG_FORMAT=

Clone the repository: git clone https://github.com/ijo42/CurseForge2Discord.git ./cf2d
Prepare docker-compose.yml file as seen above
docker-compose up -d --build cf2d
???
Profit!

⁠Setup by GitHub Release's

Install JDK 15
Download latest binary⁠
(Optional) Redefine config path:

By argument -path /opt/curseforge2discord
By ENV VAR CONFIG_PATH=/opt/curseforge2discord

Start: java -jar CurseForge2Discord.jar

⁠Building and Setup. Gradlew

Install JDK 15, git
Clone repo: git clone https://github.com/ijo42/CurseForge2Discord.git .
Build: gradlew build
(Optional) Redefine config path:

By argument -path /opt/curseforge2discord
By ENV VAR CONFIG_PATH=/opt/curseforge2discord

Start: java -jar build/libs/CurseForge2Discord.jar

⁠Adding more projects to track

If you have multiple projects in CurseForge which you want to track with this bot, you need to manually edit the bot.conf file which is created after container creation. Here's an example for multiple project IDs and how it's formatted:

ids = [
    "430517;;DISCORD_CHANNEL_ID;;WEBHOOK_TOKEN",
    "239197;;DISCORD_CHANNEL_ID;;WEBHOOK_TOKEN",
    "243121;;DISCORD_CHANNEL_ID;;WEBHOOK_TOKEN"
]

⁠User / Group Identifiers

When using volumes, permissions issues can arise between the host OS and the container. Linuxserver.io⁠ avoids this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

⁠Configuration

Configuration	Explanation
Restart policy⁠	"no", always, on-failure, unless-stopped
config volume	Contains config files and logs.
data volume	Contains your/the containers important data.
TZ	Timezone
PUID	for UserID
PGID	for GroupID
FOOTER_URL	URL to image in Footer of announce
DISCORD_CHANNEL_ID	The ID of the channel you want the bot to post in (from webhook)
PROJECT_ID	The ID of your CurseForge project
ROLE_ID	(Optional) The ID of the discord role mentioned when the bot makes a post
FILE_LINK	`DIRECT`-link to file or `CURSE`-link on project page or `NO_LINK`.
DESCRIPTION	This sets the text that appears as the message description in the update notification
CHANGELOG_FORMAT	`yml` or `md` or `css`. Only choose one syntax. Can be very useful if project owner/author uses discord Markdown formatting in their changelog.
WEBHOOK_TOKEN	Your discord-server webhook token

⁠License

Inherited from origin license⁠.

Tag summary

Recent tags

Content type

Image

Digest

Size

27.7 MB

Last updated

over 5 years ago

docker pull ijo42/curseforge2discord