Gittes-archive/ow-mod-db
2
0
Fork 0
mirror of https://github.com/ow-mods/ow-mod-db.git synced 2025-12-11 20:15:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add secrets info to the readme

Browse Source
This commit is contained in:
Ricardo 2022-03-27 13:56:31 +02:00
parent b7ae730faa
commit b262ef9e24
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -5,3 +5,38 @@ Uses the mod list in [`mods.json` of the `source`](https://github.com/Raicuparta
## [Click here to add your mod to the database](https://github.com/Raicuparta/ow-mod-db/issues/new?assignees=Raicuparta&labels=add-mod&template=add-mod.yml&title=%5BYour+mod+name+here%5D)
Or, if you want, you can [edit the mod list yourself and open a PR](https://github.com/Raicuparta/outer-wilds-mod-db/edit/source/mods.json)
## How it works
GitHub Actions are used to periodically update the database. Check the [Update Releases workflow](https://github.com/Raicuparta/ow-mod-db/blob/source/.github/workflows/update-releases.yml) and the [TypeScript code](https://github.com/Raicuparta/ow-mod-db/tree/source/fetch-mods) that fetches the data about each mod and generates the database.
## Repository secrets
If you fork this repository, you'll need to add a few secrets for everything to work.
### `GH_TOKEN`
GitHub token with repo permissions. Format:
```
ghp_XXX
```
### `DISCORD_HOOK_URL`
Discord web hook URL where all the notifications are sent. Format:
```
https://discord.com/api/webhooks/XXX/YYY
```
### `DISCORD_MOD_HOOK_URLS`
JSON object where keys are the uniqueName of a mod, and the values are the Discord hook urls of the channel where update notifications should be sent to. Format:
```
{
"uniqueNameA": "https://discord.com/api/webhooks/XXX/YYY",
"uniqueNameB": "https://discord.com/api/webhooks/WWW/ZZZ"
}
```