mirror of
https://github.com/HMCore/Orbot.git
synced 2025-12-12 13:56:18 +00:00
Add auto publish feature
This commit is contained in:
53
README.md
53
README.md
@@ -3,17 +3,39 @@ A bot that automatically polls the newest blogpost from [Hytale News Tab](https:
|
||||
## Setup
|
||||
Okay, this isn't really meant for you to setup, if you want it though it first is easier to just dm me on Twitter [@tale_talk](https://twitter.com/tale_talk) so I can add you to the server list.
|
||||
If you *really* want to set it up yourself, fine.
|
||||
1. first go to the release tab, download the jar, and put it in a folder
|
||||
2. Add two files in the root of the repo, an `admin.json` and a `servers.json`.
|
||||
* first go to the release tab, download the jar, and put it in a folder
|
||||
* Add two files in the root of the repo, an `admin.json` and a `servers.json`.
|
||||
Add your Discord ID (not name), Bot token, and update frequency to the `admin.json`:
|
||||
```json
|
||||
{"adminId": 12345678910,"token": "AOGH@(AKnjsfjiJijaig3ijgG92jaij","updateMs":30000}
|
||||
{
|
||||
"adminId": 12345678910,
|
||||
"token": "AOGH@(AKnjsfjiJijaig3ijgG92jaij",
|
||||
"updateMs":30000
|
||||
}
|
||||
```
|
||||
3. add an empty array to your `servers.json`
|
||||
* add your servers to `servers.json`
|
||||
```json
|
||||
[]
|
||||
[
|
||||
{
|
||||
"id": 15050067772322222,
|
||||
"mentionedRole": "everyone",
|
||||
"autoPublish":true
|
||||
},
|
||||
{
|
||||
"id": 74050067772325222,
|
||||
"mentionedRole": null,
|
||||
"autoPublish":false
|
||||
},
|
||||
{
|
||||
"id": 74050067772325222,
|
||||
"mentionedRole": "74036067771625222",
|
||||
"autoPublish":false
|
||||
}
|
||||
]
|
||||
```
|
||||
Not sure, but it might be that multiline JSON doesn't work.
|
||||
* add a `test.json` with the same schema as the `server.json`. When
|
||||
you enable test mode, the servers from there will be used instead allowing
|
||||
you to test if it works.
|
||||
|
||||
## Compiling yourself
|
||||
I developed it under Windows, and had some trouble compiling it on Linux. You mileage may vary.
|
||||
@@ -22,14 +44,22 @@ I developed it under Windows, and had some trouble compiling it on Linux. You mi
|
||||
|
||||
Start the server with `java -jar [server-file-name]` If you put in everything correctly, the bot should message you on Discord.
|
||||
### Adding Servers
|
||||
Please edit the JSON file.
|
||||
You can force an update by calling
|
||||
```
|
||||
%!addChannel [channelID] [roleID/everyone]
|
||||
%!refreshList
|
||||
```
|
||||
Second argument is optional.
|
||||
### Cause a fake update (test if it works)
|
||||
### Testing
|
||||
Switching between test and production files
|
||||
```
|
||||
%!testMode
|
||||
%!fakeUpdate
|
||||
```
|
||||
```
|
||||
%!productionMode
|
||||
```
|
||||
**WARNING**: Initiating a fake update is not being cancelled by switching
|
||||
to production.
|
||||
### Stop the server from within Discord
|
||||
```
|
||||
%!stop
|
||||
@@ -45,3 +75,8 @@ It will also print errors directly in a Discord private message.
|
||||
## TODO
|
||||
|
||||
Mainly reaction roles for convenience, self setup on invite to server, Twitter integration.
|
||||
|
||||
## Other
|
||||
|
||||
Thanks to [Forcellrus](https://github.com/Forcellrus/Discord-Auto-Publisher) for discovering a way to auto publish messages
|
||||
in news channels
|
||||
Reference in New Issue
Block a user